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

159
160
161
162
163
164
165
166
167
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,
)
168

169
if TYPE_CHECKING:
170
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
171
    from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
172
173
174

logger = init_logger(__name__)

175
176
AttnMetadataDict: TypeAlias = dict[str, AttentionMetadata]
# list when ubatching is enabled
177
PerLayerAttnMetadata: TypeAlias = list[AttnMetadataDict] | AttnMetadataDict
178

179

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

        # 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
200
        self.vocab_size = vocab_size
201
        self._logprobs_tensors = logprobs_tensors
202
203
204
205
206

        # 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)
207
            self.sampled_token_ids_cpu = self._sampled_token_ids.to(
208
209
                "cpu", non_blocking=True
            )
210
211
212
213
214
            self._logprobs_tensors_cpu = (
                self._logprobs_tensors.to_cpu_nonblocking()
                if self._logprobs_tensors
                else None
            )
215
            self.async_copy_ready_event.record()
216
217
218

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

220
221
        This function blocks until the copy is finished.
        """
222
        self.async_copy_ready_event.synchronize()
223

224
225
        # Release the device tensors once the copy has completed.
        del self._logprobs_tensors
226
        del self._sampled_token_ids
227
228
        max_gen_len = self.sampled_token_ids_cpu.shape[-1]
        if max_gen_len == 1:
229
            valid_sampled_token_ids = self.sampled_token_ids_cpu.tolist()
230
231
232
233
234
        else:
            valid_sampled_token_ids = RejectionSampler.parse_output(
                self.sampled_token_ids_cpu,
                self.vocab_size,
            )
235
        for i in self._invalid_req_indices:
236
            valid_sampled_token_ids[i].clear()
237
238
239

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
240
241
242
243
        if self._logprobs_tensors_cpu:
            # NOTE(nick): this will need to be updated to use cu_num_accepted_tokens
            # for async sched + spec decode + logprobs compatibility.
            output.logprobs = self._logprobs_tensors_cpu.tolists()
244
245
246
        return output


247
248
249
250
251
252
253
254
255
256
257
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
258
    ec_connector_output: ECConnectorOutput | None
259
260


261
262
263
class GPUModelRunner(
    LoRAModelRunnerMixin, KVConnectorModelRunnerMixin, ECConnectorModelRunnerMixin
):
264
265
    def __init__(
        self,
266
        vllm_config: VllmConfig,
267
        device: torch.device,
268
    ):
269
270
271
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
272
        self.compilation_config = vllm_config.compilation_config
273
274
275
276
277
278
        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
279

280
        from vllm.model_executor.models.utils import set_cpu_offload_max_bytes
281
282

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

284
285
286
287
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
288
        self.device = device
289
290
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
291
292
293
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
294

295
        self.is_pooling_model = model_config.runner_type == "pooling"
296
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
297
        self.is_multimodal_raw_input_only_model = (
298
299
            model_config.is_multimodal_raw_input_only_model
        )
300
301
        # This will be overridden in load_model()
        self.is_multimodal_pruning_enabled = False
302
        self.max_model_len = model_config.max_model_len
303
304
305

        # Always set to false after the first forward pass
        self.calculate_kv_scales = self.cache_config.calculate_kv_scales
306
        self.dcp_world_size = self.parallel_config.decode_context_parallel_size
307
        self.dcp_rank = 0 if self.dcp_world_size <= 1 else get_dcp_group().rank_in_group
308
        self.max_num_tokens = scheduler_config.max_num_batched_tokens
309
        self.max_num_reqs = scheduler_config.max_num_seqs
310

311
312
313
314
315
        # 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 = (
316
317
318
            self.parallel_config.distributed_executor_backend == "external_launcher"
            and len(get_pp_group().ranks) > 0
        )
319

320
        # Model-related.
321
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
322
        self.hidden_size = model_config.get_hidden_size()
323
        self.attention_chunk_size = model_config.attention_chunk_size
324
        # Only relevant for models using ALiBi (e.g, MPT)
325
        self.use_alibi = model_config.uses_alibi
326

327
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
328

329
        # Multi-modal data support
330
        self.mm_registry = MULTIMODAL_REGISTRY
331
        self.uses_mrope = model_config.uses_mrope
332
        self.uses_xdrope_dim = model_config.uses_xdrope_dim
333
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
334
335
            model_config
        )
336

337
338
339
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
340
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
341
342
343
        else:
            self.max_encoder_len = 0

344
        # Sampler
345
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
346

347
        self.eplb_state: EplbState | None = None
348
349
350
351
352
353
        """
        State of the expert parallelism load balancer.

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

354
        # Lazy initializations
355
        # self.model: nn.Module  # Set after load_model
356
        # Initialize in initialize_kv_cache
357
        self.kv_caches: list[torch.Tensor] = []
358
359
360
        # Initialize in initialize_kv_cache_tensors
        self.cross_layers_kv_cache: torch.Tensor | None = None
        self.cross_layers_attn_backend: type[AttentionBackend] | None = None
361
362
        # indexes: [kv_cache_group_id][attn_group]
        self.attn_groups: list[list[AttentionGroup]] = []
363
364
        # self.kv_cache_config: KVCacheConfig

365
366
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
367

368
        self.use_aux_hidden_state_outputs = False
369
370
371
372
373
        # 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:
374
375
376
            self.drafter: (
                NgramProposer | SuffixDecodingProposer | EagleProposer | MedusaProposer
            )
377
378
            if self.speculative_config.method == "ngram":
                self.drafter = NgramProposer(self.vllm_config)
379
380
            elif self.speculative_config.method == "suffix":
                self.drafter = SuffixDecodingProposer(self.vllm_config)
381
            elif self.speculative_config.use_eagle():
382
                self.drafter = EagleProposer(self.vllm_config, self.device, self)
383
                if self.speculative_config.method == "eagle3":
384
385
386
                    self.use_aux_hidden_state_outputs = (
                        self.drafter.eagle3_use_aux_hidden_state
                    )
387
388
            elif self.speculative_config.method == "medusa":
                self.drafter = MedusaProposer(
389
                    vllm_config=self.vllm_config, device=self.device
390
                )
391
            else:
392
393
394
395
                raise ValueError(
                    "Unknown speculative decoding method: "
                    f"{self.speculative_config.method}"
                )
396
            self.rejection_sampler = RejectionSampler(self.sampler)
397

398
399
400
401
        self.num_spec_tokens = 0
        if self.speculative_config:
            self.num_spec_tokens = self.speculative_config.num_speculative_tokens

402
        # Request states.
403
        self.requests: dict[str, CachedRequestState] = {}
404
405
406
        # NOTE(rob): num_prompt_logprobs only includes reqs
        # that are currently in the prefill phase.
        self.num_prompt_logprobs: dict[str, int] = {}
407
        self.comm_stream = torch.cuda.Stream()
408

409
410
411
412
413
414
415
416
417
        # 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.
418
419
420
421
        logits_processors = model_config.logits_processors
        custom_logitsprocs: Sequence[str | type[LogitsProcessor]] = (
            tuple(logits_processors) if logits_processors is not None else ()
        )
422
423
        self.input_batch = InputBatch(
            max_num_reqs=self.max_num_reqs,
424
425
426
            # 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),
427
428
429
            max_num_batched_tokens=self.max_num_tokens,
            device=self.device,
            pin_memory=self.pin_memory,
430
            vocab_size=self.model_config.get_vocab_size(),
431
            block_sizes=[self.cache_config.block_size],
432
            kernel_block_sizes=[self.cache_config.block_size],
433
            is_spec_decode=bool(self.vllm_config.speculative_config),
434
            logitsprocs=build_logitsprocs(
435
436
437
                self.vllm_config,
                self.device,
                self.pin_memory,
438
                self.is_pooling_model,
439
                custom_logitsprocs,
440
            ),
441
442
443
            # 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),
444
            is_pooling_model=self.is_pooling_model,
445
            cp_kv_cache_interleave_size=self.parallel_config.cp_kv_cache_interleave_size,
446
        )
447

448
        self.use_async_scheduling = self.scheduler_config.async_scheduling
449
450
451
452
453
        # 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.
454
        self.prepare_inputs_event: torch.Event | None = None
455
456
        if self.use_async_scheduling:
            self.async_output_copy_stream = torch.cuda.Stream()
457
            self.prepare_inputs_event = torch.Event()
458

459
        # self.cudagraph_batch_sizes sorts in ascending order.
460
461
462
463
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
464
465
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
466
            )
467

468
        # Cache the device properties.
469
        self._init_device_properties()
470

471
        # Persistent buffers for CUDA graphs.
472
473
474
475
476
        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
        )
477
        self.seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
478
479
480
481
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
482
483
484
        # 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.
485
486
487
488
489
490
491
        self.inputs_embeds = self._make_buffer(
            self.max_num_tokens, self.hidden_size, dtype=self.dtype, numpy=False
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
        self.discard_request_indices = self._make_buffer(
            self.max_num_reqs, dtype=torch.int64
        )
492
493
        self.num_discarded_requests = 0

494
495
496
497
498
499
        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
        )
500

501
502
        # Only relevant for multimodal models
        if self.supports_mm_inputs:
503
            self.is_mm_embed = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
504

505
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
506
        if self.uses_mrope:
Roger Wang's avatar
Roger Wang committed
507
508
509
510
            # 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
511
512
513
514
515
516

            # 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
517
            self.mrope_positions = self._make_buffer(
518
519
                (3, self.max_num_tokens + 1), dtype=torch.int64
            )
520

521
522
523
524
525
526
527
        # 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
            )

528
        # None in the first PP rank. The rest are set after load_model.
529
        self.intermediate_tensors: IntermediateTensors | None = None
530

531
        # OPTIMIZATION: Cache the tensors rather than creating them every step.
532
        # Keep in int64 to avoid overflow with long context
533
534
535
536
        self.arange_np = np.arange(
            max(self.max_num_reqs + 1, self.max_model_len, self.max_num_tokens),
            dtype=np.int64,
        )
537

538
539
540
541
542
        # 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] = {}
543
544
545
546
547
        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(
548
549
                self.max_num_tokens, dtype=torch.int32, device=self.device
            )
550

551
        self.uniform_decode_query_len = 1 + self.num_spec_tokens
552
553
554
555

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

556
557
558
559
560
561
562
563
564
        self.mm_budget = (
            MultiModalBudget(
                self.model_config,
                self.scheduler_config,
                self.mm_registry,
            )
            if self.supports_mm_inputs
            else None
        )
565

566
        self.reorder_batch_threshold: int | None = None
567

568
569
570
571
572
        # 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()

573
        # Cached outputs.
574
        self._draft_token_ids: list[list[int]] | torch.Tensor | None = None
575
        self.transfer_event = torch.Event()
576
        self.sampled_token_ids_pinned_cpu = torch.empty(
577
            (self.max_num_reqs, 1),
578
579
            dtype=torch.int64,
            device="cpu",
580
581
            pin_memory=self.pin_memory,
        )
582

583
584
        # Pre-allocated tensor for copying valid sampled token counts to CPU,
        # with dedicated stream for overlapping and event for coordination.
585
        self.valid_sampled_token_count_event: torch.Event | None = None
586
587
        self.valid_sampled_token_count_copy_stream: torch.cuda.Stream | None = None
        if self.use_async_scheduling and self.num_spec_tokens:
588
            self.valid_sampled_token_count_event = torch.Event()
589
590
591
592
593
594
595
596
            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,
        )

597
598
        # Ephemeral state transferred between execute_model() and sample_tokens().
        self.execute_model_state: ExecuteModelState | None = None
599
        self.kv_connector_output: KVConnectorOutput | None = None
600

601
602
603
604
    def reset_mm_cache(self) -> None:
        if self.mm_budget:
            self.mm_budget.reset_cache()

605
606
607
608
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
609
610
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, :num_tokens]
611
612
613
614
            return self.positions.gpu[:num_tokens]
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
615
616
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, num_tokens]
617
618
            return self.positions.gpu[num_tokens]

619
    def _make_buffer(
620
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
621
622
623
624
625
626
627
628
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
629

630
631
632
    def _init_model_kwargs(self, num_tokens: int):
        model_kwargs = dict[str, Any]()

633
        if not self.is_pooling_model:
634
635
            return model_kwargs

636
637
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
638
639
640

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
641
642
643
644
645
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
646
647
648
649
650
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

651
        seq_lens = self.seq_lens.gpu[:num_reqs]
652
653
654
655
656
657
658
659
        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(
660
661
            device=self.device
        )
662
663
        return model_kwargs

664
    def _may_reorder_batch(self, scheduler_output: "SchedulerOutput") -> None:
665
666
        """
        Update the order of requests in the batch based on the attention
667
        backend's needs. For example, some attention backends (namely MLA) may
668
669
670
671
672
673
        want to separate requests based on if the attention computation will be
        compute-bound or memory-bound.

        Args:
            scheduler_output: The scheduler output.
        """
674
675
676
677
678
679
680
681
        # 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

682
683
684
685
        if self.reorder_batch_threshold is not None:
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
686
687
                decode_threshold=self.reorder_batch_threshold,
            )
688

689
690
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
691
        """Initialize attributes from torch.cuda.get_device_properties"""
692
693
694
695
696
697
698
        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()

699
    def _update_states(self, scheduler_output: "SchedulerOutput") -> None:
700
701
702
703
704
705
        """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.

706
707
        The SamplingMetadata is updated and copied to the GPU if there is a
        new/resumed/paused/finished request in the batch.
708
709
        """
        # Remove finished requests from the cached states.
710
711
        for req_id in scheduler_output.finished_req_ids:
            self.requests.pop(req_id, None)
712
            self.num_prompt_logprobs.pop(req_id, None)
713
714
715
716
717
718
719
        # 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:
720
            self.input_batch.remove_request(req_id)
721
722

        # Free the cached encoder outputs.
723
724
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
725

726
727
728
729
730
731
732
733
734
735
736
737
738
        # 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()
        unscheduled_req_ids = cached_req_ids - scheduled_req_ids
        # 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:
739
            self.input_batch.remove_request(req_id)
740

741
        reqs_to_add: list[CachedRequestState] = []
742
        # Add new requests to the cached states.
743
744
745
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
            sampling_params = new_req_data.sampling_params
746
            pooling_params = new_req_data.pooling_params
747

748
749
750
751
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
752
753
754
755
756
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

757
758
            if self.is_pooling_model:
                assert pooling_params is not None
759
760
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
761

762
                model = cast(VllmModelForPooling, self.get_model())
763
                to_update = model.pooler.get_pooling_updates(task)
764
765
                to_update.apply(pooling_params)

766
            req_state = CachedRequestState(
767
                req_id=req_id,
768
                prompt_token_ids=new_req_data.prompt_token_ids,
769
                prompt_embeds=new_req_data.prompt_embeds,
770
                mm_features=new_req_data.mm_features,
771
                sampling_params=sampling_params,
772
                pooling_params=pooling_params,
773
                generator=generator,
774
775
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
776
                output_token_ids=[],
777
                lora_request=new_req_data.lora_request,
778
            )
779
780
            self.requests[req_id] = req_state

781
782
783
784
785
786
787
            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
                )

788
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
789
            if self.uses_mrope:
790
                self._init_mrope_positions(req_state)
791

792
793
794
795
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            if self.uses_xdrope_dim > 0:
                self._init_xdrope_positions(req_state)

796
            reqs_to_add.append(req_state)
797

798
        # Update the states of the running/resumed requests.
799
        is_last_rank = get_pp_group().is_last_rank
800
        req_data = scheduler_output.scheduled_cached_reqs
801
802
803
804
805

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

806
        for i, req_id in enumerate(req_data.req_ids):
807
            req_state = self.requests[req_id]
808
809
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
810
            resumed_from_preemption = req_id in req_data.resumed_req_ids
811
            num_output_tokens = req_data.num_output_tokens[i]
812
            req_index = self.input_batch.req_id_to_index.get(req_id)
813

814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
            # 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)
837

838
            # Update the cached states.
839
            req_state.num_computed_tokens = num_computed_tokens
840
841
842
843
844
845
846
847

            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.
848
849
850
                num_new_tokens = (
                    num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                )
851
852
853
854
                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:
855
                    req_state.output_token_ids.extend(new_token_ids[-num_new_tokens:])
856
857
858
859
860
            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:
861
862
863
864
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
865
866
                    self.input_batch.num_tokens[req_index] = end_idx
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
867

868
            # Update the block IDs.
869
            if not resumed_from_preemption:
870
871
                if new_block_ids is not None:
                    # Append the new blocks to the existing block IDs.
872
                    for block_ids, new_ids in zip(req_state.block_ids, new_block_ids):
873
                        block_ids.extend(new_ids)
874
            else:
875
                assert req_index is None
876
                assert new_block_ids is not None
877
878
                # The request is resumed from preemption.
                # Replace the existing block IDs with the new ones.
879
                req_state.block_ids = new_block_ids
880
881
882
883
884

            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.
885
886
887
888
889
890
891

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

892
                reqs_to_add.append(req_state)
893
894
895
                continue

            # Update the persistent batch.
896
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
897
            if new_block_ids is not None:
898
                self.input_batch.block_table.append_row(new_block_ids, req_index)
899
900
901
902
903
904
905

            # 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)
906
                self.input_batch.token_ids_cpu[
907
908
909
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
910
                self.input_batch.num_tokens[req_index] = end_token_index
911

912
            # Add spec_token_ids to token_ids_cpu.
913
            spec_token_ids = scheduler_output.scheduled_spec_decode_tokens.get(
914
                req_id, []
915
            )
916
917
918
919
920
            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:
921
922
923
                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[
924
925
                    req_index, start_index:end_token_index
                ] = spec_token_ids
926
927
                # NOTE(woosuk): `num_tokens` here may include spec tokens.
                self.input_batch.num_tokens[req_index] += num_spec_tokens
928
929
930
931
932
933

            # 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.
934
935
            self.input_batch.spec_token_ids[req_index].clear()
            self.input_batch.spec_token_ids[req_index].extend(spec_token_ids)
936

937
938
939
940
941
942
943
944
945
            # 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)
946
947
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
948
949
        for request in reqs_to_add:
            self.input_batch.add_request(request)
950

951
952
953
954
955
956
        # 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()
957

958
    def _update_states_after_model_execute(
959
960
        self, output_token_ids: torch.Tensor
    ) -> None:
961
962
963
964
965
966
967
968
969
970
971
972
        """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.
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
        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()
        )
993
994
995
        for i, num_tokens in enumerate(num_accepted_tokens):
            self.input_batch.num_accepted_tokens_cpu[i] = num_tokens

996
    def _init_mrope_positions(self, req_state: CachedRequestState):
997
998
        model = self.get_model()
        assert supports_mrope(model), "M-RoPE support is not implemented."
999
1000
1001
1002
        assert req_state.prompt_token_ids is not None, (
            "M-RoPE requires prompt_token_ids to be available."
        )
        mrope_model = cast(SupportsMRoPE, model)
1003
1004

        req_state.mrope_positions, req_state.mrope_position_delta = (
1005
            mrope_model.get_mrope_input_positions(
1006
                req_state.prompt_token_ids,
1007
                req_state.mm_features,
1008
            )
1009
        )
1010

1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
    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,
        )

1024
    def _extract_mm_kwargs(
1025
        self,
1026
1027
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
1028
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
1029
            return {}
1030

1031
1032
        mm_kwargs = list[MultiModalKwargsItem]()
        for req in scheduler_output.scheduled_new_reqs:
1033
1034
1035
            for feature in req.mm_features:
                if feature.data is not None:
                    mm_kwargs.append(feature.data)
1036

1037
        # Input all modalities at once
1038
        model = cast(SupportsMultiModal, self.model)
1039
1040
        mm_kwargs_combined: BatchedTensorInputs = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
1041
1042
1043
1044
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
1045
            multimodal_cpu_fields=model.multimodal_cpu_fields,
1046
1047
        ):
            mm_kwargs_combined.update(mm_kwargs_group)
1048

1049
        return mm_kwargs_combined
1050

1051
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
1052
        if not self.is_multimodal_raw_input_only_model:
1053
            return {}
1054

1055
1056
1057
1058
1059
        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)
1060

1061
1062
1063
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
1064
        cumsum_dtype: np.dtype | None = None,
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
    ) -> 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

1081
    def _prepare_input_ids(
1082
1083
1084
1085
        self,
        scheduler_output: "SchedulerOutput",
        total_num_scheduled_tokens: int,
        cu_num_tokens: np.ndarray,
1086
    ) -> None:
1087
        """Prepare the input IDs for the current batch.
1088

1089
1090
1091
1092
1093
1094
1095
        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)
1096
1097
1098
            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)
1099
1100
1101
1102
1103
1104
1105
            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
1106
1107
1108
1109
        sample_flattened_indices: list[int] = []
        spec_flattened_indices: list[int] = []
        prev_common_req_indices: list[int] = []
        prev_draft_token_indices: list[int] = []
1110
1111
        indices_match = True
        max_flattened_index = -1
1112
1113
1114
        total_num_spec_tokens = 0
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens

1115
1116
1117
1118
1119
        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.
1120
1121
                draft_len = len(scheduled_spec_tokens.get(req_id, ()))
                total_num_spec_tokens += draft_len
1122
                flattened_index = cu_num_tokens[cur_index].item() - 1
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
                # 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))
1138
                indices_match &= prev_index == flattened_index
1139
                max_flattened_index = max(max_flattened_index, flattened_index)
1140
1141
1142
        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:
1143
1144
1145
            # 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)
1146
1147
1148
            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)
1149
1150
        if num_commmon_tokens == 0:
            # No requests in common with the previous iteration
1151
            # So input_ids.cpu will have all the input ids.
1152
1153
1154
1155
1156
1157
1158
            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_(
1159
1160
1161
                self.input_batch.prev_sampled_token_ids[:num_commmon_tokens, 0],
                non_blocking=True,
            )
1162
1163
            if self.enable_prompt_embeds:
                self.is_token_ids.gpu[:num_commmon_tokens] = True
1164
            return
1165
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1166
1167
        sampled_tokens_index_tensor = torch.tensor(
            sample_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
1168
        ).to(self.device, non_blocking=True)
1169
        prev_common_req_indices_tensor = torch.tensor(
1170
1171
            prev_common_req_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1172
1173
        self.input_ids.gpu.scatter_(
            dim=0,
1174
            index=sampled_tokens_index_tensor,
1175
            src=self.input_batch.prev_sampled_token_ids[
1176
1177
1178
                prev_common_req_indices_tensor, 0
            ],
        )
1179

1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
        # 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],
        )

1203
1204
    def _get_encoder_seq_lens(
        self,
1205
        scheduled_encoder_inputs: dict[str, list[int]],
1206
1207
        kv_cache_spec: KVCacheSpec,
        num_reqs: int,
1208
    ) -> np.ndarray | None:
1209
1210
1211
1212
1213
1214
        if not isinstance(kv_cache_spec, CrossAttentionSpec):
            return None

        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
        encoder_seq_lens = np.zeros(num_reqs, dtype=np.int32)
1215
        for req_id in scheduled_encoder_inputs:
1216
1217
1218
1219
1220
            req_index = self.input_batch.req_id_to_index[req_id]
            encoder_seq_lens[req_index] = self.max_encoder_len

        return encoder_seq_lens

1221
    def _prepare_inputs(
1222
1223
1224
1225
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
        max_num_scheduled_tokens: int,
1226
1227
    ) -> tuple[
        torch.Tensor,
1228
1229
1230
        SpecDecodeMetadata | None,
        UBatchSlices | None,
        torch.Tensor | None,
1231
    ]:
1232
1233
        """
        :return: tuple[
1234
            logits_indices, spec_decode_metadata,
1235
            ubatch_slices, num_tokens_across_dp,
1236
1237
        ]
        """
1238
1239
1240
1241
1242
1243
1244
        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.
1245
        self.input_batch.block_table.commit_block_table(num_reqs)
1246
1247
1248

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

1251
1252
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1253
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1254
1255

        # Get positions.
1256
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1257
1258
1259
1260
1261
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1262

1263
1264
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1265
        if self.uses_mrope:
1266
1267
            self._calc_mrope_positions(scheduler_output)

1268
1269
1270
1271
1272
        # 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)

1273
1274
1275
1276
        # 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.
1277
1278
1279
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1280
        token_indices_tensor = torch.from_numpy(token_indices)
1281

1282
1283
1284
        # 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.
1285
1286
1287
1288
1289
1290
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1291
        if self.enable_prompt_embeds:
1292
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1293
1294
1295
1296
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1297
1298
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331

        # 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:
1332
1333
1334
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1335
1336

                output_idx += num_sched
1337

1338
1339
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1340
1341

        # Prepare the attention metadata.
1342
        self.query_start_loc.np[0] = 0
1343
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1344
1345
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1346
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1347
        self.query_start_loc.copy_to_gpu()
1348
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1349

1350
        num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
1351
        num_tokens_padded = self._get_num_input_tokens(num_tokens_unpadded)
1352
1353
1354
        uniform_decode = (
            max_num_scheduled_tokens == self.uniform_decode_query_len
        ) and (total_num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
1355
1356
1357
1358
1359
1360
1361

        # Disable DP padding when running eager to avoid excessive padding when
        # running prefills. This lets us set enforce_eager 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

1362
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
1363
1364
1365
1366
1367
1368
1369
            num_tokens_unpadded=num_tokens_unpadded,
            parallel_config=self.parallel_config,
            allow_microbatching=True,
            allow_dp_padding=allow_dp_padding,
            num_tokens_padded=num_tokens_padded,
            uniform_decode=uniform_decode,
            num_scheduled_tokens_per_request=num_scheduled_tokens,
1370
        )
1371

1372
        self.seq_lens.np[:num_reqs] = (
1373
1374
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1375
        # Fill unused with 0 for full cuda graph mode.
1376
1377
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
1378

1379
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1380
1381
1382
1383
1384
1385
1386
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

        # Record the index of requests that should not be sampled,
        # so that we could clear the sampled tokens before returning
        discard_requests_mask = self.seq_lens.np[:num_reqs] < num_tokens_np
        discard_request_indices = np.nonzero(discard_requests_mask)[0]
        self.num_discarded_requests = len(discard_request_indices)
1387
1388
1389
        self.discard_request_indices.np[: self.num_discarded_requests] = (
            discard_request_indices
        )
1390
1391
1392

        self.discard_request_indices.copy_to_gpu(self.num_discarded_requests)

1393
        # Copy the tensors to the GPU.
1394
1395
1396
1397
1398
        self._prepare_input_ids(
            scheduler_output,
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
1399

1400
        if self.uses_mrope:
1401
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1402
1403
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1404
1405
                non_blocking=True,
            )
1406
1407
1408
1409
1410
1411
        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,
            )
1412
1413
        else:
            # Common case (1D positions)
1414
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1415

1416
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
1417
1418
1419
1420
1421
1422
1423
        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
1424
            num_draft_tokens = None
1425
            spec_decode_metadata = None
1426
            num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
1427
1428
1429
1430
1431
        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)
1432
1433
1434
            # 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)
1435
1436
1437
1438
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
1439
1440
                req_idx = self.input_batch.req_id_to_index[req_id]
                num_draft_tokens[req_idx] = len(draft_token_ids)
1441
1442
1443
1444
1445
1446
1447
1448
                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
                )
1449
            spec_decode_metadata = self._calc_spec_decode_metadata(
1450
1451
                num_draft_tokens, cu_num_tokens
            )
1452
            logits_indices = spec_decode_metadata.logits_indices
1453
            num_sampled_tokens = num_draft_tokens + 1
1454
            # For DECODE only cuda graph of some attention backends (e.g., GDN).
1455
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
1456
1457
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
1458

1459
1460
1461
1462
1463
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
1464
            )
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
            self.set_active_loras(
                self.input_batch, num_scheduled_tokens, num_sampled_tokens
            )

        return (
            logits_indices,
            spec_decode_metadata,
            ubatch_slices,
            num_tokens_across_dp,
        )

    def _build_attention_metadata(
        self,
        total_num_scheduled_tokens: int,
        max_num_scheduled_tokens: int,
        num_reqs: int,
        ubatch_slices: UBatchSlices | None = None,
        logits_indices: torch.Tensor | None = None,
        use_spec_decode: bool = False,
        for_cudagraph_capture: bool = False,
        scheduled_encoder_inputs: dict[str, list[int]] | None = None,
        cascade_attn_prefix_lens: list[list[int]] | None = None,
    ) -> tuple[PerLayerAttnMetadata, CommonAttentionMetadata | None]:
        """
        :return: tuple[attn_metadata, spec_decode_common_attn_metadata]
        """
        logits_indices_padded = None
1492
        num_logits_indices = None
1493
1494
1495
1496
1497
1498
        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
                )
1499

1500
1501
1502
1503
1504
1505
        # 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,
1506
                self.parallel_config.cp_kv_cache_interleave_size,
1507
1508
1509
            )
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs)

1510
1511
1512
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1513

1514
1515
        # Used in the below loop
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1516
        query_start_loc_cpu = self.query_start_loc.cpu[: num_reqs + 1]
1517
        seq_lens = self.seq_lens.gpu[:num_reqs]
1518
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs]
1519
1520
1521
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs
        ]
1522
1523
1524
1525
1526
1527

        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]
            dcp_local_seq_lens_cpu = self.dcp_local_seq_lens.cpu[:num_reqs]

1528
        spec_decode_common_attn_metadata = None
1529
1530
1531
1532
1533
1534
1535
1536
1537

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

1538
1539
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1540
1541
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1542
1543
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1544

1545
1546
        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
1547
        for kv_cache_gid, kv_cache_group in enumerate(
1548
1549
            self.kv_cache_config.kv_cache_groups
        ):
1550
            encoder_seq_lens = self._get_encoder_seq_lens(
1551
1552
1553
                scheduled_encoder_inputs or {},
                kv_cache_group.kv_cache_spec,
                num_reqs,
1554
            )
1555

1556
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
1557
1558
1559
1560
1561
                # 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(
                    (num_reqs, 1),
                    dtype=torch.int32,
1562
1563
1564
                    device=self.device,
                )
                slot_mapping = torch.zeros(
1565
                    (total_num_scheduled_tokens,),
1566
1567
1568
                    dtype=torch.int64,
                    device=self.device,
                )
1569
            else:
1570
                blk_table = self.input_batch.block_table[kv_cache_gid]
1571
                blk_table_tensor = blk_table.get_device_tensor(num_reqs)
1572
                slot_mapping = blk_table.slot_mapping.gpu[:total_num_scheduled_tokens]
1573
1574
1575

                # Fill unused with -1. Needed for reshape_and_cache in full cuda
                # graph mode.
1576
                blk_table.slot_mapping.gpu[total_num_scheduled_tokens:].fill_(-1)
1577

1578
            common_attn_metadata = CommonAttentionMetadata(
1579
1580
1581
1582
1583
                query_start_loc=query_start_loc,
                query_start_loc_cpu=query_start_loc_cpu,
                seq_lens=seq_lens,
                seq_lens_cpu=seq_lens_cpu,
                num_computed_tokens_cpu=num_computed_tokens_cpu,
1584
1585
1586
                num_reqs=num_reqs,
                num_actual_tokens=total_num_scheduled_tokens,
                max_query_len=max_num_scheduled_tokens,
1587
                max_seq_len=max_seq_len,
1588
1589
                block_table_tensor=blk_table_tensor,
                slot_mapping=slot_mapping,
1590
                logits_indices_padded=logits_indices_padded,
1591
                num_logits_indices=num_logits_indices,
1592
                causal=True,
1593
                encoder_seq_lens=encoder_seq_lens,
1594
                dcp_local_seq_lens=dcp_local_seq_lens,
1595
                dcp_local_seq_lens_cpu=dcp_local_seq_lens_cpu,
1596
1597
            )

1598
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1599
                if isinstance(self.drafter, EagleProposer):
1600
                    if self.drafter.attn_layer_names[0] in kv_cache_group.layer_names:
1601
1602
1603
                        spec_decode_common_attn_metadata = common_attn_metadata
                else:
                    spec_decode_common_attn_metadata = common_attn_metadata
1604

1605
1606
1607
1608
1609
1610
            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
                )
1611
                builder = attn_group.get_metadata_builder()
1612

1613
                extra_attn_metadata_args = {}
1614
                if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
1615
                    extra_attn_metadata_args = dict(
1616
1617
1618
1619
                        num_accepted_tokens=self.num_accepted_tokens.gpu[:num_reqs],
                        num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
                            :num_reqs
                        ],
1620
1621
                    )

1622
1623
                if ubatch_slices is not None:
                    common_attn_metadata_list = split_attn_metadata(
1624
1625
                        ubatch_slices, common_attn_metadata
                    )
1626
                    for ubid, common_attn_metadata in enumerate(
1627
1628
                        common_attn_metadata_list
                    ):
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
                        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:
1640
1641
1642
1643
                            assert type(attn_metadata) is list
                            attn_metadata[ubid][layer_name] = attn_metadata_i
                else:
                    assert isinstance(attn_metadata, dict)
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
                    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,
                        )
1654
1655
                    for layer_name in attn_group.layer_names:
                        attn_metadata[layer_name] = attn_metadata_i
1656

1657
        return attn_metadata, spec_decode_common_attn_metadata
1658

1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
    def _compute_cascade_attn_prefix_lens(
        self,
        num_scheduled_tokens: np.ndarray,
        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
        """
1669

1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
        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,
                        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
1692

1693
1694
1695
1696
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
        num_common_prefix_blocks: int,
1697
1698
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
    ) -> 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.
        """
1717

1718
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
        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]
1756
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
1757
1758
1759
1760
1761
1762
1763
        # 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.
        num_reqs = len(num_scheduled_tokens)
        common_prefix_len = min(
1764
1765
            common_prefix_len, self.input_batch.num_computed_tokens_cpu[:num_reqs].min()
        )
1766
        # common_prefix_len should be a multiple of the block size.
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
        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
        )
1778
1779
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
1780
1781
1782
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
1783
            num_kv_heads=kv_cache_spec.num_kv_heads,
1784
            use_alibi=self.use_alibi,
1785
            use_sliding_window=use_sliding_window,
1786
            use_local_attention=use_local_attention,
1787
            num_sms=self.num_sms,
1788
            dcp_world_size=self.dcp_world_size,
1789
1790
1791
        )
        return common_prefix_len if use_cascade else 0

1792
1793
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
1794
        for index, req_id in enumerate(self.input_batch.req_ids):
1795
1796
1797
            req = self.requests[req_id]
            assert req.mrope_positions is not None

1798
1799
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1800
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
1801
1802
                req.prompt_token_ids, req.prompt_embeds
            )
1803
1804

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
1805
1806
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
            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

1820
1821
1822
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
1823
1824
1825
1826
1827
1828
1829
                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

1830
                assert req.mrope_position_delta is not None
1831
                MRotaryEmbedding.get_next_input_positions_tensor(
1832
                    out=self.mrope_positions.np,
1833
1834
1835
1836
1837
                    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,
                )
1838
1839
1840

                mrope_pos_ptr += completion_part_len

1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
    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

1888
1889
    def _calc_spec_decode_metadata(
        self,
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
        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
1906
1907
1908
1909

        # 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(
1910
1911
            num_sampled_tokens, cumsum_dtype=np.int32
        )
1912
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
1913
        logits_indices = np.repeat(
1914
1915
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
1916
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
1917
1918
1919
1920
1921
1922
        logits_indices += arange

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

        # Compute the draft logits indices.
1923
1924
1925
        # 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(
1926
1927
            num_draft_tokens, cumsum_dtype=np.int32
        )
1928
1929
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
1930
1931
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
1932
1933
1934
1935
1936
        # [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(
1937
1938
            self.device, non_blocking=True
        )
1939
1940
1941
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
1942
1943
1944
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
1945
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
1946
1947
            self.device, non_blocking=True
        )
1948
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
1949
1950
            self.device, non_blocking=True
        )
1951

1952
1953
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
1954
        draft_token_ids = self.input_ids.gpu[logits_indices]
1955
1956
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

1957
        return SpecDecodeMetadata(
1958
1959
1960
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
1961
            cu_num_sampled_tokens=cu_num_sampled_tokens,
1962
1963
1964
1965
1966
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

1967
1968
1969
1970
1971
1972
1973
    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
1974
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
1975
1976
1977
1978
1979
        # 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_(
1980
1981
1982
1983
1984
1985
            logits_indices[-1].item()
        )
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and num_logits <= self.cudagraph_batch_sizes[-1]
        ):
1986
1987
1988
1989
1990
            # 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
1991
1992
1993
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
1994
1995
        return logits_indices_padded

1996
1997
1998
1999
2000
2001
2002
2003
    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
2004
                inputs.
2005
2006
2007
2008
2009
2010

        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
        """
2011
2012
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
2013
            return [], []
2014
        # Batch the multi-modal inputs.
2015
        mm_kwargs = list[MultiModalKwargsItem]()
2016
2017
        # list of tuple (mm_hash, position_info)
        mm_hashes_pos = list[tuple[str, PlaceholderRange]]()
2018
2019
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
2020
2021

            for mm_input_id in encoder_input_ids:
2022
                mm_feature = req_state.mm_features[mm_input_id]
2023
2024
                if mm_feature.data is None:
                    continue
2025
2026
2027
                mm_hash = mm_feature.identifier
                mm_kwargs.append(mm_feature.data)
                mm_hashes_pos.append((mm_hash, mm_feature.mm_position))
2028

2029
2030
        return mm_kwargs, mm_hashes_pos

2031
2032
2033
    def _execute_mm_encoder(
        self, scheduler_output: "SchedulerOutput"
    ) -> list[torch.Tensor]:
2034
2035
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, mm_hashes_pos = self._batch_mm_kwargs_from_scheduler(
2036
2037
            scheduler_output
        )
2038
2039

        if not mm_kwargs:
2040
            return []
2041

2042
2043
2044
2045
2046
2047
2048
        # 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.
2049
        model = cast(SupportsMultiModal, self.model)
2050
        encoder_outputs: list[torch.Tensor] = []
2051
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
2052
2053
2054
2055
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
2056
            multimodal_cpu_fields=model.multimodal_cpu_fields,
2057
        ):
2058
            curr_group_outputs: list[torch.Tensor] = []
2059
2060

            # EVS-related change.
2061
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
2062
            # processing multimodal data. This solves the issue with scheduler
2063
2064
2065
2066
            # 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)
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
            # 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,
                            merge_by_field_config=model.merge_by_field_config,
2083
                            multimodal_cpu_fields=model.multimodal_cpu_fields,
2084
                        )
2085
                    )
2086

2087
                    micro_batch_outputs = model.embed_multimodal(
2088
2089
                        **micro_batch_mm_inputs
                    )
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099

                    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.
2100
                curr_group_outputs = model.embed_multimodal(**mm_kwargs_group)  # type: ignore[assignment]
2101

2102
2103
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
2104
                expected_num_items=num_items,
2105
            )
2106
            encoder_outputs.extend(curr_group_outputs)
2107

2108
2109
2110
        # 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(
2111
2112
2113
                output,
                is_embed=pos_info.is_embed,
            )
2114
2115
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
2116

2117
2118
        return encoder_outputs

2119
    def _gather_mm_embeddings(
2120
2121
        self,
        scheduler_output: "SchedulerOutput",
2122
        shift_computed_tokens: int = 0,
2123
2124
2125
2126
2127
2128
2129
2130
    ) -> 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
2131
        should_sync_mrope_positions = False
2132
        should_sync_xdrope_positions = False
2133

2134
        for req_id in self.input_batch.req_ids:
2135
2136
            mm_embeds_req: list[torch.Tensor] = []

2137
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2138
            req_state = self.requests[req_id]
2139
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2140

2141
2142
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2143
2144
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160

                # 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,
2161
2162
                    num_encoder_tokens,
                )
2163
                assert start_idx < end_idx
2164

2165
                mm_hash = mm_feature.identifier
2166
                encoder_output = self.encoder_cache.get(mm_hash, None)
2167
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2168
2169
2170
2171

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

2172
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2173
2174
2175
                is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                    True if is_embed is None else is_embed
                )
2176

2177
2178
2179
2180
                mm_embeds_item = gather_mm_placeholders(
                    encoder_output[start_idx:end_idx],
                    is_embed=is_embed,
                )
2181
2182
2183
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2184
                assert req_state.mrope_positions is not None
2185
2186
2187
2188
2189
2190
2191
                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,
2192
2193
                    )
                )
2194
2195
2196
2197
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
2198
2199
2200
            req_start_idx += num_scheduled_tokens

        is_mm_embed = self.is_mm_embed.copy_to_gpu(total_num_scheduled_tokens)
2201
2202
2203

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
2204
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
2205

2206
2207
2208
2209
        if should_sync_xdrope_positions:
            self._calc_xdrope_positions(scheduler_output)
            self.xdrope_positions.copy_to_gpu(total_num_scheduled_tokens)

2210
        return mm_embeds, is_mm_embed
2211

2212
    def get_model(self) -> nn.Module:
2213
        # get raw model out of the cudagraph wrapper.
2214
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
2215
            return self.model.unwrap()
2216
2217
        return self.model

2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
    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

2233
2234
2235
2236
2237
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

2238
2239
        supported_tasks = list(model.pooler.get_supported_tasks())

2240
        if self.scheduler_config.enable_chunked_prefill:
2241
2242
2243
2244
            if "token_embed" in supported_tasks:
                supported_tasks.remove("token_embed")
            if "token_classify" in supported_tasks:
                supported_tasks.remove("token_classify")
2245

2246
2247
            logger.debug_once(
                "Chunked prefill is not supported with "
2248
2249
                "token_embed and token_classify tasks "
                "which using ALL pooling. "
2250
2251
2252
                "Please turn off chunked prefill by "
                "`--no-enable-chunked-prefill` before using it."
            )
2253
2254
2255
2256
2257

        if "score" in supported_tasks:
            num_labels = getattr(self.model_config.hf_config, "num_labels", 0)
            if num_labels != 1:
                supported_tasks.remove("score")
2258
                logger.debug_once("Score API is only enabled for num_labels == 1.")
2259
2260

        return supported_tasks
2261

2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
    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)

2272
    def sync_and_slice_intermediate_tensors(
2273
2274
        self,
        num_tokens: int,
2275
        intermediate_tensors: IntermediateTensors | None,
2276
2277
        sync_self: bool,
    ) -> IntermediateTensors:
2278
2279
2280
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
2281
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
2282
2283
2284
2285
2286
2287

        # 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():
2288
                is_scattered = k == "residual" and is_rs
2289
                copy_len = num_tokens // tp if is_scattered else num_tokens
2290
                self.intermediate_tensors[k][:copy_len].copy_(
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
                    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:
2304
2305
2306
2307
2308
2309
2310
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2311
2312
        model = self.get_model()
        assert is_mixture_of_experts(model)
2313
2314
2315
        self.eplb_state.step(
            is_dummy,
            is_profile,
2316
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2317
2318
        )

2319
2320
2321
2322
    # This is where the second ubatch is adjusted to account for the padding.
    # Should be called after attention metadata creation. This just pads
    # the second ubatch slice out to the total number of tokens
    # (num_tokens + padding)
2323
2324
    @staticmethod
    def pad_out_ubatch_slice(ubatch_slices: UBatchSlices, num_total_tokens: int):
2325
2326
2327
2328
2329
2330
        padded_second_ubatch_slice = slice(
            ubatch_slices[1].token_slice.start, num_total_tokens
        )
        ubatch_slices[1] = UBatchSlice(
            padded_second_ubatch_slice, padded_second_ubatch_slice
        )
2331

2332
2333
2334
2335
2336
2337
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
    ) -> ModelRunnerOutput:
2338
2339
2340
        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"
        )
2341

2342
        hidden_states = hidden_states[:num_scheduled_tokens]
2343
        pooling_metadata = self.input_batch.get_pooling_metadata()
2344
2345
2346
2347
        pooling_metadata.build_pooling_cursor(
            num_scheduled_tokens_np.tolist(), device=hidden_states.device
        )
        seq_lens_cpu = self.seq_lens.cpu[: self.input_batch.num_reqs]
2348

2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
        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(
            lambda x: x.to("cpu", non_blocking=True),
            raw_pooler_output,
        )
        self._sync_device()
2359

2360
        pooler_output: list[torch.Tensor | None] = []
2361
        for raw_output, seq_len, prompt_len in zip(
2362
2363
            raw_pooler_output, seq_lens_cpu, pooling_metadata.prompt_lens
        ):
2364
            output = raw_output if seq_len == prompt_len else None
2365
            pooler_output.append(output)
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375

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

2376
    def _get_num_input_tokens(self, num_scheduled_tokens: int) -> int:
2377
2378
2379
2380
2381
2382
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and hasattr(self, "cudagraph_batch_sizes")
            and self.cudagraph_batch_sizes
            and num_scheduled_tokens <= self.cudagraph_batch_sizes[-1]
        ):
2383
2384
2385
2386
2387
2388
2389
2390
            # Use CUDA graphs.
            # Add padding to the batch size.
            return self.vllm_config.pad_for_cudagraph(num_scheduled_tokens)

        # Eager mode.
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
2391
2392
2393
2394
        if (
            self.compilation_config.pass_config.enable_sequence_parallelism
            and tp_size > 1
        ):
2395
2396
2397
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

2398
    def _preprocess(
2399
2400
        self,
        scheduler_output: "SchedulerOutput",
2401
        num_input_tokens: int,  # Padded
2402
        intermediate_tensors: IntermediateTensors | None = None,
2403
    ) -> tuple[
2404
2405
        torch.Tensor | None,
        torch.Tensor | None,
2406
        torch.Tensor,
2407
        IntermediateTensors | None,
2408
        dict[str, Any],
2409
        ECConnectorOutput | None,
2410
    ]:
2411
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2412
        is_first_rank = get_pp_group().is_first_rank
2413

2414
2415
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
2416
2417
        ec_connector_output = None

2418
2419
        if (
            self.supports_mm_inputs
2420
            and is_first_rank
2421
2422
            and not self.model_config.is_encoder_decoder
        ):
2423
            # Run the multimodal encoder if any.
2424
2425
2426
2427
2428
2429
            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)
2430

2431
2432
2433
            # 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.
2434
            inputs_embeds_scheduled = self.model.embed_input_ids(
2435
2436
2437
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2438
            )
2439

2440
            # TODO(woosuk): Avoid the copy. Optimize.
2441
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2442

2443
            input_ids = None
2444
            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
2445
2446
2447
2448
            model_kwargs = {
                **self._init_model_kwargs(num_scheduled_tokens),
                **self._extract_mm_kwargs(scheduler_output),
            }
2449
        elif self.enable_prompt_embeds and is_first_rank:
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
            # 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).
2462
2463
2464
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
2465
                .squeeze(1)
2466
            )
2467
2468
2469
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
2470
                tokens_to_embeds = self.model.embed_input_ids(input_ids=token_ids)
2471
2472
2473
2474
2475
                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
2476
        else:
2477
2478
2479
2480
            # 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.
2481
            input_ids = self.input_ids.gpu[:num_input_tokens]
2482
            inputs_embeds = None
2483
            model_kwargs = self._init_model_kwargs(num_input_tokens)
2484

2485
        if self.uses_mrope:
2486
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2487
2488
        elif self.uses_xdrope_dim > 0:
            positions = self.xdrope_positions.gpu[:, :num_input_tokens]
2489
        else:
2490
            positions = self.positions.gpu[:num_input_tokens]
2491

2492
        if is_first_rank:
2493
2494
            intermediate_tensors = None
        else:
2495
            assert intermediate_tensors is not None
2496
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2497
2498
                num_input_tokens, intermediate_tensors, True
            )
2499

2500
2501
2502
2503
        if (
            self.model_config.is_encoder_decoder
            and scheduler_output.scheduled_encoder_inputs
        ):
2504
2505
2506
2507
2508
2509
2510
            # 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})
2511

2512
2513
2514
2515
2516
2517
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
2518
            ec_connector_output,
2519
        )
2520

2521
    def _sample(
2522
        self,
2523
2524
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2525
    ) -> SamplerOutput:
2526
        # Sample the next token and get logprobs if needed.
2527
        sampling_metadata = self.input_batch.sampling_metadata
2528
        if spec_decode_metadata is None:
2529
2530
2531
            # 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()
2532
            return self.sampler(
2533
2534
2535
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
2536

2537
        sampler_output = self.rejection_sampler(
2538
2539
            spec_decode_metadata,
            None,  # draft_probs
2540
            logits,
2541
2542
            sampling_metadata,
        )
2543
        self._update_states_after_model_execute(sampler_output.sampled_token_ids)
2544
2545
2546
        return sampler_output

    def _bookkeeping_sync(
2547
2548
2549
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
2550
        logits: torch.Tensor | None,
2551
2552
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
2553
        spec_decode_metadata: SpecDecodeMetadata | None,
2554
    ) -> tuple[
2555
        dict[str, int],
2556
        LogprobsLists | None,
2557
        list[list[int]],
2558
        dict[str, LogprobsTensors | None],
2559
2560
2561
        list[str],
        dict[str, int],
        list[int],
2562
    ]:
2563
2564
2565
2566
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

2567
2568
2569
        discard_sampled_tokens_req_indices = self.discard_request_indices.np[
            : self.num_discarded_requests
        ]
2570
2571
2572
2573
        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)
2574

2575
2576
2577
        # 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()
2578
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2579
2580

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2581
        sampled_token_ids = sampler_output.sampled_token_ids
2582
        logprobs_tensors = sampler_output.logprobs_tensors
2583
        invalid_req_indices = []
2584
        cu_num_new_tokens: list[int] | None = None
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
        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)
            else:
                # Includes spec decode tokens.
                valid_sampled_token_ids = self.rejection_sampler.parse_output(
                    sampled_token_ids,
                    self.input_batch.vocab_size,
                )
2597
2598
2599
2600
2601
2602
                if logprobs_tensors:
                    # Needed for extracting logprobs when spec decoding.
                    # This must be done prior to discarding sampled tokens.
                    cu_num_new_tokens = [0]
                    for toks in valid_sampled_token_ids:
                        cu_num_new_tokens.append(cu_num_new_tokens[-1] + len(toks))
2603
2604
            # Mask out the sampled tokens that should not be sampled.
            for i in discard_sampled_tokens_req_indices:
2605
                valid_sampled_token_ids[int(i)].clear()
2606
        else:
2607
            valid_sampled_token_ids = []
2608
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2609
2610
2611
2612
2613
            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.
2614
2615
2616
2617
            # 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
2618
2619
2620
2621
2622
            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
            }
2623

2624
2625
2626
2627
2628
        # 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.
2629
        req_ids = self.input_batch.req_ids
2630
2631
        for req_idx in range(num_sampled_tokens):
            if self.use_async_scheduling:
2632
                sampled_ids = [-1] if req_idx not in invalid_req_indices_set else None
2633
2634
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
2635

2636
            num_sampled_ids: int = len(sampled_ids) if sampled_ids else 0
2637

2638
            if not sampled_ids:
2639
2640
2641
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
2642
            end_idx = start_idx + num_sampled_ids
2643
2644
2645
2646
            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}"
2647
            )
2648

2649
2650
            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
2651
2652
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
            self.input_batch.num_tokens[req_idx] = end_idx
2653

2654
            req_id = req_ids[req_idx]
2655
2656
2657
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

2658
        logprobs_lists = (
2659
            logprobs_tensors.tolists(cu_num_new_tokens)
2660
            if not self.use_async_scheduling and logprobs_tensors is not None
2661
2662
2663
2664
2665
2666
2667
2668
2669
            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,
        )

2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
        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,
        )

2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
    @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()

2695
2696
    def _model_forward(
        self,
2697
2698
2699
2700
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
2701
2702
2703
2704
2705
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
2706
        Motivation: We can inspect only this method versus
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
        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,
        )

2727
2728
2729
2730
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
2731
        intermediate_tensors: IntermediateTensors | None = None,
2732
2733
2734
2735
2736
2737
    ) -> 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."
            )
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752

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

2753
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2754
        with record_function_or_nullcontext("gpu_model_runner: preprocess"):
2755
2756
2757
2758
            with self.synchronize_input_prep():
                # Update persistent batch states.
                self._update_states(scheduler_output)

2759
2760
2761
2762
2763
2764
2765
2766
                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)

2767
                if not num_scheduled_tokens:
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
                    if (
                        self.parallel_config.distributed_executor_backend
                        == "external_launcher"
                        and self.parallel_config.data_parallel_size > 1
                    ):
                        # this is a corner case when both external launcher
                        # and DP are enabled, num_scheduled_tokens could be
                        # 0, and has_unfinished_requests in the outer loop
                        # returns True. before returning early here we call
                        # dummy run to ensure coordinate_batch_across_dp
                        # is called into to avoid out of sync issues.
                        self._dummy_run(1)
2780
2781
2782
2783
                    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(
2784
2785
                        scheduler_output, self.vllm_config
                    )
2786
                if self.cache_config.kv_sharing_fast_prefill:
2787
                    assert not self.num_prompt_logprobs, (
2788
2789
                        "--kv-sharing-fast-prefill produces incorrect "
                        "logprobs for prompt tokens, tokens, please disable "
2790
2791
                        "it when the requests need prompt logprobs"
                    )
2792

2793
2794
2795
2796
2797
2798
                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())

2799
2800
2801
2802
                (
                    logits_indices,
                    spec_decode_metadata,
                    ubatch_slices,
2803
                    num_tokens_across_dp,
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
                ) = self._prepare_inputs(
                    scheduler_output, num_scheduled_tokens_np, max_num_scheduled_tokens
                )

                cascade_attn_prefix_lens = None
                # Disable cascade attention when using microbatching (DBO)
                if self.cascade_attn_enabled and ubatch_slices is None:
                    # Pre-compute cascade attention prefix lengths
                    # NOTE: Must be AFTER _prepare_inputs uses self.input_batch state
                    cascade_attn_prefix_lens = self._compute_cascade_attn_prefix_lens(
                        num_scheduled_tokens_np,
                        scheduler_output.num_common_prefix_blocks,
                    )

                # TODO(lucas): move cudagraph dispatching here:
                #   https://github.com/vllm-project/vllm/issues/23789

                total_num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
                use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
                attn_metadata, spec_decode_common_attn_metadata = (
                    self._build_attention_metadata(
                        total_num_scheduled_tokens=total_num_scheduled_tokens,
                        max_num_scheduled_tokens=max_num_scheduled_tokens,
                        num_reqs=num_reqs,
                        ubatch_slices=ubatch_slices,
                        logits_indices=logits_indices,
                        use_spec_decode=use_spec_decode,
                        scheduled_encoder_inputs=scheduler_output.scheduled_encoder_inputs,
                        cascade_attn_prefix_lens=cascade_attn_prefix_lens,
                    )
                )
2835

2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
                dp_rank = self.parallel_config.data_parallel_rank
                if ubatch_slices:
                    assert num_tokens_across_dp is not None
                    num_input_tokens = int(num_tokens_across_dp[dp_rank].item())
                    self.pad_out_ubatch_slice(ubatch_slices, num_input_tokens)
                elif num_tokens_across_dp is not None:
                    num_input_tokens = int(num_tokens_across_dp[dp_rank].item())
                else:
                    num_input_tokens = self._get_num_input_tokens(
                        scheduler_output.total_num_scheduled_tokens
                    )
2847

2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
                (
                    input_ids,
                    inputs_embeds,
                    positions,
                    intermediate_tensors,
                    model_kwargs,
                    ec_connector_output,
                ) = self._preprocess(
                    scheduler_output, num_input_tokens, intermediate_tensors
                )
2858

2859
2860
2861
            uniform_decode = (
                max_num_scheduled_tokens == self.uniform_decode_query_len
            ) and (num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
2862
            batch_desc = BatchDescriptor(
2863
2864
2865
                num_tokens=num_input_tokens,
                uniform_decode=uniform_decode,
                has_lora=len(self.input_batch.lora_id_to_lora_request) > 0,
2866
2867
            )
            cudagraph_runtime_mode, batch_descriptor = (
2868
                self.cudagraph_dispatcher.dispatch(
2869
                    batch_desc,
2870
2871
                    use_cascade_attn=cascade_attn_prefix_lens is not None,
                )
2872
            )
2873

2874
        # Set cudagraph mode to none if calc_kv_scales is true.
2875
2876
2877
2878
2879
2880
        # KV scales calculation involves dynamic operations that are incompatible
        # with CUDA graph capture.
        if self.calculate_kv_scales:
            cudagraph_runtime_mode = CUDAGraphMode.NONE
            # Mark KV scales as calculated after the first forward pass
            self.calculate_kv_scales = False
2881

2882
2883
        # Run the model.
        # Use persistent buffers for CUDA graphs.
2884
2885
        with (
            set_forward_context(
2886
2887
2888
2889
2890
2891
                attn_metadata,
                self.vllm_config,
                num_tokens=num_input_tokens,
                num_tokens_across_dp=num_tokens_across_dp,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                batch_descriptor=batch_descriptor,
2892
                ubatch_slices=ubatch_slices,
2893
            ),
2894
            record_function_or_nullcontext("gpu_model_runner: forward"),
2895
2896
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
2897
            model_output = self._model_forward(
2898
2899
2900
2901
2902
2903
2904
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

2905
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
2906
            if self.use_aux_hidden_state_outputs:
2907
                # True when EAGLE 3 is used.
2908
2909
                hidden_states, aux_hidden_states = model_output
            else:
2910
                # Common case.
2911
2912
2913
                hidden_states = model_output
                aux_hidden_states = None

2914
2915
2916
2917
2918
            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)
2919
                    hidden_states.kv_connector_output = kv_connector_output
2920
                    self.kv_connector_output = kv_connector_output
2921
                    return hidden_states
2922

2923
                if self.is_pooling_model:
2924
                    # Return the pooling output.
2925
2926
2927
                    output = self._pool(
                        hidden_states, num_scheduled_tokens, num_scheduled_tokens_np
                    )
2928
2929
                    output.kv_connector_output = kv_connector_output
                    return output
2930
2931

                sample_hidden_states = hidden_states[logits_indices]
2932
                logits = self.model.compute_logits(sample_hidden_states)
2933
2934
2935
2936
            else:
                # Rare case.
                assert not self.is_pooling_model

2937
                sample_hidden_states = hidden_states[logits_indices]
2938
                if not get_pp_group().is_last_rank:
2939
                    all_gather_tensors = {
2940
2941
2942
                        "residual": not is_residual_scattered_for_sp(
                            self.vllm_config, num_input_tokens
                        )
2943
                    }
2944
                    get_pp_group().send_tensor_dict(
2945
2946
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
2947
2948
                        all_gather_tensors=all_gather_tensors,
                    )
2949
2950
                    logits = None
                else:
2951
                    logits = self.model.compute_logits(sample_hidden_states)
2952

2953
                model_output_broadcast_data: dict[str, Any] = {}
2954
2955
2956
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

2957
                broadcasted = get_pp_group().broadcast_tensor_dict(
2958
2959
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
2960
2961
                assert broadcasted is not None
                logits = broadcasted["logits"]
2962

2963
2964
2965
2966
2967
2968
2969
2970
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
2971
            ec_connector_output,
2972
        )
2973
        self.kv_connector_output = kv_connector_output
2974
2975
2976
2977
2978
2979
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
2980
2981
2982
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

2983
2984
        if self.execute_model_state is None:
            # Nothing to do (PP non-final rank case), output isn't used.
2985
            if not kv_connector_output:
2986
                return None  # type: ignore[return-value]
2987
2988
2989
2990
2991
2992
2993
2994
2995

            # 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
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3006
            ec_connector_output,
3007
3008
3009
3010
3011
3012
3013
3014
3015
        ) = 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
            )
3016

3017
        with record_function_or_nullcontext("gpu_model_runner: sample"):
3018
3019
            sampler_output = self._sample(logits, spec_decode_metadata)

3020
3021
        self.input_batch.prev_sampled_token_ids = None

3022
        def propose_draft_token_ids(sampled_token_ids):
3023
            assert spec_decode_common_attn_metadata is not None
3024
            with record_function_or_nullcontext("gpu_model_runner: draft"):
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
                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,
                )

3036
        spec_config = self.speculative_config
3037
        use_padded_batch_for_eagle = (
3038
3039
3040
            spec_config is not None
            and spec_config.use_eagle()
            and not spec_config.disable_padded_drafter_batch
3041
        )
3042
3043
3044
        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
3045
        if (
3046
3047
3048
            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
3049
        ):
3050
            effective_drafter_max_model_len = (
3051
                spec_config.draft_model_config.max_model_len
3052
            )
3053
        input_fits_in_drafter = spec_decode_common_attn_metadata and (
3054
            spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
3055
3056
            <= effective_drafter_max_model_len
        )
3057
        if use_padded_batch_for_eagle:
3058
3059
            assert self.speculative_config is not None
            assert isinstance(self.drafter, EagleProposer)
3060
3061
3062
3063
3064
3065
            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:
3066
                assert spec_decode_common_attn_metadata is not None
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
                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,
                        self.discard_request_indices.gpu,
                        self.num_discarded_requests,
                    )
                )
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
3080

3081
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
3082
3083
3084
3085
3086
3087
3088
3089
            (
                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,
3090
3091
3092
3093
3094
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
3095
                scheduler_output.total_num_scheduled_tokens,
3096
                spec_decode_metadata,
3097
            )
3098

3099
3100
3101
3102
3103
        if (
            self.speculative_config
            and not use_padded_batch_for_eagle
            and input_fits_in_drafter
        ):
3104
3105
3106
            # 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)
3107

3108
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
3109
            self.eplb_step()
3110
3111
3112
3113
3114
3115
3116
3117
3118
        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,
3119
3120
3121
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
3122
3123
                num_nans_in_logits=num_nans_in_logits,
            )
3124

3125
3126
        if not self.use_async_scheduling:
            return output
3127
3128
3129
3130
3131
3132
3133
3134
3135
        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,
3136
                vocab_size=self.input_batch.vocab_size,
3137
3138
3139
3140
3141
            )
        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
3142
            # any requests with sampling params that require output ids.
3143
3144
3145
3146
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
3147
3148
3149

        return async_output

3150
    def take_draft_token_ids(self) -> DraftTokenIds | None:
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
        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)

3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
    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()

3192
3193
3194
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
3195
        sampled_token_ids: torch.Tensor | list[list[int]],
3196
3197
3198
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
3199
3200
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3201
        common_attn_metadata: CommonAttentionMetadata,
3202
    ) -> list[list[int]] | torch.Tensor:
3203
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3204
3205
3206
        spec_config = self.speculative_config
        assert spec_config is not None
        if spec_config.method == "ngram":
3207
            assert isinstance(sampled_token_ids, list)
3208
            assert isinstance(self.drafter, NgramProposer)
3209
            draft_token_ids = self.drafter.propose(
3210
3211
                sampled_token_ids,
                self.input_batch.req_ids,
3212
3213
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
3214
3215
                self.input_batch.spec_decode_unsupported_reqs,
            )
3216
        elif spec_config.method == "suffix":
3217
3218
3219
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
            draft_token_ids = self.drafter.propose(self.input_batch, sampled_token_ids)
3220
        elif spec_config.method == "medusa":
3221
            assert isinstance(sampled_token_ids, list)
3222
            assert isinstance(self.drafter, MedusaProposer)
3223

3224
3225
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
3226
3227
3228
3229
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
3230
3231
3232
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
3233
                for num_draft, tokens in zip(
3234
3235
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
3236
                    indices.append(offset + len(tokens) - 1)
3237
                    offset += num_draft + 1
3238
                indices = torch.tensor(indices, device=self.device)
3239
3240
                hidden_states = sample_hidden_states[indices]

3241
            draft_token_ids = self.drafter.propose(
3242
3243
3244
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
            )
3245
        elif spec_config.use_eagle():
3246
            assert isinstance(self.drafter, EagleProposer)
3247

3248
            if spec_config.disable_padded_drafter_batch:
3249
3250
3251
                # 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.
3252
3253
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
3254
                    "padded-batch is disabled."
3255
                )
3256
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
3257
3258
3259
3260
3261
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
3262
3263
3264
3265
3266
            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.
3267
3268
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
3269
                    "padded-batch is enabled."
3270
3271
                )
                next_token_ids, valid_sampled_tokens_count = (
3272
3273
3274
3275
3276
3277
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
                        self.discard_request_indices.gpu,
3278
                        self.num_discarded_requests,
3279
                    )
3280
                )
3281
3282
3283
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
3284

3285
            if spec_decode_metadata is None:
3286
                token_indices_to_sample = None
3287
                # input_ids can be None for multimodal models.
3288
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
3289
                target_positions = self._get_positions(num_scheduled_tokens)
3290
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3291
                    assert aux_hidden_states is not None
3292
                    target_hidden_states = torch.cat(
3293
3294
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
3295
3296
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
3297
            else:
3298
                if spec_config.disable_padded_drafter_batch:
3299
                    token_indices_to_sample = None
3300
3301
3302
3303
3304
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
3305
                else:
3306
                    common_attn_metadata, token_indices, token_indices_to_sample = (
3307
3308
3309
                        self.drafter.prepare_inputs_padded(
                            common_attn_metadata,
                            spec_decode_metadata,
3310
3311
3312
                            valid_sampled_tokens_count,
                        )
                    )
3313

3314
                target_token_ids = self.input_ids.gpu[token_indices]
3315
                target_positions = self._get_positions(token_indices)
3316
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3317
                    assert aux_hidden_states is not None
3318
                    target_hidden_states = torch.cat(
3319
3320
                        [h[token_indices] for h in aux_hidden_states], dim=-1
                    )
3321
3322
                else:
                    target_hidden_states = hidden_states[token_indices]
3323

3324
            if self.supports_mm_inputs:
3325
3326
3327
3328
3329
3330
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
3331

3332
            draft_token_ids = self.drafter.propose(
3333
3334
3335
3336
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
3337
                last_token_indices=token_indices_to_sample,
3338
                sampling_metadata=sampling_metadata,
3339
                common_attn_metadata=common_attn_metadata,
3340
                mm_embed_inputs=mm_embed_inputs,
3341
            )
3342

3343
        return draft_token_ids
3344

3345
3346
3347
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
3348
3349
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
3350
                f"Allowed configs: {allowed_config_names}"
3351
            )
3352
3353
3354
3355
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

3356
3357
3358
3359
3360
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
3361
3362
3363
3364
3365
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
3366
3367
3368
3369
3370
        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)
        )
3371

3372
3373
3374
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0
3375
        with DeviceMemoryProfiler() as m:
3376
            time_before_load = time.perf_counter()
3377
            model_loader = get_model_loader(self.load_config)
3378
            self.model = model_loader.load_model(
3379
3380
                vllm_config=self.vllm_config, model_config=self.model_config
            )
3381
            if self.lora_config:
3382
3383
3384
                self.model = self.load_lora_model(
                    self.model, self.vllm_config, self.device
                )
3385
            if hasattr(self, "drafter"):
3386
                logger.info_once("Loading drafter model...")
3387
                self.drafter.load_model(self.model)
3388
3389
3390
3391
3392
                if (
                    hasattr(self.drafter, "model")
                    and is_mixture_of_experts(self.drafter.model)
                    and self.parallel_config.enable_eplb
                ):
3393
3394
3395
                    spec_config = self.vllm_config.speculative_config
                    assert spec_config is not None
                    assert spec_config.draft_model_config is not None
3396
3397
                    logger.info_once(
                        "EPLB is enabled for drafter model %s.",
3398
                        spec_config.draft_model_config.model,
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
                    )

                    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,
3415
                        spec_config.draft_model_config,
3416
3417
3418
3419
3420
3421
                        global_expert_load,
                        old_global_expert_indices,
                        rank_mapping,
                    )
                    eplb_models += 1

3422
            if self.use_aux_hidden_state_outputs:
3423
                if not supports_eagle3(self.get_model()):
3424
3425
                    raise RuntimeError(
                        "Model does not support EAGLE3 interface but "
3426
3427
                        "aux_hidden_state_outputs was requested"
                    )
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440

                # 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)
3441
            time_after_load = time.perf_counter()
3442
        self.model_memory_usage = m.consumed_memory
3443
        logger.info_once(
3444
            "Model loading took %.4f GiB memory and %.6f seconds",
3445
3446
            self.model_memory_usage / GiB_bytes,
            time_after_load - time_before_load,
3447
            scope="local",
3448
        )
3449
        prepare_communication_buffer_for_model(self.model)
3450
        mm_config = self.model_config.multimodal_config
3451
        self.is_multimodal_pruning_enabled = (
3452
            supports_multimodal_pruning(self.get_model())
3453
3454
            and mm_config is not None
            and mm_config.is_multimodal_pruning_enabled()
3455
        )
3456

3457
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
            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(
3469
                self.model,
3470
                self.model_config,
3471
3472
3473
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
3474
            )
3475
3476
            if self.eplb_state.is_async:
                self.eplb_state.start_async_loop(rank_mapping=rank_mapping)
3477

3478
        if (
3479
3480
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
3481
            and supports_dynamo()
3482
        ):
3483
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
3484
            compilation_counter.stock_torch_compile_count += 1
3485
            self.model.compile(fullgraph=True, backend=backend)
3486
            return
3487
        # for other compilation modes, cudagraph behavior is controlled by
3488
3489
3490
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
3491
3492
3493
        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:
3494
3495
3496
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
3497
        elif self.parallel_config.enable_dbo:
3498
            if cudagraph_mode.has_full_cudagraphs():
3499
3500
3501
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
3502
            else:
3503
3504
3505
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
3506

3507
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
        """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

3531
    def reload_weights(self) -> None:
3532
        assert getattr(self, "model", None) is not None, (
3533
            "Cannot reload weights before model is loaded."
3534
        )
3535
3536
        model_loader = get_model_loader(self.load_config)
        logger.info("Reloading weights inplace...")
3537
        model_loader.load_weights(self.get_model(), model_config=self.model_config)
3538

3539
3540
3541
3542
3543
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
3544
            self.get_model(),
3545
            tensorizer_config=tensorizer_config,
3546
            model_config=self.model_config,
3547
3548
        )

3549
3550
3551
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
3552
        num_scheduled_tokens: dict[str, int],
3553
    ) -> dict[str, LogprobsTensors | None]:
3554
        num_prompt_logprobs_dict = self.num_prompt_logprobs
3555
3556
3557
        if not num_prompt_logprobs_dict:
            return {}

3558
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
3559
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
3560
3561
3562
3563
3564

        # 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():
3565
3566
3567
3568
            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
3569
3570
3571

            # Get metadata for this request.
            request = self.requests[req_id]
3572
3573
3574
3575
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

3576
3577
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
3578
3579
                self.device, non_blocking=True
            )
3580

3581
3582
3583
3584
3585
3586
            # 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(
3587
3588
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
3589
3590
                in_progress_dict[req_id] = logprobs_tensors

3591
            # Determine number of logits to retrieve.
3592
3593
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
3594
            num_remaining_tokens = num_prompt_tokens - start_tok
3595
            if num_tokens <= num_remaining_tokens:
3596
                # This is a chunk, more tokens remain.
3597
3598
3599
                # 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.
3600
3601
3602
3603
3604
                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)
3605
3606
3607
3608
3609
3610
3611
                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
3612
3613
3614
3615
3616

            # 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]
3617
            offset = self.query_start_loc.np[req_idx].item()
3618
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
3619
            logits = self.model.compute_logits(prompt_hidden_states)
3620
3621
3622
3623

            # 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.
3624
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
3625
3626

            # Compute prompt logprobs.
3627
3628
            logprobs = self.sampler.compute_logprobs(logits)
            token_ids, logprobs, ranks = self.sampler.gather_logprobs(
3629
3630
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
3631
3632

            # Transfer GPU->CPU async.
3633
3634
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
3635
3636
3637
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
3638
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
3639
3640
                ranks, non_blocking=True
            )
3641
3642
3643
3644
3645

        # 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]
3646
            del in_progress_dict[req_id]
3647
3648

        # Must synchronize the non-blocking GPU->CPU transfers.
3649
        if prompt_logprobs_dict:
3650
            self._sync_device()
3651
3652
3653

        return prompt_logprobs_dict

3654
3655
    def _get_nans_in_logits(
        self,
3656
        logits: torch.Tensor | None,
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
    ) -> 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])
3668
3669
3670
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
3671
3672
3673
3674
            return num_nans_in_logits
        except IndexError:
            return {}

3675
3676
3677
3678
3679
3680
    @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
3681
         - during DP rank dummy run
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
        """
        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(
3693
                    self.input_ids.gpu,
3694
3695
                    low=0,
                    high=self.model_config.get_vocab_size(),
3696
3697
                    dtype=input_ids.dtype,
                )
3698

3699
            logger.debug_once("Randomizing dummy data for DP Rank")
3700
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
3701
3702
3703
            yield
            input_ids.fill_(0)

3704
3705
3706
3707
3708
3709
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
3710
3711
        assert self.mm_budget is not None

3712
3713
        dummy_decoder_data = self.mm_registry.get_decoder_dummy_data(
            model_config=self.model_config,
3714
            seq_len=self.max_model_len,
3715
            mm_counts={modality: 1},
3716
            cache=self.mm_budget.cache,
3717
3718
3719
3720
        )
        dummy_mm_data = dummy_decoder_data.multi_modal_data

        # Result in the maximum GPU consumption of the model
3721
3722
        dummy_mm_item = dummy_mm_data[modality][0]
        dummy_mm_items = [dummy_mm_item] * max_items_per_batch
3723

3724
        model = cast(SupportsMultiModal, self.model)
3725
3726
3727
3728
3729
3730
3731
        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,
                merge_by_field_config=model.merge_by_field_config,
3732
                multimodal_cpu_fields=model.multimodal_cpu_fields,
3733
3734
            )
        )
3735

3736
3737
3738
3739
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
3740
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
3741
3742
        force_attention: bool = False,
        uniform_decode: bool = False,
3743
        allow_microbatching: bool = True,
3744
3745
        skip_eplb: bool = False,
        is_profile: bool = False,
3746
        create_mixed_batch: bool = False,
3747
        remove_lora: bool = True,
3748
        activate_lora: bool = False,
3749
    ) -> tuple[torch.Tensor, torch.Tensor]:
3750
3751
3752
3753
3754
3755
3756
        """
        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.
3757
                - if not set will determine the cudagraph mode based on using
3758
                    the self.cudagraph_dispatcher.
3759
3760
3761
3762
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
3763
            force_attention: If True, always create attention metadata. Used to
3764
3765
3766
3767
                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.
3768
3769
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
3770
            remove_lora: If False, dummy LoRAs are not destroyed after the run
3771
            activate_lora: If False, dummy_run is performed without LoRAs.
3772
        """
3773
3774
3775
3776
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
3777

3778
        # If cudagraph_mode.decode_mode() == FULL and
3779
        # cudagraph_mode.separate_routine(). This means that we are using
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
        # 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.
3791
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
3792

3793
3794
3795
3796
3797
        # 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
3798
3799
3800
3801
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
3802
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
3803
3804
3805
3806
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
3807
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
3808
3809
3810
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
3811
            assert not create_mixed_batch
3812
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
3813
3814
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
3815
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
3816
3817
3818
3819
3820
3821
        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

3822
3823
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
3824
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
3825
        total_num_scheduled_tokens = int(num_scheduled_tokens.sum())
3826
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
3827

3828
3829
3830
        # Disable DP padding when running eager
        allow_dp_padding = self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE

3831
3832
        # We currently only microbatch if the number of tokens is
        # over a certain threshold.
3833
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
3834
3835
3836
3837
3838
3839
3840
            num_tokens_unpadded=total_num_scheduled_tokens,
            parallel_config=self.vllm_config.parallel_config,
            allow_microbatching=allow_microbatching,
            allow_dp_padding=allow_dp_padding,
            num_tokens_padded=total_num_scheduled_tokens,
            uniform_decode=uniform_decode,
            num_scheduled_tokens_per_request=num_scheduled_tokens,
3841
3842
3843
        )
        num_tokens_after_padding = num_tokens
        if num_tokens_across_dp is not None:
3844
3845
            dp_rank = self.parallel_config.data_parallel_rank
            num_tokens_after_padding = int(num_tokens_across_dp[dp_rank])
3846

3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
        # filter out the valid batch descriptor
        _cg_mode, batch_descriptor = (
            self.cudagraph_dispatcher.dispatch(
                BatchDescriptor(
                    num_tokens=num_tokens_after_padding,
                    uniform_decode=uniform_decode,
                    has_lora=activate_lora and self.lora_config is not None,
                )
            )
            if not is_profile
            else (CUDAGraphMode.NONE, None)
        )
        if cudagraph_runtime_mode is not None:
            # we allow forcing NONE when the dispatcher disagrees to support
            # warm ups for cudagraph capture
            assert (
                cudagraph_runtime_mode == CUDAGraphMode.NONE
                or cudagraph_runtime_mode == _cg_mode
            ), (
                f"Cudagraph runtime mode mismatch at dummy_run. "
                f"Expected {_cg_mode}, but got {cudagraph_runtime_mode}."
            )
        else:
            cudagraph_runtime_mode = _cg_mode

3872
        attn_metadata: PerLayerAttnMetadata | None = None
3873
3874
3875

        # If force_attention is True, we always capture attention. Otherwise,
        # it only happens for cudagraph_runtime_mode=FULL.
3876
        if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
3877
3878
3879
3880
3881
3882
            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:
3883
                seq_lens = max_query_len  # type: ignore[assignment]
3884
            self.seq_lens.np[:num_reqs] = seq_lens
3885
3886
            self.seq_lens.np[num_reqs:] = 0
            self.seq_lens.copy_to_gpu()
3887

3888
3889
            cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
            self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
3890
3891
            self.query_start_loc.copy_to_gpu()

3892
3893
3894
3895
3896
3897
3898
            attn_metadata, _ = self._build_attention_metadata(
                total_num_scheduled_tokens=num_tokens,
                max_num_scheduled_tokens=max_query_len,
                num_reqs=num_reqs,
                ubatch_slices=ubatch_slices,
                for_cudagraph_capture=True,
            )
3899

3900
        with self.maybe_dummy_run_with_lora(
3901
3902
3903
3904
3905
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            activate_lora,
            remove_lora,
3906
        ):
3907
3908
3909
            # Make sure padding doesn't exceed max_num_tokens
            assert num_tokens_after_padding <= self.max_num_tokens
            model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3910
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
3911
                input_ids = None
3912
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
3913
                model_kwargs = {
3914
                    **model_kwargs,
3915
3916
                    **self._dummy_mm_kwargs(num_reqs),
                }
3917
3918
            elif self.enable_prompt_embeds:
                input_ids = None
3919
3920
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
                model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3921
            else:
3922
                input_ids = self.input_ids.gpu[:num_tokens_after_padding]
3923
                inputs_embeds = None
3924

3925
            if self.uses_mrope:
3926
                positions = self.mrope_positions.gpu[:, :num_tokens_after_padding]
3927
3928
            elif self.uses_xdrope_dim > 0:
                positions = self.xdrope_positions.gpu[:, :num_tokens_after_padding]
3929
            else:
3930
                positions = self.positions.gpu[:num_tokens_after_padding]
3931
3932
3933
3934
3935
3936
3937
3938
3939

            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,
3940
3941
3942
                            device=self.device,
                        )
                    )
3943
3944

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
3945
                    num_tokens_after_padding, None, False
3946
                )
3947

3948
            if ubatch_slices is not None:
3949
3950
3951
3952
3953
3954
3955
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
                num_tokens_after_padding = ubatch_slices[0].num_tokens
                if num_tokens_across_dp is not None:
                    num_tokens_across_dp[:] = num_tokens_after_padding

3956
3957
3958
            with (
                self.maybe_randomize_inputs(input_ids),
                set_forward_context(
3959
3960
                    attn_metadata,
                    self.vllm_config,
3961
                    num_tokens=num_tokens_after_padding,
3962
3963
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
3964
                    batch_descriptor=batch_descriptor,
3965
3966
3967
                    ubatch_slices=ubatch_slices,
                ),
            ):
3968
                outputs = self.model(
3969
3970
3971
3972
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
3973
                    **model_kwargs,
3974
                )
3975

3976
3977
3978
3979
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
3980

3981
            if self.speculative_config and self.speculative_config.use_eagle():
3982
                assert isinstance(self.drafter, EagleProposer)
3983
3984
3985
3986
                use_cudagraphs = (
                    cudagraph_runtime_mode == CUDAGraphMode.PIECEWISE
                    and not self.speculative_config.enforce_eager
                )
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998

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

4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
        # 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)

4010
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
4011
4012
4013
4014
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
4015
4016
4017
4018
4019
4020

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
4021
4022
4023
4024
        # 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)
4025

4026
        logits = self.model.compute_logits(hidden_states)
4027
4028
        num_reqs = logits.size(0)

4029
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044

        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)],
4045
            spec_token_ids=[[] for _ in range(num_reqs)],
4046
4047
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
4048
            logitsprocs=LogitsProcessors(),
4049
        )
4050
        try:
4051
4052
4053
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
4054
        except RuntimeError as e:
4055
            if "out of memory" in str(e):
4056
4057
4058
4059
                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 "
4060
4061
                    "initializing the engine."
                ) from e
4062
4063
            else:
                raise e
4064
        if self.speculative_config:
4065
4066
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
4067
4068
                draft_token_ids, self.device
            )
4069
4070
4071
4072
4073
4074

            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
4075
4076
4077
4078
4079
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
4080
            )
4081
4082
4083
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
4084
                logits,
4085
4086
                dummy_metadata,
            )
4087
        return sampler_output
4088

4089
    def _dummy_pooler_run_task(
4090
4091
        self,
        hidden_states: torch.Tensor,
4092
4093
        task: PoolingTask,
    ) -> PoolerOutput:
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
        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

4105
        dummy_prompt_lens = torch.tensor(
4106
4107
            num_scheduled_tokens_list,
            device="cpu",
4108
        )
4109
4110
4111
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
4112

4113
        model = cast(VllmModelForPooling, self.get_model())
4114
        dummy_pooling_params = PoolingParams(task=task)
4115
        dummy_pooling_params.verify(task=task, model_config=self.model_config)
4116
        to_update = model.pooler.get_pooling_updates(task)
4117
4118
        to_update.apply(dummy_pooling_params)

4119
        dummy_metadata = PoolingMetadata(
4120
4121
4122
4123
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
        )
4124

4125
4126
4127
        dummy_metadata.build_pooling_cursor(
            num_scheduled_tokens_list, device=hidden_states.device
        )
4128

4129
        try:
4130
4131
4132
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
4133
        except RuntimeError as e:
4134
            if "out of memory" in str(e):
4135
                raise RuntimeError(
4136
4137
4138
                    "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 "
4139
4140
                    "initializing the engine."
                ) from e
4141
4142
            else:
                raise e
4143
4144
4145
4146
4147
4148
4149

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

        if not supported_pooling_tasks:
4153
            if self.scheduler_config.enable_chunked_prefill:
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
                raise RuntimeError(
                    f"Model {self.model_config.model} does not support "
                    "any pooling tasks with chunked prefill enabled. "
                    "Please add --no-enable-chunked-prefill to your "
                    "config or CLI args. See "
                    "https://docs.vllm.ai/en/latest/models/pooling_models.html "
                    "to learn more."
                )
            else:
                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."
                )

4170
        output_size = dict[PoolingTask, float]()
4171
        for task in supported_pooling_tasks:
4172
4173
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
4174
            output_size[task] = sum(o.nbytes for o in output)
4175
4176
4177
4178
            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)
4179

4180
    def profile_run(self) -> None:
4181
        # Profile with multimodal encoder & encoder cache.
4182
        if self.supports_mm_inputs:
4183
4184
            mm_config = self.model_config.multimodal_config
            if mm_config is not None and mm_config.skip_mm_profiling:
4185
                logger.info(
4186
                    "Skipping memory profiling for multimodal encoder and "
4187
4188
                    "encoder cache."
                )
4189
4190
4191
4192
4193
4194
4195
4196
            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.
4197
                    dummy_modality = mm_budget.get_modality_with_max_tokens()
4198
4199
4200
                    max_mm_items_per_batch = mm_budget.max_items_per_batch_by_modality[
                        dummy_modality
                    ]
4201
4202
4203
4204
4205
4206
4207
4208
4209

                    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,
                    )
4210

4211
4212
4213
4214
4215
                    # Create dummy batch of multimodal inputs.
                    batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                        dummy_modality,
                        max_mm_items_per_batch,
                    )
4216

4217
                    # Run multimodal encoder.
4218
                    dummy_encoder_outputs = self.model.embed_multimodal(
4219
4220
                        **batched_dummy_mm_inputs
                    )
4221

4222
4223
4224
4225
                    sanity_check_mm_encoder_outputs(
                        dummy_encoder_outputs,
                        expected_num_items=max_mm_items_per_batch,
                    )
4226

4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
                    # 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
                    # (encode_budget, hidden_size) and scatter encoder
                    # output into it.
                    encoder_output_shape = dummy_encoder_outputs[0].shape
                    if encoder_output_shape[0] < encoder_budget:
                        expanded_outputs = []
                        for output in dummy_encoder_outputs:
                            expanded = output.new_zeros(
4237
4238
                                (encoder_budget, encoder_output_shape[-1])
                            )
4239
4240
4241
4242
4243
4244
                            num_tokens = output.shape[0]
                            expanded[:num_tokens].copy_(output)
                            expanded_outputs.append(expanded)

                        dummy_encoder_outputs = expanded_outputs

4245
                    # Cache the dummy encoder outputs.
4246
                    self.encoder_cache["tmp"] = dict(enumerate(dummy_encoder_outputs))
4247

4248
        # Add `is_profile` here to pre-allocate communication buffers
4249
4250
4251
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
4252
        if get_pp_group().is_last_rank:
4253
4254
4255
4256
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
4257
        else:
4258
            output = None
4259
        self._sync_device()
4260
        del hidden_states, output
4261
        self.encoder_cache.clear()
4262
        gc.collect()
4263

4264
    def capture_model(self) -> int:
4265
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
4266
            logger.warning(
4267
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
4268
4269
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
4270
            return 0
4271

4272
4273
        compilation_counter.num_gpu_runner_capture_triggers += 1

4274
4275
        start_time = time.perf_counter()

4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
        @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()
4290
                    gc.collect()
4291

4292
4293
4294
        # 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.
4295
        set_cudagraph_capturing_enabled(True)
4296
        with freeze_gc(), graph_capture(device=self.device):
4297
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
4298
            cudagraph_mode = self.compilation_config.cudagraph_mode
4299
            assert cudagraph_mode is not None
4300
4301
4302
4303
4304
4305
4306
4307
4308

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

4309
4310
            if cudagraph_mode.mixed_mode() != CUDAGraphMode.NONE:
                cudagraph_runtime_mode = cudagraph_mode.mixed_mode()
4311
                # make sure we capture the largest batch size first
4312
4313
4314
                compilation_cases = list(
                    product(reversed(self.cudagraph_batch_sizes), lora_cases)
                )
4315
4316
4317
                self._capture_cudagraphs(
                    compilation_cases,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4318
4319
                    uniform_decode=False,
                )
4320

4321
4322
            # Capture full cudagraph for uniform decode batches if we
            # don't already have full mixed prefill-decode cudagraphs.
4323
4324
4325
4326
4327
4328
4329
            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
                )
4330
                decode_cudagraph_batch_sizes = [
4331
4332
                    x
                    for x in self.cudagraph_batch_sizes
4333
                    if max_num_tokens >= x >= self.uniform_decode_query_len
4334
                ]
4335
4336
4337
                compilation_cases_decode = list(
                    product(reversed(decode_cudagraph_batch_sizes), lora_cases)
                )
4338
4339
4340
                self._capture_cudagraphs(
                    compilation_cases=compilation_cases_decode,
                    cudagraph_runtime_mode=CUDAGraphMode.FULL,
4341
4342
                    uniform_decode=True,
                )
4343

4344
4345
4346
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

4347
4348
4349
        # 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
4350
        # we may do lazy capturing in future that still allows capturing
4351
4352
        # after here.
        set_cudagraph_capturing_enabled(False)
4353
4354
4355
4356
4357

        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.
4358
        logger.info_once(
4359
4360
4361
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
4362
            scope="local",
4363
        )
4364
        return cuda_graph_size
4365

4366
4367
    def _capture_cudagraphs(
        self,
4368
        compilation_cases: list[tuple[int, bool]],
4369
4370
4371
4372
4373
4374
4375
        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}"
4376
4377
4378
4379
4380
4381
4382
4383

        # 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",
4384
4385
4386
                    cudagraph_runtime_mode.name,
                ),
            )
4387

4388
        # We skip EPLB here since we don't want to record dummy metrics
4389
        for num_tokens, activate_lora in compilation_cases:
4390
            # We currently only capture ubatched graphs when its a FULL
4391
4392
4393
            # 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
4394
4395
4396
4397
            allow_microbatching = (
                self.parallel_config.enable_dbo
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
4398
4399
4400
4401
4402
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
4403
            )
4404

4405
4406
4407
4408
4409
4410
            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.
4411
4412
4413
4414
4415
4416
4417
4418
4419
                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,
4420
                    activate_lora=activate_lora,
4421
4422
4423
4424
4425
4426
4427
4428
                )
            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,
4429
                activate_lora=activate_lora,
4430
            )
4431
        self.maybe_remove_all_loras(self.lora_config)
4432

4433
4434
4435
4436
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
4437
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
4438

4439
4440
4441
4442
4443
4444
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
4445
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
4446
            layer_type = cast(type[Any], AttentionLayerBase)
4447
            layers = get_layers_from_vllm_config(
4448
                self.vllm_config, layer_type, kv_cache_group_spec.layer_names
4449
            )
4450
4451
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
4452
            # Dedupe based on full class name; this is a bit safer than
4453
4454
4455
4456
            # 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.
4457
            for layer_name in kv_cache_group_spec.layer_names:
4458
                attn_backend = layers[layer_name].get_attn_backend()
4459
4460
4461
4462

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
4463
                        attn_backend,  # type: ignore[arg-type]
4464
4465
                    )

4466
4467
4468
                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):
4469
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
4470
                key = (full_cls_name, layer_kv_cache_spec)
4471
4472
4473
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
4474
                attn_backend_layers[key].append(layer_name)
4475
4476
4477
4478
            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()),
            )
4479
4480

        def create_attn_groups(
4481
            attn_backends_map: dict[AttentionGroupKey, list[str]],
4482
            kv_cache_group_id: int,
4483
4484
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
4485
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
4486
                attn_group = AttentionGroup(
4487
                    attn_backend,
4488
                    layer_names,
4489
                    kv_cache_spec,
4490
                    kv_cache_group_id,
4491
4492
                )

4493
4494
4495
                attn_groups.append(attn_group)
            return attn_groups

4496
        attention_backend_maps = []
4497
        attention_backend_list = []
4498
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
4499
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
4500
            attention_backend_maps.append(attn_backends[0])
4501
            attention_backend_list.append(attn_backends[1])
4502
4503

        # Resolve cudagraph_mode before actually initialize metadata_builders
4504
4505
4506
        self._check_and_update_cudagraph_mode(
            attention_backend_list, kv_cache_config.kv_cache_groups
        )
4507

4508
4509
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
4510

4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
    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
4529
        # Calculate reorder batch threshold (if needed)
4530
4531
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
4532
4533
        self.calculate_reorder_batch_threshold()

4534
    def _check_and_update_cudagraph_mode(
4535
4536
4537
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
4538
    ) -> None:
4539
        """
4540
        Resolve the cudagraph_mode when there are multiple attention
4541
        groups with potential conflicting CUDA graph support.
4542
4543
4544
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
4545
        min_cg_support = AttentionCGSupport.ALWAYS
4546
        min_cg_backend_name = None
4547

4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
        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__
4560
4561
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
4562
        assert cudagraph_mode is not None
4563
        # check cudagraph for mixed batch is supported
4564
4565
4566
4567
4568
4569
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4570
                f"with {min_cg_backend_name} backend (support: "
4571
4572
                f"{min_cg_support})"
            )
4573
4574
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
4575
4576
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
4577
                    "make sure compilation mode is VLLM_COMPILE"
4578
                )
4579
4580
4581
4582
4583
                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"
4584
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4585
                    CUDAGraphMode.FULL_AND_PIECEWISE
4586
                )
4587
4588
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
4589
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4590
                    CUDAGraphMode.FULL_DECODE_ONLY
4591
                )
4592
4593
            logger.warning(msg)

4594
        # check that if we are doing decode full-cudagraphs it is supported
4595
4596
4597
4598
4599
4600
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4601
                f"with {min_cg_backend_name} backend (support: "
4602
4603
                f"{min_cg_support})"
            )
4604
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
4605
4606
4607
4608
4609
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
4610
                    "attention is compiled piecewise"
4611
4612
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4613
                    CUDAGraphMode.PIECEWISE
4614
                )
4615
            else:
4616
4617
                msg += (
                    "; setting cudagraph_mode=NONE because "
4618
                    "attention is not compiled piecewise"
4619
4620
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4621
                    CUDAGraphMode.NONE
4622
                )
4623
4624
            logger.warning(msg)

4625
4626
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
4627
4628
4629
4630
4631
4632
4633
4634
        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 "
4635
                f"{min_cg_backend_name} (support: {min_cg_support})"
4636
            )
4637
4638
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
4639
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4640
                    CUDAGraphMode.PIECEWISE
4641
                )
4642
4643
            else:
                msg += "; setting cudagraph_mode=NONE"
4644
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4645
                    CUDAGraphMode.NONE
4646
                )
4647
4648
4649
4650
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
4651
4652
4653
4654
4655
4656
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
4657
                f"supported with {min_cg_backend_name} backend ("
4658
4659
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
4660
                "and make sure compilation mode is VLLM_COMPILE"
4661
            )
4662

4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
        # 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
        # Will be removed in the near future when we have seperate cudagraph capture
        # 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
            )
4677
4678
4679
4680
            capture_sizes = self.compilation_config.cudagraph_capture_sizes
            self.cudagraph_batch_sizes = (
                capture_sizes if capture_sizes is not None else []
            )
4681

4682
4683
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
4684
4685
        cudagraph_mode = self.compilation_config.cudagraph_mode
        assert cudagraph_mode is not None
4686
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
4687
            cudagraph_mode, self.uniform_decode_query_len
4688
        )
4689

4690
4691
    def calculate_reorder_batch_threshold(self) -> None:
        """
4692
4693
4694
4695
        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.
4696
        """
4697
4698
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

4699
        reorder_batch_thresholds: list[int | None] = [
4700
4701
4702
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
4703
4704
4705
4706
4707
        # 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
4708
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)  # type: ignore[assignment]
4709

4710
4711
4712
    @staticmethod
    def select_common_block_size(
        kv_manager_block_size: int, attn_groups: list[AttentionGroup]
4713
4714
    ) -> int:
        """
4715
4716
4717
4718
4719
        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.
4720
4721
4722
4723
4724
4725

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

        Returns:
4726
            The selected block size
4727
4728

        Raises:
4729
            ValueError: If no valid block size found
4730
4731
        """

4732
4733
4734
4735
4736
4737
4738
4739
        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
4740
                for supported_size in backend.get_supported_kernel_block_sizes():
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
                    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
4771
            for supported_size in backend.get_supported_kernel_block_sizes()
4772
4773
            if isinstance(supported_size, int)
        )
4774

4775
4776
4777
4778
4779
4780
        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}. ")
4781

4782
4783
4784
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
4785
4786
4787
4788
4789
4790
4791
        """
        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.
4792
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4793
4794
4795
4796
        """
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
4797
            if not isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec)
4798
        ]
4799
4800
4801
4802

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
4803
4804
4805
            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
4806
4807
                "for more details."
            )
4808
4809
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
4810
                max_model_len=max(self.max_model_len, self.max_encoder_len),
4811
4812
4813
4814
4815
                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,
4816
                kernel_block_sizes=kernel_block_sizes,
4817
                is_spec_decode=bool(self.vllm_config.speculative_config),
4818
                logitsprocs=self.input_batch.logitsprocs,
4819
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
4820
                is_pooling_model=self.is_pooling_model,
4821
                num_speculative_tokens=self.num_spec_tokens,
4822
4823
            )

4824
    def _allocate_kv_cache_tensors(
4825
4826
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
4827
        """
4828
4829
4830
        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.

4831
        Args:
4832
            kv_cache_config: The KV cache config
4833
        Returns:
4834
            dict[str, torch.Tensor]: A map between layer names to their
4835
            corresponding memory buffer for KV cache.
4836
        """
4837
4838
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
4839
4840
4841
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
4842
4843
4844
4845
4846
            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:
4847
4848
4849
4850
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
4851
4852
4853
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
4854
4855
        return kv_cache_raw_tensors

4856
4857
4858
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

4859
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
4860
4861
        if not self.kv_cache_config.kv_cache_groups:
            return
4862
4863
        for attn_groups in self.attn_groups:
            yield from attn_groups
4864

4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
    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 = []
4880
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
4881
4882
4883
4884
4885
4886
            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):
4887
                continue
4888
            elif isinstance(kv_cache_spec, AttentionSpec):
4889
4890
4891
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
4892
                attn_groups = self.attn_groups[kv_cache_gid]
4893
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
4894
                selected_kernel_size = self.select_common_block_size(
4895
4896
4897
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
4898
            elif isinstance(kv_cache_spec, MambaSpec):
4899
4900
                # This is likely Mamba or other non-attention cache,
                # no splitting.
4901
                kernel_block_sizes.append(kv_cache_spec.block_size)
4902
4903
4904
4905
4906
4907
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

4908
4909
4910
4911
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
4912
        kernel_block_sizes: list[int],
4913
    ) -> dict[str, torch.Tensor]:
4914
        """
4915
        Reshape the KV cache tensors to the desired shape and dtype.
4916

4917
        Args:
4918
4919
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
4920
                correct size but uninitialized shape.
4921
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4922
        Returns:
4923
            Dict[str, torch.Tensor]: A map between layer names to their
4924
4925
            corresponding memory buffer for KV cache.
        """
4926
        kv_caches: dict[str, torch.Tensor] = {}
4927
        has_attn, has_mamba = False, False
4928
4929
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
4930
            attn_backend = group.backend
4931
4932
4933
4934
            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]
4935
            for layer_name in group.layer_names:
4936
4937
                if layer_name in self.runner_only_attn_layers:
                    continue
4938
4939
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
4940
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
4941
                if isinstance(kv_cache_spec, AttentionSpec):
4942
                    has_attn = True
4943
4944
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
4945
4946
4947
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

4948
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
4949
                        kernel_num_blocks,
4950
                        kernel_block_size,
4951
4952
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
4953
4954
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
4955
                    dtype = kv_cache_spec.dtype
4956
                    try:
4957
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
4958
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
4959
                    except (AttributeError, NotImplementedError):
4960
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
4961
4962
4963
4964
4965
                    # 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.
4966
4967
4968
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
4969
4970
4971
4972
4973
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
4974
4975
4976
4977
4978
4979
                    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
4980
                elif isinstance(kv_cache_spec, MambaSpec):
4981
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
4982
4983
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
4984
                    storage_offset_bytes = 0
4985
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
4986
4987
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
4988
4989
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
4990
                        target_shape = (num_blocks, *shape)
4991
4992
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
4993
                        assert storage_offset_bytes % dtype_size == 0
4994
4995
4996
4997
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
4998
                            storage_offset=storage_offset_bytes // dtype_size,
4999
                        )
Chen Zhang's avatar
Chen Zhang committed
5000
                        state_tensors.append(tensor)
5001
                        storage_offset_bytes += stride[0] * dtype_size
5002
5003

                    kv_caches[layer_name] = state_tensors
5004
                else:
5005
                    raise NotImplementedError
5006
5007

        if has_attn and has_mamba:
5008
            self._update_hybrid_attention_mamba_layout(kv_caches)
5009

5010
5011
        return kv_caches

5012
    def _update_hybrid_attention_mamba_layout(
5013
5014
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
5015
        """
5016
5017
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
5018
5019

        Args:
5020
            kv_caches: The KV cache buffer of each layer.
5021
5022
        """

5023
5024
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5025
            for layer_name in group.layer_names:
5026
                kv_cache = kv_caches[layer_name]
5027
5028
5029
5030
                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 "
5031
                        f"a tensor of shape {kv_cache.shape}"
5032
                    )
5033
                    hidden_size = kv_cache.shape[2:].numel()
5034
5035
5036
5037
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
5038

5039
    def initialize_kv_cache_tensors(
5040
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
5041
    ) -> dict[str, torch.Tensor]:
5042
5043
5044
5045
5046
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
5047
5048
            kernel_block_sizes: The kernel block sizes for each KV cache group.

5049
        Returns:
5050
            Dict[str, torch.Tensor]: A map between layer names to their
5051
5052
            corresponding memory buffer for KV cache.
        """
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076

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

5078
        # Set up cross-layer KV cache sharing
5079
5080
        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)
5081
5082
            kv_caches[layer_name] = kv_caches[target_layer_name]

5083
5084
5085
5086
5087
5088
5089
5090
5091
        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,
        )
5092
5093
5094
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
5095
5096
        self, kv_cache_config: KVCacheConfig
    ) -> None:
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
        """
        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.
5115
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
5116
5117
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
5118
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
5119
5120
                else:
                    break
5121

5122
5123
5124
5125
5126
5127
5128
    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
        """
5129
        kv_cache_config = deepcopy(kv_cache_config)
5130
        self.kv_cache_config = kv_cache_config
5131
        self.may_add_encoder_only_layers_to_kv_cache_config()
5132
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
5133
        self.initialize_attn_backend(kv_cache_config)
5134
5135
5136
5137
5138
5139
        # 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)
5140
5141
5142
5143

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

5144
        # Reinitialize need to after initialize_attn_backend
5145
5146
5147
5148
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
5149

5150
5151
5152
5153
5154
5155
        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
5156
        if has_kv_transfer_group():
5157
            kv_transfer_group = get_kv_transfer_group()
5158
5159
5160
5161
5162
5163
5164
            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)
5165
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
5166

5167
        if self.dcp_world_size > 1:
5168
5169
            layer_type = cast(type[Any], AttentionLayerBase)
            layers = get_layers_from_vllm_config(self.vllm_config, layer_type)
5170
            for layer in layers.values():
5171
5172
5173
5174
                layer_impl = getattr(layer, "impl", None)
                if layer_impl is None:
                    continue
                assert layer_impl.need_to_return_lse_for_decode, (
5175
5176
                    "DCP requires attention impls to return"
                    " the softmax lse for decode, but the impl "
5177
                    f"{layer_impl.__class__.__name__} "
5178
5179
                    "does not return the softmax lse for decode."
                )
5180

5181
5182
5183
5184
5185
    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
5186
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
5187
5188
5189
        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:
5190
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
5191
5192
5193
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
5194
5195
                    dtype=self.kv_cache_dtype,
                )
5196
5197
5198
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
5199
5200
5201
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
5202
5203
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
5204
5205
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
5206

5207
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
5208
        """
5209
        Generates the KVCacheSpec by parsing the kv cache format from each
5210
5211
        Attention module in the static forward context.
        Returns:
5212
            KVCacheSpec: A dictionary mapping layer names to their KV cache
5213
5214
            format. Layers that do not need KV cache are not included.
        """
5215
5216
        if has_ec_transfer() and get_ec_transfer().is_producer:
            return {}
5217
        kv_cache_spec: dict[str, KVCacheSpec] = {}
5218
5219
        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
5220
        for layer_name, attn_module in attn_layers.items():
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
            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
5236

5237
        return kv_cache_spec
5238

5239
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
5240
5241
5242
5243
5244
5245
5246
5247
        # 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.
5248
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
5249
5250
5251
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
5252
        return pinned.tolist()