gpu_model_runner.py 227 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
        self.encoder_seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
479
480
481
482
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
483
484
485
        # 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.
486
487
488
489
490
491
492
        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
        )
493
494
        self.num_discarded_requests = 0

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

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

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

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

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

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

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

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

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

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

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

567
        self.reorder_batch_threshold: int | None = None
568

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

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

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

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

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

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

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

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

634
        if not self.is_pooling_model:
635
636
            return model_kwargs

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

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

        if len(token_type_id_requests) == 0:
            return model_kwargs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

797
            reqs_to_add.append(req_state)
798

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

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

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

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

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

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

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

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

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

893
                reqs_to_add.append(req_state)
894
895
896
                continue

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

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

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

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

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

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

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

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

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

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

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

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

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

1050
        return mm_kwargs_combined
1051

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

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

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

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

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

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

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

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

        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
1215
        for req_id in num_scheduled_tokens:
1216
            req_index = self.input_batch.req_id_to_index[req_id]
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
            req_state = self.requests[req_id]
            if req_state.mm_features is None:
                self.encoder_seq_lens.np[req_index] = 0
                continue

            # Get the total number of encoder input tokens for running encoder requests
            # whether encoding is finished or not so that cross-attention knows how
            # many encoder tokens to attend to.
            encoder_input_tokens = sum(
                feature.mm_position.length for feature in req_state.mm_features
            )
            self.encoder_seq_lens.np[req_index] = encoder_input_tokens

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

1234
        return encoder_seq_lens, encoder_seq_lens_cpu
1235

1236
    def _prepare_inputs(
1237
1238
1239
1240
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
        max_num_scheduled_tokens: int,
1241
1242
    ) -> tuple[
        torch.Tensor,
1243
1244
1245
        SpecDecodeMetadata | None,
        UBatchSlices | None,
        torch.Tensor | None,
1246
    ]:
1247
1248
        """
        :return: tuple[
1249
            logits_indices, spec_decode_metadata,
1250
            ubatch_slices, num_tokens_across_dp,
1251
1252
        ]
        """
1253
1254
1255
1256
1257
1258
1259
        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.
1260
        self.input_batch.block_table.commit_block_table(num_reqs)
1261
1262
1263

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

1266
1267
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1268
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1269
1270

        # Get positions.
1271
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1272
1273
1274
1275
1276
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1277

1278
1279
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1280
        if self.uses_mrope:
1281
1282
            self._calc_mrope_positions(scheduler_output)

1283
1284
1285
1286
1287
        # 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)

1288
1289
1290
1291
        # 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.
1292
1293
1294
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1295
        token_indices_tensor = torch.from_numpy(token_indices)
1296

1297
1298
1299
        # 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.
1300
1301
1302
1303
1304
1305
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1306
        if self.enable_prompt_embeds:
1307
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1308
1309
1310
1311
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1312
1313
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346

        # 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:
1347
1348
1349
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1350
1351

                output_idx += num_sched
1352

1353
1354
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1355
1356

        # Prepare the attention metadata.
1357
        self.query_start_loc.np[0] = 0
1358
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1359
1360
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1361
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1362
        self.query_start_loc.copy_to_gpu()
1363
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1364

1365
        num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
1366
        num_tokens_padded = self._get_num_input_tokens(num_tokens_unpadded)
1367
1368
1369
        uniform_decode = (
            max_num_scheduled_tokens == self.uniform_decode_query_len
        ) and (total_num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
1370
1371
1372
1373
1374
1375
1376

        # 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

1377
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
1378
1379
1380
1381
1382
1383
1384
            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,
1385
        )
1386

1387
        self.seq_lens.np[:num_reqs] = (
1388
1389
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1390
        # Fill unused with 0 for full cuda graph mode.
1391
1392
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
1393

1394
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1395
1396
1397
1398
1399
1400
1401
        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)
1402
1403
1404
        self.discard_request_indices.np[: self.num_discarded_requests] = (
            discard_request_indices
        )
1405
1406
1407

        self.discard_request_indices.copy_to_gpu(self.num_discarded_requests)

1408
        # Copy the tensors to the GPU.
1409
1410
1411
1412
1413
        self._prepare_input_ids(
            scheduler_output,
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
1414

1415
        if self.uses_mrope:
1416
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1417
1418
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1419
1420
                non_blocking=True,
            )
1421
1422
1423
1424
1425
1426
        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,
            )
1427
1428
        else:
            # Common case (1D positions)
1429
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1430

1431
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
1432
1433
1434
1435
1436
1437
1438
        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
1439
            num_draft_tokens = None
1440
            spec_decode_metadata = None
1441
            num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
1442
1443
1444
1445
1446
        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)
1447
1448
1449
            # 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)
1450
1451
1452
1453
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
1454
1455
                req_idx = self.input_batch.req_id_to_index[req_id]
                num_draft_tokens[req_idx] = len(draft_token_ids)
1456
1457
1458
1459
1460
1461
1462
1463
                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
                )
1464
            spec_decode_metadata = self._calc_spec_decode_metadata(
1465
1466
                num_draft_tokens, cu_num_tokens
            )
1467
            logits_indices = spec_decode_metadata.logits_indices
1468
            num_sampled_tokens = num_draft_tokens + 1
1469
            # For DECODE only cuda graph of some attention backends (e.g., GDN).
1470
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
1471
1472
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
1473

1474
1475
1476
1477
1478
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
1479
            )
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
            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,
1500
        num_scheduled_tokens: dict[str, int] | None = None,
1501
1502
1503
1504
1505
1506
        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
1507
        num_logits_indices = None
1508
1509
1510
1511
1512
1513
        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
                )
1514

1515
1516
1517
1518
1519
1520
        # 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,
1521
                self.parallel_config.cp_kv_cache_interleave_size,
1522
1523
1524
            )
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs)

1525
1526
1527
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1528

1529
1530
        # Used in the below loop
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1531
        query_start_loc_cpu = self.query_start_loc.cpu[: num_reqs + 1]
1532
        seq_lens = self.seq_lens.gpu[:num_reqs]
1533
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs]
1534
1535
1536
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs
        ]
1537
1538
1539
1540
1541
1542

        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]

1543
        spec_decode_common_attn_metadata = None
1544
1545
1546
1547
1548
1549
1550
1551
1552

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

1553
1554
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1555
1556
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1557
1558
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1559

1560
1561
        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
1562
        for kv_cache_gid, kv_cache_group in enumerate(
1563
1564
            self.kv_cache_config.kv_cache_groups
        ):
1565
1566
            encoder_seq_lens, encoder_seq_lens_cpu = self._get_encoder_seq_lens(
                num_scheduled_tokens or {},
1567
1568
                kv_cache_group.kv_cache_spec,
                num_reqs,
1569
            )
1570

1571
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
1572
1573
1574
1575
1576
                # 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,
1577
1578
1579
                    device=self.device,
                )
                slot_mapping = torch.zeros(
1580
                    (total_num_scheduled_tokens,),
1581
1582
1583
                    dtype=torch.int64,
                    device=self.device,
                )
1584
            else:
1585
                blk_table = self.input_batch.block_table[kv_cache_gid]
1586
                blk_table_tensor = blk_table.get_device_tensor(num_reqs)
1587
                slot_mapping = blk_table.slot_mapping.gpu[:total_num_scheduled_tokens]
1588
1589
1590

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

1593
            common_attn_metadata = CommonAttentionMetadata(
1594
1595
1596
1597
1598
                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,
1599
1600
1601
                num_reqs=num_reqs,
                num_actual_tokens=total_num_scheduled_tokens,
                max_query_len=max_num_scheduled_tokens,
1602
                max_seq_len=max_seq_len,
1603
1604
                block_table_tensor=blk_table_tensor,
                slot_mapping=slot_mapping,
1605
                logits_indices_padded=logits_indices_padded,
1606
                num_logits_indices=num_logits_indices,
1607
                causal=True,
1608
                encoder_seq_lens=encoder_seq_lens,
1609
                encoder_seq_lens_cpu=encoder_seq_lens_cpu,
1610
                dcp_local_seq_lens=dcp_local_seq_lens,
1611
                dcp_local_seq_lens_cpu=dcp_local_seq_lens_cpu,
1612
1613
            )

1614
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1615
                if isinstance(self.drafter, EagleProposer):
1616
                    if self.drafter.attn_layer_names[0] in kv_cache_group.layer_names:
1617
1618
1619
                        spec_decode_common_attn_metadata = common_attn_metadata
                else:
                    spec_decode_common_attn_metadata = common_attn_metadata
1620

1621
1622
1623
1624
1625
1626
            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
                )
1627
                builder = attn_group.get_metadata_builder()
1628

1629
                extra_attn_metadata_args = {}
1630
                if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
1631
                    extra_attn_metadata_args = dict(
1632
1633
1634
1635
                        num_accepted_tokens=self.num_accepted_tokens.gpu[:num_reqs],
                        num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
                            :num_reqs
                        ],
1636
1637
                    )

1638
1639
                if ubatch_slices is not None:
                    common_attn_metadata_list = split_attn_metadata(
1640
1641
                        ubatch_slices, common_attn_metadata
                    )
1642
                    for ubid, common_attn_metadata in enumerate(
1643
1644
                        common_attn_metadata_list
                    ):
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
                        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:
1656
1657
1658
1659
                            assert type(attn_metadata) is list
                            attn_metadata[ubid][layer_name] = attn_metadata_i
                else:
                    assert isinstance(attn_metadata, dict)
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
                    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,
                        )
1670
1671
                    for layer_name in attn_group.layer_names:
                        attn_metadata[layer_name] = attn_metadata_i
1672

1673
        return attn_metadata, spec_decode_common_attn_metadata
1674

1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
    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
        """
1685

1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
        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
1708

1709
1710
1711
1712
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
        num_common_prefix_blocks: int,
1713
1714
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
    ) -> 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.
        """
1733

1734
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
        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]
1772
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
1773
1774
1775
1776
1777
1778
1779
        # 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(
1780
1781
            common_prefix_len, self.input_batch.num_computed_tokens_cpu[:num_reqs].min()
        )
1782
        # common_prefix_len should be a multiple of the block size.
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
        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
        )
1794
1795
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
1796
1797
1798
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
1799
            num_kv_heads=kv_cache_spec.num_kv_heads,
1800
            use_alibi=self.use_alibi,
1801
            use_sliding_window=use_sliding_window,
1802
            use_local_attention=use_local_attention,
1803
            num_sms=self.num_sms,
1804
            dcp_world_size=self.dcp_world_size,
1805
1806
1807
        )
        return common_prefix_len if use_cascade else 0

1808
1809
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
1810
        for index, req_id in enumerate(self.input_batch.req_ids):
1811
1812
1813
            req = self.requests[req_id]
            assert req.mrope_positions is not None

1814
1815
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1816
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
1817
1818
                req.prompt_token_ids, req.prompt_embeds
            )
1819
1820

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
1821
1822
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
            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

1836
1837
1838
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
1839
1840
1841
1842
1843
1844
1845
                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

1846
                assert req.mrope_position_delta is not None
1847
                MRotaryEmbedding.get_next_input_positions_tensor(
1848
                    out=self.mrope_positions.np,
1849
1850
1851
1852
1853
                    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,
                )
1854
1855
1856

                mrope_pos_ptr += completion_part_len

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
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
    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

1904
1905
    def _calc_spec_decode_metadata(
        self,
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
        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
1922
1923
1924
1925

        # 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(
1926
1927
            num_sampled_tokens, cumsum_dtype=np.int32
        )
1928
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
1929
        logits_indices = np.repeat(
1930
1931
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
1932
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
1933
1934
1935
1936
1937
1938
        logits_indices += arange

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

        # Compute the draft logits indices.
1939
1940
1941
        # 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(
1942
1943
            num_draft_tokens, cumsum_dtype=np.int32
        )
1944
1945
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
1946
1947
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
1948
1949
1950
1951
1952
        # [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(
1953
1954
            self.device, non_blocking=True
        )
1955
1956
1957
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
1958
1959
1960
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
1961
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
1962
1963
            self.device, non_blocking=True
        )
1964
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
1965
1966
            self.device, non_blocking=True
        )
1967

1968
1969
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
1970
        draft_token_ids = self.input_ids.gpu[logits_indices]
1971
1972
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

1973
        return SpecDecodeMetadata(
1974
1975
1976
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
1977
            cu_num_sampled_tokens=cu_num_sampled_tokens,
1978
1979
1980
1981
1982
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

1983
1984
1985
1986
1987
1988
1989
    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
1990
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
1991
1992
1993
1994
1995
        # 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_(
1996
1997
1998
1999
2000
2001
            logits_indices[-1].item()
        )
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and num_logits <= self.cudagraph_batch_sizes[-1]
        ):
2002
2003
2004
2005
2006
            # 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
2007
2008
2009
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
2010
2011
        return logits_indices_padded

2012
2013
2014
2015
2016
2017
2018
2019
    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
2020
                inputs.
2021
2022
2023
2024
2025
2026

        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
        """
2027
2028
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
2029
            return [], []
2030
        # Batch the multi-modal inputs.
2031
        mm_kwargs = list[MultiModalKwargsItem]()
2032
2033
        # list of tuple (mm_hash, position_info)
        mm_hashes_pos = list[tuple[str, PlaceholderRange]]()
2034
2035
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
2036
2037

            for mm_input_id in encoder_input_ids:
2038
                mm_feature = req_state.mm_features[mm_input_id]
2039
2040
                if mm_feature.data is None:
                    continue
2041
2042
2043
                mm_hash = mm_feature.identifier
                mm_kwargs.append(mm_feature.data)
                mm_hashes_pos.append((mm_hash, mm_feature.mm_position))
2044

2045
2046
        return mm_kwargs, mm_hashes_pos

2047
2048
2049
    def _execute_mm_encoder(
        self, scheduler_output: "SchedulerOutput"
    ) -> list[torch.Tensor]:
2050
2051
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, mm_hashes_pos = self._batch_mm_kwargs_from_scheduler(
2052
2053
            scheduler_output
        )
2054
2055

        if not mm_kwargs:
2056
            return []
2057

2058
2059
2060
2061
2062
2063
2064
        # 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.
2065
        model = cast(SupportsMultiModal, self.model)
2066
        encoder_outputs: list[torch.Tensor] = []
2067
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
2068
2069
2070
2071
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
2072
            multimodal_cpu_fields=model.multimodal_cpu_fields,
2073
        ):
2074
            curr_group_outputs: list[torch.Tensor] = []
2075
2076

            # EVS-related change.
2077
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
2078
            # processing multimodal data. This solves the issue with scheduler
2079
2080
2081
2082
            # 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)
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
            # 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,
2099
                            multimodal_cpu_fields=model.multimodal_cpu_fields,
2100
                        )
2101
                    )
2102

2103
                    micro_batch_outputs = model.embed_multimodal(
2104
2105
                        **micro_batch_mm_inputs
                    )
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115

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

2118
2119
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
2120
                expected_num_items=num_items,
2121
            )
2122
            encoder_outputs.extend(curr_group_outputs)
2123

2124
2125
2126
        # 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(
2127
2128
2129
                output,
                is_embed=pos_info.is_embed,
            )
2130
2131
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
2132

2133
2134
        return encoder_outputs

2135
    def _gather_mm_embeddings(
2136
2137
        self,
        scheduler_output: "SchedulerOutput",
2138
        shift_computed_tokens: int = 0,
2139
2140
2141
2142
2143
2144
2145
2146
    ) -> 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
2147
        should_sync_mrope_positions = False
2148
        should_sync_xdrope_positions = False
2149

2150
        for req_id in self.input_batch.req_ids:
2151
2152
            mm_embeds_req: list[torch.Tensor] = []

2153
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2154
            req_state = self.requests[req_id]
2155
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2156

2157
2158
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2159
2160
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176

                # 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,
2177
2178
                    num_encoder_tokens,
                )
2179
                assert start_idx < end_idx
2180

2181
                mm_hash = mm_feature.identifier
2182
                encoder_output = self.encoder_cache.get(mm_hash, None)
2183
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2184
2185
2186
2187

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

2188
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2189
2190
2191
                is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                    True if is_embed is None else is_embed
                )
2192

2193
2194
2195
2196
                mm_embeds_item = gather_mm_placeholders(
                    encoder_output[start_idx:end_idx],
                    is_embed=is_embed,
                )
2197
2198
2199
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2200
                assert req_state.mrope_positions is not None
2201
2202
2203
2204
2205
2206
2207
                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,
2208
2209
                    )
                )
2210
2211
2212
2213
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
2214
2215
2216
            req_start_idx += num_scheduled_tokens

        is_mm_embed = self.is_mm_embed.copy_to_gpu(total_num_scheduled_tokens)
2217
2218
2219

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
2220
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
2221

2222
2223
2224
2225
        if should_sync_xdrope_positions:
            self._calc_xdrope_positions(scheduler_output)
            self.xdrope_positions.copy_to_gpu(total_num_scheduled_tokens)

2226
        return mm_embeds, is_mm_embed
2227

2228
    def get_model(self) -> nn.Module:
2229
        # get raw model out of the cudagraph wrapper.
2230
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
2231
            return self.model.unwrap()
2232
2233
        return self.model

2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
    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

2249
2250
2251
2252
2253
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

2254
2255
        supported_tasks = list(model.pooler.get_supported_tasks())

2256
        if self.scheduler_config.enable_chunked_prefill:
2257
2258
2259
2260
            if "token_embed" in supported_tasks:
                supported_tasks.remove("token_embed")
            if "token_classify" in supported_tasks:
                supported_tasks.remove("token_classify")
2261

2262
2263
            logger.debug_once(
                "Chunked prefill is not supported with "
2264
2265
                "token_embed and token_classify tasks "
                "which using ALL pooling. "
2266
2267
2268
                "Please turn off chunked prefill by "
                "`--no-enable-chunked-prefill` before using it."
            )
2269
2270
2271
2272
2273

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

        return supported_tasks
2277

2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
    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)

2288
    def sync_and_slice_intermediate_tensors(
2289
2290
        self,
        num_tokens: int,
2291
        intermediate_tensors: IntermediateTensors | None,
2292
2293
        sync_self: bool,
    ) -> IntermediateTensors:
2294
2295
2296
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
2297
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
2298
2299
2300
2301
2302
2303

        # 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():
2304
                is_scattered = k == "residual" and is_rs
2305
                copy_len = num_tokens // tp if is_scattered else num_tokens
2306
                self.intermediate_tensors[k][:copy_len].copy_(
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
                    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:
2320
2321
2322
2323
2324
2325
2326
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2327
2328
        model = self.get_model()
        assert is_mixture_of_experts(model)
2329
2330
2331
        self.eplb_state.step(
            is_dummy,
            is_profile,
2332
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2333
2334
        )

2335
2336
2337
2338
    # 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)
2339
2340
    @staticmethod
    def pad_out_ubatch_slice(ubatch_slices: UBatchSlices, num_total_tokens: int):
2341
2342
2343
2344
2345
2346
        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
        )
2347

2348
2349
2350
2351
2352
2353
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
    ) -> ModelRunnerOutput:
2354
2355
2356
        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"
        )
2357

2358
        hidden_states = hidden_states[:num_scheduled_tokens]
2359
        pooling_metadata = self.input_batch.get_pooling_metadata()
2360
2361
2362
2363
        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]
2364

2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
        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()
2375

2376
        pooler_output: list[torch.Tensor | None] = []
2377
        for raw_output, seq_len, prompt_len in zip(
2378
2379
            raw_pooler_output, seq_lens_cpu, pooling_metadata.prompt_lens
        ):
2380
            output = raw_output if seq_len == prompt_len else None
2381
            pooler_output.append(output)
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391

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

2392
    def _get_num_input_tokens(self, num_scheduled_tokens: int) -> int:
2393
2394
2395
2396
2397
2398
        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]
        ):
2399
2400
2401
2402
2403
2404
2405
2406
            # 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
2407
2408
2409
2410
        if (
            self.compilation_config.pass_config.enable_sequence_parallelism
            and tp_size > 1
        ):
2411
2412
2413
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

2414
    def _preprocess(
2415
2416
        self,
        scheduler_output: "SchedulerOutput",
2417
        num_input_tokens: int,  # Padded
2418
        intermediate_tensors: IntermediateTensors | None = None,
2419
    ) -> tuple[
2420
2421
        torch.Tensor | None,
        torch.Tensor | None,
2422
        torch.Tensor,
2423
        IntermediateTensors | None,
2424
        dict[str, Any],
2425
        ECConnectorOutput | None,
2426
    ]:
2427
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2428
        is_first_rank = get_pp_group().is_first_rank
2429

2430
2431
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
2432
2433
        ec_connector_output = None

2434
2435
        if (
            self.supports_mm_inputs
2436
            and is_first_rank
2437
2438
            and not self.model_config.is_encoder_decoder
        ):
2439
            # Run the multimodal encoder if any.
2440
2441
2442
2443
2444
2445
            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)
2446

2447
2448
2449
            # 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.
2450
            inputs_embeds_scheduled = self.model.embed_input_ids(
2451
2452
2453
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2454
            )
2455

2456
            # TODO(woosuk): Avoid the copy. Optimize.
2457
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2458

2459
            input_ids = None
2460
            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
2461
2462
2463
2464
            model_kwargs = {
                **self._init_model_kwargs(num_scheduled_tokens),
                **self._extract_mm_kwargs(scheduler_output),
            }
2465
        elif self.enable_prompt_embeds and is_first_rank:
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
            # 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).
2478
2479
2480
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
2481
                .squeeze(1)
2482
            )
2483
2484
2485
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
2486
                tokens_to_embeds = self.model.embed_input_ids(input_ids=token_ids)
2487
2488
2489
2490
2491
                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
2492
        else:
2493
2494
2495
2496
            # 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.
2497
            input_ids = self.input_ids.gpu[:num_input_tokens]
2498
            inputs_embeds = None
2499
            model_kwargs = self._init_model_kwargs(num_input_tokens)
2500

2501
        if self.uses_mrope:
2502
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2503
2504
        elif self.uses_xdrope_dim > 0:
            positions = self.xdrope_positions.gpu[:, :num_input_tokens]
2505
        else:
2506
            positions = self.positions.gpu[:num_input_tokens]
2507

2508
        if is_first_rank:
2509
2510
            intermediate_tensors = None
        else:
2511
            assert intermediate_tensors is not None
2512
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2513
2514
                num_input_tokens, intermediate_tensors, True
            )
2515

2516
2517
2518
2519
        if (
            self.model_config.is_encoder_decoder
            and scheduler_output.scheduled_encoder_inputs
        ):
2520
2521
2522
2523
2524
2525
2526
            # 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})
2527

2528
2529
2530
2531
2532
2533
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
2534
            ec_connector_output,
2535
        )
2536

2537
    def _sample(
2538
        self,
2539
2540
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2541
    ) -> SamplerOutput:
2542
        # Sample the next token and get logprobs if needed.
2543
        sampling_metadata = self.input_batch.sampling_metadata
2544
        if spec_decode_metadata is None:
2545
2546
2547
            # 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()
2548
            return self.sampler(
2549
2550
2551
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
2552

2553
        sampler_output = self.rejection_sampler(
2554
2555
            spec_decode_metadata,
            None,  # draft_probs
2556
            logits,
2557
2558
            sampling_metadata,
        )
2559
        self._update_states_after_model_execute(sampler_output.sampled_token_ids)
2560
2561
2562
        return sampler_output

    def _bookkeeping_sync(
2563
2564
2565
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
2566
        logits: torch.Tensor | None,
2567
2568
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
2569
        spec_decode_metadata: SpecDecodeMetadata | None,
2570
    ) -> tuple[
2571
        dict[str, int],
2572
        LogprobsLists | None,
2573
        list[list[int]],
2574
        dict[str, LogprobsTensors | None],
2575
2576
2577
        list[str],
        dict[str, int],
        list[int],
2578
    ]:
2579
2580
2581
2582
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

2583
2584
2585
        discard_sampled_tokens_req_indices = self.discard_request_indices.np[
            : self.num_discarded_requests
        ]
2586
2587
2588
2589
        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)
2590

2591
2592
2593
        # 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()
2594
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2595
2596

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2597
        sampled_token_ids = sampler_output.sampled_token_ids
2598
        logprobs_tensors = sampler_output.logprobs_tensors
2599
        invalid_req_indices = []
2600
        cu_num_new_tokens: list[int] | None = None
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
        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,
                )
2613
2614
2615
2616
2617
2618
                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))
2619
2620
            # Mask out the sampled tokens that should not be sampled.
            for i in discard_sampled_tokens_req_indices:
2621
                valid_sampled_token_ids[int(i)].clear()
2622
        else:
2623
            valid_sampled_token_ids = []
2624
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2625
2626
2627
2628
2629
            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.
2630
2631
2632
2633
            # 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
2634
2635
2636
2637
2638
            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
            }
2639

2640
2641
2642
2643
2644
        # 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.
2645
        req_ids = self.input_batch.req_ids
2646
2647
        for req_idx in range(num_sampled_tokens):
            if self.use_async_scheduling:
2648
                sampled_ids = [-1] if req_idx not in invalid_req_indices_set else None
2649
2650
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
2651

2652
            num_sampled_ids: int = len(sampled_ids) if sampled_ids else 0
2653

2654
            if not sampled_ids:
2655
2656
2657
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
2658
            end_idx = start_idx + num_sampled_ids
2659
2660
2661
2662
            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}"
2663
            )
2664

2665
2666
            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
2667
2668
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
            self.input_batch.num_tokens[req_idx] = end_idx
2669

2670
            req_id = req_ids[req_idx]
2671
2672
2673
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

2674
        logprobs_lists = (
2675
            logprobs_tensors.tolists(cu_num_new_tokens)
2676
            if not self.use_async_scheduling and logprobs_tensors is not None
2677
2678
2679
2680
2681
2682
2683
2684
2685
            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,
        )

2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
        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,
        )

2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
    @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()

2711
2712
    def _model_forward(
        self,
2713
2714
2715
2716
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
2717
2718
2719
2720
2721
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
2722
        Motivation: We can inspect only this method versus
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
        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,
        )

2743
2744
2745
2746
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
2747
        intermediate_tensors: IntermediateTensors | None = None,
2748
2749
2750
2751
2752
2753
    ) -> 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."
            )
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768

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

2769
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2770
        with record_function_or_nullcontext("gpu_model_runner: preprocess"):
2771
2772
2773
2774
            with self.synchronize_input_prep():
                # Update persistent batch states.
                self._update_states(scheduler_output)

2775
2776
2777
2778
2779
2780
2781
2782
                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)

2783
                if not num_scheduled_tokens:
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
                    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)
2796
2797
2798
2799
                    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(
2800
2801
                        scheduler_output, self.vllm_config
                    )
2802
                if self.cache_config.kv_sharing_fast_prefill:
2803
                    assert not self.num_prompt_logprobs, (
2804
2805
                        "--kv-sharing-fast-prefill produces incorrect "
                        "logprobs for prompt tokens, tokens, please disable "
2806
2807
                        "it when the requests need prompt logprobs"
                    )
2808

2809
2810
2811
2812
2813
2814
                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())

2815
2816
2817
2818
                (
                    logits_indices,
                    spec_decode_metadata,
                    ubatch_slices,
2819
                    num_tokens_across_dp,
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
                ) = 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,
2847
                        num_scheduled_tokens=scheduler_output.num_scheduled_tokens,
2848
2849
2850
                        cascade_attn_prefix_lens=cascade_attn_prefix_lens,
                    )
                )
2851

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
                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
                    )
2863

2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
                (
                    input_ids,
                    inputs_embeds,
                    positions,
                    intermediate_tensors,
                    model_kwargs,
                    ec_connector_output,
                ) = self._preprocess(
                    scheduler_output, num_input_tokens, intermediate_tensors
                )
2874

2875
2876
2877
            uniform_decode = (
                max_num_scheduled_tokens == self.uniform_decode_query_len
            ) and (num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
2878
            batch_desc = BatchDescriptor(
2879
2880
2881
                num_tokens=num_input_tokens,
                uniform_decode=uniform_decode,
                has_lora=len(self.input_batch.lora_id_to_lora_request) > 0,
2882
2883
            )
            cudagraph_runtime_mode, batch_descriptor = (
2884
                self.cudagraph_dispatcher.dispatch(
2885
                    batch_desc,
2886
2887
                    use_cascade_attn=cascade_attn_prefix_lens is not None,
                )
2888
            )
2889

2890
        # Set cudagraph mode to none if calc_kv_scales is true.
2891
2892
2893
2894
2895
2896
        # 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
2897

2898
2899
        # Run the model.
        # Use persistent buffers for CUDA graphs.
2900
2901
        with (
            set_forward_context(
2902
2903
2904
2905
2906
2907
                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,
2908
                ubatch_slices=ubatch_slices,
2909
            ),
2910
            record_function_or_nullcontext("gpu_model_runner: forward"),
2911
2912
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
2913
            model_output = self._model_forward(
2914
2915
2916
2917
2918
2919
2920
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

2921
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
2922
            if self.use_aux_hidden_state_outputs:
2923
                # True when EAGLE 3 is used.
2924
2925
                hidden_states, aux_hidden_states = model_output
            else:
2926
                # Common case.
2927
2928
2929
                hidden_states = model_output
                aux_hidden_states = None

2930
2931
2932
2933
2934
            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)
2935
                    hidden_states.kv_connector_output = kv_connector_output
2936
                    self.kv_connector_output = kv_connector_output
2937
                    return hidden_states
2938

2939
                if self.is_pooling_model:
2940
                    # Return the pooling output.
2941
2942
2943
                    output = self._pool(
                        hidden_states, num_scheduled_tokens, num_scheduled_tokens_np
                    )
2944
2945
                    output.kv_connector_output = kv_connector_output
                    return output
2946
2947

                sample_hidden_states = hidden_states[logits_indices]
2948
                logits = self.model.compute_logits(sample_hidden_states)
2949
2950
2951
2952
            else:
                # Rare case.
                assert not self.is_pooling_model

2953
                sample_hidden_states = hidden_states[logits_indices]
2954
                if not get_pp_group().is_last_rank:
2955
                    all_gather_tensors = {
2956
2957
2958
                        "residual": not is_residual_scattered_for_sp(
                            self.vllm_config, num_input_tokens
                        )
2959
                    }
2960
                    get_pp_group().send_tensor_dict(
2961
2962
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
2963
2964
                        all_gather_tensors=all_gather_tensors,
                    )
2965
2966
                    logits = None
                else:
2967
                    logits = self.model.compute_logits(sample_hidden_states)
2968

2969
                model_output_broadcast_data: dict[str, Any] = {}
2970
2971
2972
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

2973
                broadcasted = get_pp_group().broadcast_tensor_dict(
2974
2975
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
2976
2977
                assert broadcasted is not None
                logits = broadcasted["logits"]
2978

2979
2980
2981
2982
2983
2984
2985
2986
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
2987
            ec_connector_output,
2988
        )
2989
        self.kv_connector_output = kv_connector_output
2990
2991
2992
2993
2994
2995
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
2996
2997
2998
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

2999
3000
        if self.execute_model_state is None:
            # Nothing to do (PP non-final rank case), output isn't used.
3001
            if not kv_connector_output:
3002
                return None  # type: ignore[return-value]
3003
3004
3005
3006
3007
3008
3009
3010
3011

            # 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
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3022
            ec_connector_output,
3023
3024
3025
3026
3027
3028
3029
3030
3031
        ) = 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
            )
3032

3033
        with record_function_or_nullcontext("gpu_model_runner: sample"):
3034
3035
            sampler_output = self._sample(logits, spec_decode_metadata)

3036
3037
        self.input_batch.prev_sampled_token_ids = None

3038
        def propose_draft_token_ids(sampled_token_ids):
3039
            assert spec_decode_common_attn_metadata is not None
3040
            with record_function_or_nullcontext("gpu_model_runner: draft"):
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
                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,
                )

3052
        spec_config = self.speculative_config
3053
        use_padded_batch_for_eagle = (
3054
3055
3056
            spec_config is not None
            and spec_config.use_eagle()
            and not spec_config.disable_padded_drafter_batch
3057
        )
3058
3059
3060
        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
3061
        if (
3062
3063
3064
            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
3065
        ):
3066
            effective_drafter_max_model_len = (
3067
                spec_config.draft_model_config.max_model_len
3068
            )
3069
        input_fits_in_drafter = spec_decode_common_attn_metadata and (
3070
            spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
3071
3072
            <= effective_drafter_max_model_len
        )
3073
        if use_padded_batch_for_eagle:
3074
3075
            assert self.speculative_config is not None
            assert isinstance(self.drafter, EagleProposer)
3076
3077
3078
3079
3080
3081
            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:
3082
                assert spec_decode_common_attn_metadata is not None
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
                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
                )
3096

3097
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
3098
3099
3100
3101
3102
3103
3104
3105
            (
                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,
3106
3107
3108
3109
3110
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
3111
                scheduler_output.total_num_scheduled_tokens,
3112
                spec_decode_metadata,
3113
            )
3114

3115
3116
3117
3118
3119
        if (
            self.speculative_config
            and not use_padded_batch_for_eagle
            and input_fits_in_drafter
        ):
3120
3121
3122
            # 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)
3123

3124
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
3125
            self.eplb_step()
3126
3127
3128
3129
3130
3131
3132
3133
3134
        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,
3135
3136
3137
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
3138
3139
                num_nans_in_logits=num_nans_in_logits,
            )
3140

3141
3142
        if not self.use_async_scheduling:
            return output
3143
3144
3145
3146
3147
3148
3149
3150
3151
        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,
3152
                vocab_size=self.input_batch.vocab_size,
3153
3154
3155
3156
3157
            )
        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
3158
            # any requests with sampling params that require output ids.
3159
3160
3161
3162
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
3163
3164
3165

        return async_output

3166
    def take_draft_token_ids(self) -> DraftTokenIds | None:
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
        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)

3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
    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()

3208
3209
3210
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
3211
        sampled_token_ids: torch.Tensor | list[list[int]],
3212
3213
3214
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
3215
3216
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3217
        common_attn_metadata: CommonAttentionMetadata,
3218
    ) -> list[list[int]] | torch.Tensor:
3219
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3220
3221
3222
        spec_config = self.speculative_config
        assert spec_config is not None
        if spec_config.method == "ngram":
3223
            assert isinstance(sampled_token_ids, list)
3224
            assert isinstance(self.drafter, NgramProposer)
3225
            draft_token_ids = self.drafter.propose(
3226
3227
                sampled_token_ids,
                self.input_batch.req_ids,
3228
3229
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
3230
3231
                self.input_batch.spec_decode_unsupported_reqs,
            )
3232
        elif spec_config.method == "suffix":
3233
3234
3235
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
            draft_token_ids = self.drafter.propose(self.input_batch, sampled_token_ids)
3236
        elif spec_config.method == "medusa":
3237
            assert isinstance(sampled_token_ids, list)
3238
            assert isinstance(self.drafter, MedusaProposer)
3239

3240
3241
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
3242
3243
3244
3245
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
3246
3247
3248
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
3249
                for num_draft, tokens in zip(
3250
3251
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
3252
                    indices.append(offset + len(tokens) - 1)
3253
                    offset += num_draft + 1
3254
                indices = torch.tensor(indices, device=self.device)
3255
3256
                hidden_states = sample_hidden_states[indices]

3257
            draft_token_ids = self.drafter.propose(
3258
3259
3260
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
            )
3261
        elif spec_config.use_eagle():
3262
            assert isinstance(self.drafter, EagleProposer)
3263

3264
            if spec_config.disable_padded_drafter_batch:
3265
3266
3267
                # 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.
3268
3269
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
3270
                    "padded-batch is disabled."
3271
                )
3272
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
3273
3274
3275
3276
3277
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
3278
3279
3280
3281
3282
            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.
3283
3284
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
3285
                    "padded-batch is enabled."
3286
3287
                )
                next_token_ids, valid_sampled_tokens_count = (
3288
3289
3290
3291
3292
3293
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
                        self.discard_request_indices.gpu,
3294
                        self.num_discarded_requests,
3295
                    )
3296
                )
3297
3298
3299
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
3300

3301
            if spec_decode_metadata is None:
3302
                token_indices_to_sample = None
3303
                # input_ids can be None for multimodal models.
3304
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
3305
                target_positions = self._get_positions(num_scheduled_tokens)
3306
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3307
                    assert aux_hidden_states is not None
3308
                    target_hidden_states = torch.cat(
3309
3310
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
3311
3312
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
3313
            else:
3314
                if spec_config.disable_padded_drafter_batch:
3315
                    token_indices_to_sample = None
3316
3317
3318
3319
3320
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
3321
                else:
3322
                    common_attn_metadata, token_indices, token_indices_to_sample = (
3323
3324
3325
                        self.drafter.prepare_inputs_padded(
                            common_attn_metadata,
                            spec_decode_metadata,
3326
3327
3328
                            valid_sampled_tokens_count,
                        )
                    )
3329

3330
                target_token_ids = self.input_ids.gpu[token_indices]
3331
                target_positions = self._get_positions(token_indices)
3332
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3333
                    assert aux_hidden_states is not None
3334
                    target_hidden_states = torch.cat(
3335
3336
                        [h[token_indices] for h in aux_hidden_states], dim=-1
                    )
3337
3338
                else:
                    target_hidden_states = hidden_states[token_indices]
3339

3340
            if self.supports_mm_inputs:
3341
3342
3343
3344
3345
3346
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
3347

3348
            draft_token_ids = self.drafter.propose(
3349
3350
3351
3352
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
3353
                last_token_indices=token_indices_to_sample,
3354
                sampling_metadata=sampling_metadata,
3355
                common_attn_metadata=common_attn_metadata,
3356
                mm_embed_inputs=mm_embed_inputs,
3357
            )
3358

3359
        return draft_token_ids
3360

3361
3362
3363
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
3364
3365
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
3366
                f"Allowed configs: {allowed_config_names}"
3367
            )
3368
3369
3370
3371
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

3372
3373
3374
3375
3376
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
3377
3378
3379
3380
3381
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
3382
3383
3384
3385
3386
        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)
        )
3387

3388
3389
3390
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0
3391
        with DeviceMemoryProfiler() as m:
3392
            time_before_load = time.perf_counter()
3393
            model_loader = get_model_loader(self.load_config)
3394
            self.model = model_loader.load_model(
3395
3396
                vllm_config=self.vllm_config, model_config=self.model_config
            )
3397
            if self.lora_config:
3398
3399
3400
                self.model = self.load_lora_model(
                    self.model, self.vllm_config, self.device
                )
3401
            if hasattr(self, "drafter"):
3402
                logger.info_once("Loading drafter model...")
3403
                self.drafter.load_model(self.model)
3404
3405
3406
3407
3408
                if (
                    hasattr(self.drafter, "model")
                    and is_mixture_of_experts(self.drafter.model)
                    and self.parallel_config.enable_eplb
                ):
3409
3410
3411
                    spec_config = self.vllm_config.speculative_config
                    assert spec_config is not None
                    assert spec_config.draft_model_config is not None
3412
3413
                    logger.info_once(
                        "EPLB is enabled for drafter model %s.",
3414
                        spec_config.draft_model_config.model,
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
                    )

                    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,
3431
                        spec_config.draft_model_config,
3432
3433
3434
3435
3436
3437
                        global_expert_load,
                        old_global_expert_indices,
                        rank_mapping,
                    )
                    eplb_models += 1

3438
            if self.use_aux_hidden_state_outputs:
3439
                if not supports_eagle3(self.get_model()):
3440
3441
                    raise RuntimeError(
                        "Model does not support EAGLE3 interface but "
3442
3443
                        "aux_hidden_state_outputs was requested"
                    )
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456

                # 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)
3457
            time_after_load = time.perf_counter()
3458
        self.model_memory_usage = m.consumed_memory
3459
        logger.info_once(
3460
            "Model loading took %.4f GiB memory and %.6f seconds",
3461
3462
            self.model_memory_usage / GiB_bytes,
            time_after_load - time_before_load,
3463
            scope="local",
3464
        )
3465
        prepare_communication_buffer_for_model(self.model)
3466
        mm_config = self.model_config.multimodal_config
3467
        self.is_multimodal_pruning_enabled = (
3468
            supports_multimodal_pruning(self.get_model())
3469
3470
            and mm_config is not None
            and mm_config.is_multimodal_pruning_enabled()
3471
        )
3472

3473
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
            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(
3485
                self.model,
3486
                self.model_config,
3487
3488
3489
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
3490
            )
3491
3492
            if self.eplb_state.is_async:
                self.eplb_state.start_async_loop(rank_mapping=rank_mapping)
3493

3494
        if (
3495
3496
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
3497
            and supports_dynamo()
3498
        ):
3499
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
3500
            compilation_counter.stock_torch_compile_count += 1
3501
            self.model.compile(fullgraph=True, backend=backend)
3502
            return
3503
        # for other compilation modes, cudagraph behavior is controlled by
3504
3505
3506
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
3507
3508
3509
        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:
3510
3511
3512
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
3513
        elif self.parallel_config.enable_dbo:
3514
            if cudagraph_mode.has_full_cudagraphs():
3515
3516
3517
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
3518
            else:
3519
3520
3521
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
3522

3523
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
        """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

3547
    def reload_weights(self) -> None:
3548
        assert getattr(self, "model", None) is not None, (
3549
            "Cannot reload weights before model is loaded."
3550
        )
3551
3552
        model_loader = get_model_loader(self.load_config)
        logger.info("Reloading weights inplace...")
3553
        model_loader.load_weights(self.get_model(), model_config=self.model_config)
3554

3555
3556
3557
3558
3559
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
3560
            self.get_model(),
3561
            tensorizer_config=tensorizer_config,
3562
            model_config=self.model_config,
3563
3564
        )

3565
3566
3567
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
3568
        num_scheduled_tokens: dict[str, int],
3569
    ) -> dict[str, LogprobsTensors | None]:
3570
        num_prompt_logprobs_dict = self.num_prompt_logprobs
3571
3572
3573
        if not num_prompt_logprobs_dict:
            return {}

3574
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
3575
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
3576
3577
3578
3579
3580

        # 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():
3581
3582
3583
3584
            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
3585
3586
3587

            # Get metadata for this request.
            request = self.requests[req_id]
3588
3589
3590
3591
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

3592
3593
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
3594
3595
                self.device, non_blocking=True
            )
3596

3597
3598
3599
3600
3601
3602
            # 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(
3603
3604
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
3605
3606
                in_progress_dict[req_id] = logprobs_tensors

3607
            # Determine number of logits to retrieve.
3608
3609
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
3610
            num_remaining_tokens = num_prompt_tokens - start_tok
3611
            if num_tokens <= num_remaining_tokens:
3612
                # This is a chunk, more tokens remain.
3613
3614
3615
                # 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.
3616
3617
3618
3619
3620
                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)
3621
3622
3623
3624
3625
3626
3627
                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
3628
3629
3630
3631
3632

            # 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]
3633
            offset = self.query_start_loc.np[req_idx].item()
3634
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
3635
            logits = self.model.compute_logits(prompt_hidden_states)
3636
3637
3638
3639

            # 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.
3640
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
3641
3642

            # Compute prompt logprobs.
3643
3644
            logprobs = self.sampler.compute_logprobs(logits)
            token_ids, logprobs, ranks = self.sampler.gather_logprobs(
3645
3646
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
3647
3648

            # Transfer GPU->CPU async.
3649
3650
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
3651
3652
3653
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
3654
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
3655
3656
                ranks, non_blocking=True
            )
3657
3658
3659
3660
3661

        # 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]
3662
            del in_progress_dict[req_id]
3663
3664

        # Must synchronize the non-blocking GPU->CPU transfers.
3665
        if prompt_logprobs_dict:
3666
            self._sync_device()
3667
3668
3669

        return prompt_logprobs_dict

3670
3671
    def _get_nans_in_logits(
        self,
3672
        logits: torch.Tensor | None,
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
    ) -> 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])
3684
3685
3686
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
3687
3688
3689
3690
            return num_nans_in_logits
        except IndexError:
            return {}

3691
3692
3693
3694
3695
3696
    @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
3697
         - during DP rank dummy run
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
        """
        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(
3709
                    self.input_ids.gpu,
3710
3711
                    low=0,
                    high=self.model_config.get_vocab_size(),
3712
3713
                    dtype=input_ids.dtype,
                )
3714

3715
            logger.debug_once("Randomizing dummy data for DP Rank")
3716
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
3717
3718
3719
            yield
            input_ids.fill_(0)

3720
3721
3722
3723
3724
3725
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
3726
3727
        assert self.mm_budget is not None

3728
3729
        dummy_decoder_data = self.mm_registry.get_decoder_dummy_data(
            model_config=self.model_config,
3730
            seq_len=self.max_model_len,
3731
            mm_counts={modality: 1},
3732
            cache=self.mm_budget.cache,
3733
3734
3735
3736
        )
        dummy_mm_data = dummy_decoder_data.multi_modal_data

        # Result in the maximum GPU consumption of the model
3737
3738
        dummy_mm_item = dummy_mm_data[modality][0]
        dummy_mm_items = [dummy_mm_item] * max_items_per_batch
3739

3740
        model = cast(SupportsMultiModal, self.model)
3741
3742
3743
3744
3745
3746
3747
        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,
3748
                multimodal_cpu_fields=model.multimodal_cpu_fields,
3749
3750
            )
        )
3751

3752
3753
3754
3755
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
3756
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
3757
3758
        force_attention: bool = False,
        uniform_decode: bool = False,
3759
        allow_microbatching: bool = True,
3760
3761
        skip_eplb: bool = False,
        is_profile: bool = False,
3762
        create_mixed_batch: bool = False,
3763
        remove_lora: bool = True,
3764
        activate_lora: bool = False,
Rémi Delacourt's avatar
Rémi Delacourt committed
3765
        is_graph_capturing: bool = False,
3766
    ) -> tuple[torch.Tensor, torch.Tensor]:
3767
3768
3769
3770
3771
3772
3773
        """
        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.
3774
                - if not set will determine the cudagraph mode based on using
3775
                    the self.cudagraph_dispatcher.
3776
3777
3778
3779
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
3780
            force_attention: If True, always create attention metadata. Used to
3781
3782
3783
3784
                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.
3785
3786
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
3787
            remove_lora: If False, dummy LoRAs are not destroyed after the run
3788
            activate_lora: If False, dummy_run is performed without LoRAs.
3789
        """
3790
3791
3792
3793
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
3794

3795
        # If cudagraph_mode.decode_mode() == FULL and
3796
        # cudagraph_mode.separate_routine(). This means that we are using
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
        # 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.
3808
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
3809

3810
3811
3812
3813
3814
        # 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
3815
3816
3817
3818
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
3819
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
3820
3821
3822
3823
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
3824
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
3825
3826
3827
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
3828
            assert not create_mixed_batch
3829
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
3830
3831
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
3832
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
3833
3834
3835
3836
3837
3838
        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

3839
3840
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
3841
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
3842
        total_num_scheduled_tokens = int(num_scheduled_tokens.sum())
3843
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
3844

3845
3846
3847
        # Disable DP padding when running eager
        allow_dp_padding = self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE

3848
3849
        # We currently only microbatch if the number of tokens is
        # over a certain threshold.
3850
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
3851
3852
3853
3854
3855
3856
3857
            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,
3858
3859
3860
        )
        num_tokens_after_padding = num_tokens
        if num_tokens_across_dp is not None:
3861
3862
            dp_rank = self.parallel_config.data_parallel_rank
            num_tokens_after_padding = int(num_tokens_across_dp[dp_rank])
3863

3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
        # 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

3889
        attn_metadata: PerLayerAttnMetadata | None = None
3890
3891
3892

        # If force_attention is True, we always capture attention. Otherwise,
        # it only happens for cudagraph_runtime_mode=FULL.
3893
        if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
3894
3895
3896
3897
3898
3899
            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:
3900
                seq_lens = max_query_len  # type: ignore[assignment]
3901
            self.seq_lens.np[:num_reqs] = seq_lens
3902
3903
            self.seq_lens.np[num_reqs:] = 0
            self.seq_lens.copy_to_gpu()
3904

3905
3906
            cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
            self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
3907
3908
            self.query_start_loc.copy_to_gpu()

3909
3910
3911
3912
3913
3914
3915
            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,
            )
3916

3917
        with self.maybe_dummy_run_with_lora(
3918
3919
3920
3921
3922
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            activate_lora,
            remove_lora,
3923
        ):
3924
3925
3926
            # 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)
3927
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
3928
                input_ids = None
3929
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
3930
                model_kwargs = {
3931
                    **model_kwargs,
3932
3933
                    **self._dummy_mm_kwargs(num_reqs),
                }
3934
3935
            elif self.enable_prompt_embeds:
                input_ids = None
3936
3937
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
                model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3938
            else:
3939
                input_ids = self.input_ids.gpu[:num_tokens_after_padding]
3940
                inputs_embeds = None
3941

3942
            if self.uses_mrope:
3943
                positions = self.mrope_positions.gpu[:, :num_tokens_after_padding]
3944
3945
            elif self.uses_xdrope_dim > 0:
                positions = self.xdrope_positions.gpu[:, :num_tokens_after_padding]
3946
            else:
3947
                positions = self.positions.gpu[:num_tokens_after_padding]
3948
3949
3950
3951
3952
3953
3954
3955
3956

            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,
3957
3958
3959
                            device=self.device,
                        )
                    )
3960
3961

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
3962
                    num_tokens_after_padding, None, False
3963
                )
3964

3965
            if ubatch_slices is not None:
3966
3967
3968
3969
3970
3971
3972
                # 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

3973
3974
3975
            with (
                self.maybe_randomize_inputs(input_ids),
                set_forward_context(
3976
3977
                    attn_metadata,
                    self.vllm_config,
3978
                    num_tokens=num_tokens_after_padding,
3979
3980
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
3981
                    batch_descriptor=batch_descriptor,
3982
3983
3984
                    ubatch_slices=ubatch_slices,
                ),
            ):
3985
                outputs = self.model(
3986
3987
3988
3989
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
3990
                    **model_kwargs,
3991
                )
3992

3993
3994
3995
3996
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
3997

3998
            if self.speculative_config and self.speculative_config.use_eagle():
3999
                assert isinstance(self.drafter, EagleProposer)
4000
                use_cudagraphs = (
Rémi Delacourt's avatar
Rémi Delacourt committed
4001
                    cudagraph_runtime_mode.has_mode(CUDAGraphMode.PIECEWISE)
4002
4003
                    and not self.speculative_config.enforce_eager
                )
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014

                # Note(gnovack) - We need to disable cudagraphs for one of the two
                # lora cases when cudagraph_specialize_lora is enabled. This is a
                # short term mitigation for issue mentioned in
                # https://github.com/vllm-project/vllm/issues/28334
                if self.compilation_config.cudagraph_specialize_lora and activate_lora:
                    use_cudagraphs = False

                self.drafter.dummy_run(
                    num_tokens,
                    use_cudagraphs=use_cudagraphs,
Rémi Delacourt's avatar
Rémi Delacourt committed
4015
                    is_graph_capturing=is_graph_capturing,
4016
                )
4017

4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
        # 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)

4028
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
4029
4030
4031
4032
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
4033
4034
4035
4036
4037
4038

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
4039
4040
4041
4042
        # 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)
4043

4044
        logits = self.model.compute_logits(hidden_states)
4045
4046
        num_reqs = logits.size(0)

4047
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062

        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)],
4063
            spec_token_ids=[[] for _ in range(num_reqs)],
4064
4065
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
4066
            logitsprocs=LogitsProcessors(),
4067
        )
4068
        try:
4069
4070
4071
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
4072
        except RuntimeError as e:
4073
            if "out of memory" in str(e):
4074
4075
4076
4077
                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 "
4078
4079
                    "initializing the engine."
                ) from e
4080
4081
            else:
                raise e
4082
        if self.speculative_config:
4083
4084
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
4085
4086
                draft_token_ids, self.device
            )
4087
4088
4089
4090
4091
4092

            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
4093
4094
4095
4096
4097
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
4098
            )
4099
4100
4101
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
4102
                logits,
4103
4104
                dummy_metadata,
            )
4105
        return sampler_output
4106

4107
    def _dummy_pooler_run_task(
4108
4109
        self,
        hidden_states: torch.Tensor,
4110
4111
        task: PoolingTask,
    ) -> PoolerOutput:
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
        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

4123
        dummy_prompt_lens = torch.tensor(
4124
4125
            num_scheduled_tokens_list,
            device="cpu",
4126
        )
4127
4128
4129
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
4130

4131
        model = cast(VllmModelForPooling, self.get_model())
4132
        dummy_pooling_params = PoolingParams(task=task)
4133
        dummy_pooling_params.verify(task=task, model_config=self.model_config)
4134
        to_update = model.pooler.get_pooling_updates(task)
4135
4136
        to_update.apply(dummy_pooling_params)

4137
        dummy_metadata = PoolingMetadata(
4138
4139
4140
4141
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
        )
4142

4143
4144
4145
        dummy_metadata.build_pooling_cursor(
            num_scheduled_tokens_list, device=hidden_states.device
        )
4146

4147
        try:
4148
4149
4150
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
4151
        except RuntimeError as e:
4152
            if "out of memory" in str(e):
4153
                raise RuntimeError(
4154
4155
4156
                    "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 "
4157
4158
                    "initializing the engine."
                ) from e
4159
4160
            else:
                raise e
4161
4162
4163
4164
4165
4166
4167

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

        if not supported_pooling_tasks:
4171
            if self.scheduler_config.enable_chunked_prefill:
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
                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."
                )

4188
        output_size = dict[PoolingTask, float]()
4189
        for task in supported_pooling_tasks:
4190
4191
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
4192
            output_size[task] = sum(o.nbytes for o in output)
4193
4194
4195
4196
            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)
4197

4198
    def profile_run(self) -> None:
4199
        # Profile with multimodal encoder & encoder cache.
4200
        if self.supports_mm_inputs:
4201
4202
            mm_config = self.model_config.multimodal_config
            if mm_config is not None and mm_config.skip_mm_profiling:
4203
                logger.info(
4204
                    "Skipping memory profiling for multimodal encoder and "
4205
4206
                    "encoder cache."
                )
4207
4208
4209
4210
4211
4212
4213
4214
            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.
4215
                    dummy_modality = mm_budget.get_modality_with_max_tokens()
4216
4217
4218
                    max_mm_items_per_batch = mm_budget.max_items_per_batch_by_modality[
                        dummy_modality
                    ]
4219
4220
4221
4222
4223
4224
4225
4226
4227

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

4229
4230
4231
4232
4233
                    # Create dummy batch of multimodal inputs.
                    batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                        dummy_modality,
                        max_mm_items_per_batch,
                    )
4234

4235
                    # Run multimodal encoder.
4236
                    dummy_encoder_outputs = self.model.embed_multimodal(
4237
4238
                        **batched_dummy_mm_inputs
                    )
4239

4240
4241
4242
4243
                    sanity_check_mm_encoder_outputs(
                        dummy_encoder_outputs,
                        expected_num_items=max_mm_items_per_batch,
                    )
4244

4245
4246
4247
                    # 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
4248
4249
                    # (max_tokens_for_modality, hidden_size) and scatter
                    # encoder output into it.
4250
                    encoder_output_shape = dummy_encoder_outputs[0].shape
4251
4252
4253
4254
4255
                    max_mm_tokens_per_item = mm_budget.max_tokens_by_modality[
                        dummy_modality
                    ]
                    if encoder_output_shape[0] < max_mm_tokens_per_item:
                        encoder_hidden_size = encoder_output_shape[-1]
4256
4257
4258
                        expanded_outputs = []
                        for output in dummy_encoder_outputs:
                            expanded = output.new_zeros(
4259
                                (max_mm_tokens_per_item, encoder_hidden_size)
4260
                            )
4261
4262
4263
4264
4265
4266
                            num_tokens = output.shape[0]
                            expanded[:num_tokens].copy_(output)
                            expanded_outputs.append(expanded)

                        dummy_encoder_outputs = expanded_outputs

4267
                    # Cache the dummy encoder outputs.
4268
                    self.encoder_cache["tmp"] = dict(enumerate(dummy_encoder_outputs))
4269

4270
        # Add `is_profile` here to pre-allocate communication buffers
4271
4272
4273
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
4274
        if get_pp_group().is_last_rank:
4275
4276
4277
4278
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
4279
        else:
4280
            output = None
4281
        self._sync_device()
4282
        del hidden_states, output
4283
        self.encoder_cache.clear()
4284
        gc.collect()
4285

4286
    def capture_model(self) -> int:
4287
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
4288
            logger.warning(
4289
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
4290
4291
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
4292
            return 0
4293

4294
4295
        compilation_counter.num_gpu_runner_capture_triggers += 1

4296
4297
        start_time = time.perf_counter()

4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
        @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()
4312
                    gc.collect()
4313

4314
4315
4316
        # 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.
4317
        set_cudagraph_capturing_enabled(True)
4318
        with freeze_gc(), graph_capture(device=self.device):
4319
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
4320
            cudagraph_mode = self.compilation_config.cudagraph_mode
4321
            assert cudagraph_mode is not None
4322
4323
4324
4325
4326
4327
4328
4329
4330

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

4331
4332
            if cudagraph_mode.mixed_mode() != CUDAGraphMode.NONE:
                cudagraph_runtime_mode = cudagraph_mode.mixed_mode()
4333
                # make sure we capture the largest batch size first
4334
4335
4336
                compilation_cases = list(
                    product(reversed(self.cudagraph_batch_sizes), lora_cases)
                )
4337
4338
4339
                self._capture_cudagraphs(
                    compilation_cases,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4340
4341
                    uniform_decode=False,
                )
4342

4343
4344
            # Capture full cudagraph for uniform decode batches if we
            # don't already have full mixed prefill-decode cudagraphs.
4345
4346
4347
4348
4349
4350
4351
            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
                )
4352
                decode_cudagraph_batch_sizes = [
4353
4354
                    x
                    for x in self.cudagraph_batch_sizes
4355
                    if max_num_tokens >= x >= self.uniform_decode_query_len
4356
                ]
4357
4358
4359
                compilation_cases_decode = list(
                    product(reversed(decode_cudagraph_batch_sizes), lora_cases)
                )
4360
4361
4362
                self._capture_cudagraphs(
                    compilation_cases=compilation_cases_decode,
                    cudagraph_runtime_mode=CUDAGraphMode.FULL,
4363
4364
                    uniform_decode=True,
                )
4365

4366
4367
4368
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

4369
4370
4371
        # 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
4372
        # we may do lazy capturing in future that still allows capturing
4373
4374
        # after here.
        set_cudagraph_capturing_enabled(False)
4375
4376
4377
4378
4379

        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.
4380
        logger.info_once(
4381
4382
4383
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
4384
            scope="local",
4385
        )
4386
        return cuda_graph_size
4387

4388
4389
    def _capture_cudagraphs(
        self,
4390
        compilation_cases: list[tuple[int, bool]],
4391
4392
4393
4394
4395
4396
4397
        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}"
4398
4399
4400
4401
4402
4403
4404
4405

        # 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",
4406
4407
4408
                    cudagraph_runtime_mode.name,
                ),
            )
4409

4410
        # We skip EPLB here since we don't want to record dummy metrics
4411
        for num_tokens, activate_lora in compilation_cases:
4412
            # We currently only capture ubatched graphs when its a FULL
4413
4414
4415
            # 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
4416
4417
4418
4419
            allow_microbatching = (
                self.parallel_config.enable_dbo
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
4420
4421
4422
4423
4424
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
4425
            )
4426

4427
4428
4429
4430
4431
4432
            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.
4433
4434
4435
4436
4437
4438
4439
4440
4441
                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,
4442
                    activate_lora=activate_lora,
4443
4444
4445
4446
4447
4448
4449
4450
                )
            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,
4451
                activate_lora=activate_lora,
Rémi Delacourt's avatar
Rémi Delacourt committed
4452
                is_graph_capturing=True,
4453
            )
4454
        self.maybe_remove_all_loras(self.lora_config)
4455

4456
4457
4458
4459
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
4460
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
4461

4462
4463
4464
4465
4466
4467
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
4468
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
4469
            layer_type = cast(type[Any], AttentionLayerBase)
4470
            layers = get_layers_from_vllm_config(
4471
                self.vllm_config, layer_type, kv_cache_group_spec.layer_names
4472
            )
4473
4474
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
4475
            # Dedupe based on full class name; this is a bit safer than
4476
4477
4478
4479
            # 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.
4480
            for layer_name in kv_cache_group_spec.layer_names:
4481
                attn_backend = layers[layer_name].get_attn_backend()
4482
4483
4484
4485

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
4486
                        attn_backend,  # type: ignore[arg-type]
4487
4488
                    )

4489
4490
4491
                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):
4492
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
4493
                key = (full_cls_name, layer_kv_cache_spec)
4494
4495
4496
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
4497
                attn_backend_layers[key].append(layer_name)
4498
4499
4500
4501
            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()),
            )
4502
4503

        def create_attn_groups(
4504
            attn_backends_map: dict[AttentionGroupKey, list[str]],
4505
            kv_cache_group_id: int,
4506
4507
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
4508
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
4509
                attn_group = AttentionGroup(
4510
                    attn_backend,
4511
                    layer_names,
4512
                    kv_cache_spec,
4513
                    kv_cache_group_id,
4514
4515
                )

4516
4517
4518
                attn_groups.append(attn_group)
            return attn_groups

4519
        attention_backend_maps = []
4520
        attention_backend_list = []
4521
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
4522
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
4523
            attention_backend_maps.append(attn_backends[0])
4524
            attention_backend_list.append(attn_backends[1])
4525
4526

        # Resolve cudagraph_mode before actually initialize metadata_builders
4527
4528
4529
        self._check_and_update_cudagraph_mode(
            attention_backend_list, kv_cache_config.kv_cache_groups
        )
4530

4531
4532
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
4533

4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
    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
4552
        # Calculate reorder batch threshold (if needed)
4553
4554
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
4555
4556
        self.calculate_reorder_batch_threshold()

4557
    def _check_and_update_cudagraph_mode(
4558
4559
4560
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
4561
    ) -> None:
4562
        """
4563
        Resolve the cudagraph_mode when there are multiple attention
4564
        groups with potential conflicting CUDA graph support.
4565
4566
4567
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
4568
        min_cg_support = AttentionCGSupport.ALWAYS
4569
        min_cg_backend_name = None
4570

4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
        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__
4583
4584
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
4585
        assert cudagraph_mode is not None
4586
        # check cudagraph for mixed batch is supported
4587
4588
4589
4590
4591
4592
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4593
                f"with {min_cg_backend_name} backend (support: "
4594
4595
                f"{min_cg_support})"
            )
4596
4597
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
4598
4599
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
4600
                    "make sure compilation mode is VLLM_COMPILE"
4601
                )
4602
4603
4604
4605
4606
                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"
4607
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4608
                    CUDAGraphMode.FULL_AND_PIECEWISE
4609
                )
4610
4611
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
4612
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4613
                    CUDAGraphMode.FULL_DECODE_ONLY
4614
                )
4615
4616
            logger.warning(msg)

4617
        # check that if we are doing decode full-cudagraphs it is supported
4618
4619
4620
4621
4622
4623
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4624
                f"with {min_cg_backend_name} backend (support: "
4625
4626
                f"{min_cg_support})"
            )
4627
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
4628
4629
4630
4631
4632
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
4633
                    "attention is compiled piecewise"
4634
4635
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4636
                    CUDAGraphMode.PIECEWISE
4637
                )
4638
            else:
4639
4640
                msg += (
                    "; setting cudagraph_mode=NONE because "
4641
                    "attention is not compiled piecewise"
4642
4643
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4644
                    CUDAGraphMode.NONE
4645
                )
4646
4647
            logger.warning(msg)

4648
4649
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
4650
4651
4652
4653
4654
4655
4656
4657
        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 "
4658
                f"{min_cg_backend_name} (support: {min_cg_support})"
4659
            )
4660
4661
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
4662
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4663
                    CUDAGraphMode.PIECEWISE
4664
                )
4665
4666
            else:
                msg += "; setting cudagraph_mode=NONE"
4667
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4668
                    CUDAGraphMode.NONE
4669
                )
4670
4671
4672
4673
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
4674
4675
4676
4677
4678
4679
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
4680
                f"supported with {min_cg_backend_name} backend ("
4681
4682
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
4683
                "and make sure compilation mode is VLLM_COMPILE"
4684
            )
4685

4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
        # 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
            )
4700
4701
4702
4703
            capture_sizes = self.compilation_config.cudagraph_capture_sizes
            self.cudagraph_batch_sizes = (
                capture_sizes if capture_sizes is not None else []
            )
4704

4705
4706
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
4707
4708
        cudagraph_mode = self.compilation_config.cudagraph_mode
        assert cudagraph_mode is not None
4709
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
4710
            cudagraph_mode, self.uniform_decode_query_len
4711
        )
4712

4713
4714
    def calculate_reorder_batch_threshold(self) -> None:
        """
4715
4716
4717
4718
        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.
4719
        """
4720
4721
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

4722
        reorder_batch_thresholds: list[int | None] = [
4723
4724
4725
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
4726
4727
4728
4729
4730
        # 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
4731
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)  # type: ignore[assignment]
4732

4733
4734
4735
    @staticmethod
    def select_common_block_size(
        kv_manager_block_size: int, attn_groups: list[AttentionGroup]
4736
4737
    ) -> int:
        """
4738
4739
4740
4741
4742
        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.
4743
4744
4745
4746
4747
4748

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

        Returns:
4749
            The selected block size
4750
4751

        Raises:
4752
            ValueError: If no valid block size found
4753
4754
        """

4755
4756
4757
4758
4759
4760
4761
4762
        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
4763
                for supported_size in backend.get_supported_kernel_block_sizes():
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
                    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
4794
            for supported_size in backend.get_supported_kernel_block_sizes()
4795
4796
            if isinstance(supported_size, int)
        )
4797

4798
4799
4800
4801
4802
4803
        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}. ")
4804

4805
4806
4807
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
4808
4809
4810
4811
4812
4813
4814
        """
        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.
4815
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4816
4817
4818
4819
        """
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
4820
            if not isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec)
4821
        ]
4822
4823
4824
4825

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
4826
4827
4828
            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
4829
4830
                "for more details."
            )
4831
4832
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
4833
                max_model_len=max(self.max_model_len, self.max_encoder_len),
4834
4835
4836
4837
4838
                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,
4839
                kernel_block_sizes=kernel_block_sizes,
4840
                is_spec_decode=bool(self.vllm_config.speculative_config),
4841
                logitsprocs=self.input_batch.logitsprocs,
4842
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
4843
                is_pooling_model=self.is_pooling_model,
4844
                num_speculative_tokens=self.num_spec_tokens,
4845
4846
            )

4847
    def _allocate_kv_cache_tensors(
4848
4849
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
4850
        """
4851
4852
4853
        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.

4854
        Args:
4855
            kv_cache_config: The KV cache config
4856
        Returns:
4857
            dict[str, torch.Tensor]: A map between layer names to their
4858
            corresponding memory buffer for KV cache.
4859
        """
4860
4861
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
4862
4863
4864
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
4865
4866
4867
4868
4869
            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:
4870
4871
4872
4873
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
4874
4875
4876
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
4877
4878
        return kv_cache_raw_tensors

4879
4880
4881
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

4882
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
4883
4884
        if not self.kv_cache_config.kv_cache_groups:
            return
4885
4886
        for attn_groups in self.attn_groups:
            yield from attn_groups
4887

4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
    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 = []
4903
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
4904
4905
4906
4907
4908
4909
            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):
4910
                continue
4911
            elif isinstance(kv_cache_spec, AttentionSpec):
4912
4913
4914
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
4915
                attn_groups = self.attn_groups[kv_cache_gid]
4916
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
4917
                selected_kernel_size = self.select_common_block_size(
4918
4919
4920
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
4921
            elif isinstance(kv_cache_spec, MambaSpec):
4922
4923
                # This is likely Mamba or other non-attention cache,
                # no splitting.
4924
                kernel_block_sizes.append(kv_cache_spec.block_size)
4925
4926
4927
4928
4929
4930
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

4931
4932
4933
4934
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
4935
        kernel_block_sizes: list[int],
4936
    ) -> dict[str, torch.Tensor]:
4937
        """
4938
        Reshape the KV cache tensors to the desired shape and dtype.
4939

4940
        Args:
4941
4942
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
4943
                correct size but uninitialized shape.
4944
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4945
        Returns:
4946
            Dict[str, torch.Tensor]: A map between layer names to their
4947
4948
            corresponding memory buffer for KV cache.
        """
4949
        kv_caches: dict[str, torch.Tensor] = {}
4950
        has_attn, has_mamba = False, False
4951
4952
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
4953
            attn_backend = group.backend
4954
4955
4956
4957
            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]
4958
            for layer_name in group.layer_names:
4959
4960
                if layer_name in self.runner_only_attn_layers:
                    continue
4961
4962
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
4963
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
4964
                if isinstance(kv_cache_spec, AttentionSpec):
4965
                    has_attn = True
4966
4967
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
4968
4969
4970
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

4971
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
4972
                        kernel_num_blocks,
4973
                        kernel_block_size,
4974
4975
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
4976
4977
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
4978
                    dtype = kv_cache_spec.dtype
4979
                    try:
4980
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
4981
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
4982
                    except (AttributeError, NotImplementedError):
4983
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
4984
4985
4986
4987
4988
                    # 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.
4989
4990
4991
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
4992
4993
4994
4995
4996
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
4997
4998
4999
5000
5001
5002
                    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
5003
                elif isinstance(kv_cache_spec, MambaSpec):
5004
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
5005
5006
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
5007
                    storage_offset_bytes = 0
5008
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
5009
5010
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
5011
5012
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
5013
                        target_shape = (num_blocks, *shape)
5014
5015
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
5016
                        assert storage_offset_bytes % dtype_size == 0
5017
5018
5019
5020
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
5021
                            storage_offset=storage_offset_bytes // dtype_size,
5022
                        )
Chen Zhang's avatar
Chen Zhang committed
5023
                        state_tensors.append(tensor)
5024
                        storage_offset_bytes += stride[0] * dtype_size
5025
5026

                    kv_caches[layer_name] = state_tensors
5027
                else:
5028
                    raise NotImplementedError
5029
5030

        if has_attn and has_mamba:
5031
            self._update_hybrid_attention_mamba_layout(kv_caches)
5032

5033
5034
        return kv_caches

5035
    def _update_hybrid_attention_mamba_layout(
5036
5037
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
5038
        """
5039
5040
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
5041
5042

        Args:
5043
            kv_caches: The KV cache buffer of each layer.
5044
5045
        """

5046
5047
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5048
            for layer_name in group.layer_names:
5049
                kv_cache = kv_caches[layer_name]
5050
5051
5052
5053
                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 "
5054
                        f"a tensor of shape {kv_cache.shape}"
5055
                    )
5056
                    hidden_size = kv_cache.shape[2:].numel()
5057
5058
5059
5060
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
5061

5062
    def initialize_kv_cache_tensors(
5063
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
5064
    ) -> dict[str, torch.Tensor]:
5065
5066
5067
5068
5069
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
5070
5071
            kernel_block_sizes: The kernel block sizes for each KV cache group.

5072
        Returns:
5073
            Dict[str, torch.Tensor]: A map between layer names to their
5074
5075
            corresponding memory buffer for KV cache.
        """
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099

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

5101
        # Set up cross-layer KV cache sharing
5102
5103
        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)
5104
5105
            kv_caches[layer_name] = kv_caches[target_layer_name]

5106
5107
5108
5109
5110
5111
5112
5113
5114
        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,
        )
5115
5116
5117
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
5118
5119
        self, kv_cache_config: KVCacheConfig
    ) -> None:
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
        """
        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.
5138
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
5139
5140
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
5141
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
5142
5143
                else:
                    break
5144

5145
5146
5147
5148
5149
5150
5151
    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
        """
5152
        kv_cache_config = deepcopy(kv_cache_config)
5153
        self.kv_cache_config = kv_cache_config
5154
        self.may_add_encoder_only_layers_to_kv_cache_config()
5155
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
5156
        self.initialize_attn_backend(kv_cache_config)
5157
5158
5159
5160
5161
5162
        # 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)
5163
5164
5165
5166

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

5167
        # Reinitialize need to after initialize_attn_backend
5168
5169
5170
5171
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
5172

5173
5174
5175
5176
5177
5178
        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
5179
        if has_kv_transfer_group():
5180
            kv_transfer_group = get_kv_transfer_group()
5181
5182
5183
5184
5185
5186
5187
            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)
5188
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
5189

5190
        if self.dcp_world_size > 1:
5191
5192
            layer_type = cast(type[Any], AttentionLayerBase)
            layers = get_layers_from_vllm_config(self.vllm_config, layer_type)
5193
            for layer in layers.values():
5194
5195
5196
5197
                layer_impl = getattr(layer, "impl", None)
                if layer_impl is None:
                    continue
                assert layer_impl.need_to_return_lse_for_decode, (
5198
5199
                    "DCP requires attention impls to return"
                    " the softmax lse for decode, but the impl "
5200
                    f"{layer_impl.__class__.__name__} "
5201
5202
                    "does not return the softmax lse for decode."
                )
5203

5204
5205
5206
5207
5208
    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
5209
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
5210
5211
5212
        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:
5213
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
5214
5215
5216
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
5217
5218
                    dtype=self.kv_cache_dtype,
                )
5219
5220
5221
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
5222
5223
5224
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
5225
5226
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
5227
5228
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
5229

5230
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
5231
        """
5232
        Generates the KVCacheSpec by parsing the kv cache format from each
5233
5234
        Attention module in the static forward context.
        Returns:
5235
            KVCacheSpec: A dictionary mapping layer names to their KV cache
5236
5237
            format. Layers that do not need KV cache are not included.
        """
5238
5239
        if has_ec_transfer() and get_ec_transfer().is_producer:
            return {}
5240
        kv_cache_spec: dict[str, KVCacheSpec] = {}
5241
5242
        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
5243
        for layer_name, attn_module in attn_layers.items():
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
            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
5259

5260
        return kv_cache_spec
5261

5262
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
5263
5264
5265
5266
5267
5268
5269
5270
        # 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.
5271
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
5272
5273
5274
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
5275
        return pinned.tolist()