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

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

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

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

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

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

logger = init_logger(__name__)

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

181

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

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

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

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

222
223
        This function blocks until the copy is finished.
        """
224
        max_gen_len = self.sampled_token_ids_cpu.shape[-1]
225
        self.async_copy_ready_event.synchronize()
226

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

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
245
        if self._logprobs_tensors_cpu:
246
            output.logprobs = self._logprobs_tensors_cpu.tolists(cu_num_tokens)
247
248
249
        return output


250
251
252
253
254
255
256
257
258
259
260
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
261
    ec_connector_output: ECConnectorOutput | None
262
    cudagraph_stats: CUDAGraphStat | None
263
264


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

284
        from vllm.model_executor.models.utils import set_cpu_offload_max_bytes
285
286

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

288
289
290
291
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
292
        self.device = device
293
294
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
295
296
297
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
298

299
        self.is_pooling_model = model_config.runner_type == "pooling"
300
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
301
        self.is_multimodal_raw_input_only_model = (
302
303
            model_config.is_multimodal_raw_input_only_model
        )
304
305
        # This will be overridden in load_model()
        self.is_multimodal_pruning_enabled = False
306
        self.max_model_len = model_config.max_model_len
307
308
309

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

315
316
317
318
319
        # 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 = (
320
321
322
            self.parallel_config.distributed_executor_backend == "external_launcher"
            and len(get_pp_group().ranks) > 0
        )
323

324
        # Model-related.
325
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
326
        self.inputs_embeds_size = model_config.get_inputs_embeds_size()
327
        self.attention_chunk_size = model_config.attention_chunk_size
328
        # Only relevant for models using ALiBi (e.g, MPT)
329
        self.use_alibi = model_config.uses_alibi
330

331
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
332

333
        # Multi-modal data support
334
        self.mm_registry = MULTIMODAL_REGISTRY
335
        self.uses_mrope = model_config.uses_mrope
336
        self.uses_xdrope_dim = model_config.uses_xdrope_dim
337
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
338
339
            model_config
        )
340

341
342
343
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
344
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
345
346
347
        else:
            self.max_encoder_len = 0

348
        # Sampler
349
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
350

351
        self.eplb_state: EplbState | None = None
352
353
354
355
356
357
        """
        State of the expert parallelism load balancer.

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

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

369
370
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
371

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

402
403
404
405
        self.num_spec_tokens = 0
        if self.speculative_config:
            self.num_spec_tokens = self.speculative_config.num_speculative_tokens

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

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

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

463
        # self.cudagraph_batch_sizes sorts in ascending order.
464
465
466
467
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
468
469
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
470
            )
471

472
        # Cache the device properties.
473
        self._init_device_properties()
474

475
        # Persistent buffers for CUDA graphs.
476
477
478
479
480
        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
        )
481
        self.seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
482
        self.encoder_seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
483
484
485
486
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
487
488
489
        # 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.
490
        self.inputs_embeds = self._make_buffer(
491
            self.max_num_tokens, self.inputs_embeds_size, dtype=self.dtype, numpy=False
492
493
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
494
495
        self.discard_request_mask = self._make_buffer(
            self.max_num_reqs, dtype=torch.bool
496
497
498
499
500
501
502
        )
        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
        )
503

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

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

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

524
525
526
527
528
529
530
        # 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
            )

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

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

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

554
        self.uniform_decode_query_len = 1 + self.num_spec_tokens
555
556
557
558

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

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

569
        self.reorder_batch_threshold: int | None = None
570

571
572
573
574
575
        # 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()

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

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

600
601
        # Ephemeral state transferred between execute_model() and sample_tokens().
        self.execute_model_state: ExecuteModelState | None = None
602
        self.kv_connector_output: KVConnectorOutput | None = None
603
        self.layerwise_nvtx_hooks_registered = False
604

605
606
607
608
    def reset_mm_cache(self) -> None:
        if self.mm_budget:
            self.mm_budget.reset_cache()

609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
    @torch.inference_mode()
    def init_fp8_kv_scales(self) -> None:
        """
        Re-initialize the KV cache and FP8 scales after waking from sleep.
        1. Zero out the KV cache tensors to remove garbage data from re-allocation.
        2. Reset Attention layer scaling factors (_k_scale, _v_scale) to 1.0.
          If these are left at 0.0 (default after wake_up), all KV cache values
          become effectively zero, causing gibberish output.
        """
        if not self.cache_config.cache_dtype.startswith("fp8"):
            return

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

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

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

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

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

653
654
655
656
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
657
658
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, :num_tokens]
659
660
661
662
            return self.positions.gpu[:num_tokens]
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
663
664
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, num_tokens]
665
666
            return self.positions.gpu[num_tokens]

667
    def _make_buffer(
668
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
669
670
671
672
673
674
675
676
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
677

678
679
680
    def _init_model_kwargs(self, num_tokens: int):
        model_kwargs = dict[str, Any]()

681
        if not self.is_pooling_model:
682
683
            return model_kwargs

684
685
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
686
687
688

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
689
690
691
692
693
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
694
695
696
697
698
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

699
        seq_lens = self.seq_lens.gpu[:num_reqs]
700
701
702
703
704
705
706
707
        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(
708
709
            device=self.device
        )
710
711
        return model_kwargs

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

        Args:
            scheduler_output: The scheduler output.
        """
722
723
724
725
726
727
728
729
        # 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

730
731
732
733
        if self.reorder_batch_threshold is not None:
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
734
735
                decode_threshold=self.reorder_batch_threshold,
            )
736

737
738
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
739
        """Initialize attributes from torch.cuda.get_device_properties"""
740
741
742
743
744
745
746
        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()

747
    def _update_states(self, scheduler_output: "SchedulerOutput") -> None:
748
749
750
751
752
753
        """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.

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

        # Free the cached encoder outputs.
771
772
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
773

774
775
776
777
778
779
780
        # 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()
781
782
783
784
785
786
787
788
        resumed_req_ids = scheduler_output.scheduled_cached_reqs.resumed_req_ids
        # NOTE(zhuohan): cached_req_ids and resumed_req_ids are usually disjoint,
        # so `(scheduled_req_ids - resumed_req_ids) == scheduled_req_ids` holds
        # apart from the forced-preemption case in reset_prefix_cache. And in
        # that case we include the resumed_req_ids in the unscheduled set so
        # that they get cleared from the persistent batch before being re-scheduled
        # in the normal resumed request path.
        unscheduled_req_ids = cached_req_ids - (scheduled_req_ids - resumed_req_ids)
789
790
791
792
793
        # 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:
794
            self.input_batch.remove_request(req_id)
795

796
        reqs_to_add: list[CachedRequestState] = []
797
        # Add new requests to the cached states.
798
799
800
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
            sampling_params = new_req_data.sampling_params
801
            pooling_params = new_req_data.pooling_params
802

803
804
805
806
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
807
808
809
810
811
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

812
813
            if self.is_pooling_model:
                assert pooling_params is not None
814
815
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
816

817
                model = cast(VllmModelForPooling, self.get_model())
818
                to_update = model.pooler.get_pooling_updates(task)
819
820
                to_update.apply(pooling_params)

821
            req_state = CachedRequestState(
822
                req_id=req_id,
823
                prompt_token_ids=new_req_data.prompt_token_ids,
824
                prompt_embeds=new_req_data.prompt_embeds,
825
                mm_features=new_req_data.mm_features,
826
                sampling_params=sampling_params,
827
                pooling_params=pooling_params,
828
                generator=generator,
829
830
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
831
                output_token_ids=[],
832
                lora_request=new_req_data.lora_request,
833
            )
834
835
            self.requests[req_id] = req_state

836
837
838
839
840
841
842
            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
                )

843
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
844
            if self.uses_mrope:
845
                self._init_mrope_positions(req_state)
846

847
848
849
850
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            if self.uses_xdrope_dim > 0:
                self._init_xdrope_positions(req_state)

851
            reqs_to_add.append(req_state)
852

853
        # Update the states of the running/resumed requests.
854
        is_last_rank = get_pp_group().is_last_rank
855
        req_data = scheduler_output.scheduled_cached_reqs
856
857
858
859
860

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

861
        for i, req_id in enumerate(req_data.req_ids):
862
            req_state = self.requests[req_id]
863
864
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
865
            resumed_from_preemption = req_id in req_data.resumed_req_ids
866
            num_output_tokens = req_data.num_output_tokens[i]
867
            req_index = self.input_batch.req_id_to_index.get(req_id)
868

869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
            # 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)
892

893
            # Update the cached states.
894
            req_state.num_computed_tokens = num_computed_tokens
895
896
897
898
899
900
901
902

            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.
903
904
905
                num_new_tokens = (
                    num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                )
906
907
908
909
                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:
910
                    req_state.output_token_ids.extend(new_token_ids[-num_new_tokens:])
911
912
913
914
915
            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:
916
917
918
919
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
920
921
                    self.input_batch.num_tokens[req_index] = end_idx
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
922

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

            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.
940
941
942
943
944
945
946

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

947
                reqs_to_add.append(req_state)
948
949
950
                continue

            # Update the persistent batch.
951
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
952
            if new_block_ids is not None:
953
                self.input_batch.block_table.append_row(new_block_ids, req_index)
954
955
956
957
958
959
960

            # 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)
961
                self.input_batch.token_ids_cpu[
962
963
964
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
965
                self.input_batch.num_tokens[req_index] = end_token_index
966

967
            # Add spec_token_ids to token_ids_cpu.
968
            spec_token_ids = scheduler_output.scheduled_spec_decode_tokens.get(
969
                req_id, []
970
            )
971
972
973
974
975
            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:
976
977
978
                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[
979
980
                    req_index, start_index:end_token_index
                ] = spec_token_ids
981
982
                # NOTE(woosuk): `num_tokens` here may include spec tokens.
                self.input_batch.num_tokens[req_index] += num_spec_tokens
983
984
985
986
987
988

            # 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.
989
990
            self.input_batch.spec_token_ids[req_index].clear()
            self.input_batch.spec_token_ids[req_index].extend(spec_token_ids)
991

992
993
994
995
996
997
998
999
1000
            # 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)
1001
1002
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
1003
1004
        for request in reqs_to_add:
            self.input_batch.add_request(request)
1005

1006
1007
1008
1009
1010
1011
        # 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()
1012

1013
    def _update_states_after_model_execute(
1014
1015
        self, output_token_ids: torch.Tensor
    ) -> None:
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
        """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.
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
        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()
        )
1048
1049
1050
        for i, num_tokens in enumerate(num_accepted_tokens):
            self.input_batch.num_accepted_tokens_cpu[i] = num_tokens

1051
    def _init_mrope_positions(self, req_state: CachedRequestState):
1052
1053
        model = self.get_model()
        assert supports_mrope(model), "M-RoPE support is not implemented."
1054
1055
1056
1057
        assert req_state.prompt_token_ids is not None, (
            "M-RoPE requires prompt_token_ids to be available."
        )
        mrope_model = cast(SupportsMRoPE, model)
1058
1059

        req_state.mrope_positions, req_state.mrope_position_delta = (
1060
            mrope_model.get_mrope_input_positions(
1061
                req_state.prompt_token_ids,
1062
                req_state.mm_features,
1063
            )
1064
        )
1065

1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
    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,
        )

1079
    def _extract_mm_kwargs(
1080
        self,
1081
1082
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
1083
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
1084
            return {}
1085

1086
1087
        mm_kwargs = list[MultiModalKwargsItem]()
        for req in scheduler_output.scheduled_new_reqs:
1088
1089
1090
            for feature in req.mm_features:
                if feature.data is not None:
                    mm_kwargs.append(feature.data)
1091

1092
        # Input all modalities at once
1093
        model = cast(SupportsMultiModal, self.model)
1094
1095
        mm_kwargs_combined: BatchedTensorInputs = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
1096
1097
1098
1099
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
1100
1101
        ):
            mm_kwargs_combined.update(mm_kwargs_group)
1102

1103
        return mm_kwargs_combined
1104

1105
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
1106
        if not self.is_multimodal_raw_input_only_model:
1107
            return {}
1108

1109
1110
1111
1112
1113
        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)
1114

1115
1116
1117
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
1118
        cumsum_dtype: np.dtype | None = None,
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
    ) -> 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

1135
    def _prepare_input_ids(
1136
1137
1138
1139
        self,
        scheduler_output: "SchedulerOutput",
        total_num_scheduled_tokens: int,
        cu_num_tokens: np.ndarray,
1140
    ) -> None:
1141
        """Prepare the input IDs for the current batch.
1142

1143
1144
1145
1146
1147
1148
1149
        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)
1150
1151
1152
            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)
1153
1154
1155
1156
1157
1158
1159
            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
1160
1161
1162
1163
        sample_flattened_indices: list[int] = []
        spec_flattened_indices: list[int] = []
        prev_common_req_indices: list[int] = []
        prev_draft_token_indices: list[int] = []
1164
1165
        indices_match = True
        max_flattened_index = -1
1166
1167
1168
        total_num_spec_tokens = 0
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens

1169
1170
1171
1172
1173
        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.
1174
1175
                draft_len = len(scheduled_spec_tokens.get(req_id, ()))
                total_num_spec_tokens += draft_len
1176
                flattened_index = cu_num_tokens[cur_index].item() - 1
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
                # 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))
1192
                indices_match &= prev_index == flattened_index
1193
                max_flattened_index = max(max_flattened_index, flattened_index)
1194
1195
1196
        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:
1197
1198
1199
            # 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)
1200
1201
1202
            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)
1203
1204
        if num_commmon_tokens == 0:
            # No requests in common with the previous iteration
1205
            # So input_ids.cpu will have all the input ids.
1206
1207
1208
1209
1210
1211
1212
            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_(
1213
1214
1215
                self.input_batch.prev_sampled_token_ids[:num_commmon_tokens, 0],
                non_blocking=True,
            )
1216
1217
            if self.enable_prompt_embeds:
                self.is_token_ids.gpu[:num_commmon_tokens] = True
1218
            return
1219
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1220
1221
        sampled_tokens_index_tensor = torch.tensor(
            sample_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
1222
        ).to(self.device, non_blocking=True)
1223
        prev_common_req_indices_tensor = torch.tensor(
1224
1225
            prev_common_req_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1226
1227
        self.input_ids.gpu.scatter_(
            dim=0,
1228
            index=sampled_tokens_index_tensor,
1229
            src=self.input_batch.prev_sampled_token_ids[
1230
1231
1232
                prev_common_req_indices_tensor, 0
            ],
        )
1233

1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
        # 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],
        )

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

        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
1268
        for req_id in num_scheduled_tokens:
1269
            req_index = self.input_batch.req_id_to_index[req_id]
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
            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]
1286

1287
        return encoder_seq_lens, encoder_seq_lens_cpu
1288

1289
    def _prepare_inputs(
1290
1291
1292
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
1293
1294
    ) -> tuple[
        torch.Tensor,
1295
        SpecDecodeMetadata | None,
1296
    ]:
1297
1298
        """
        :return: tuple[
1299
            logits_indices, spec_decode_metadata,
1300
1301
        ]
        """
1302
1303
1304
1305
1306
1307
1308
        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.
1309
        self.input_batch.block_table.commit_block_table(num_reqs)
1310
1311
1312

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

1315
1316
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1317
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1318
1319

        # Get positions.
1320
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1321
1322
1323
1324
1325
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1326

1327
1328
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1329
        if self.uses_mrope:
1330
1331
            self._calc_mrope_positions(scheduler_output)

1332
1333
1334
1335
1336
        # 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)

1337
1338
1339
1340
        # 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.
1341
1342
1343
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1344
        token_indices_tensor = torch.from_numpy(token_indices)
1345

1346
1347
1348
        # 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.
1349
1350
1351
1352
1353
1354
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1355
        if self.enable_prompt_embeds:
1356
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1357
1358
1359
1360
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1361
1362
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395

        # 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:
1396
1397
1398
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1399
1400

                output_idx += num_sched
1401

1402
1403
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1404
1405

        # Prepare the attention metadata.
1406
        self.query_start_loc.np[0] = 0
1407
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1408
1409
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1410
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1411
        self.query_start_loc.copy_to_gpu()
1412
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1413

1414
        self.seq_lens.np[:num_reqs] = (
1415
1416
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1417
        # Fill unused with 0 for full cuda graph mode.
1418
1419
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
1420

1421
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1422
1423
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

1424
        # Record which requests should not be sampled,
1425
        # so that we could clear the sampled tokens before returning
1426
1427
        self.discard_request_mask.np[:num_reqs] = (
            self.seq_lens.np[:num_reqs] < num_tokens_np
1428
        )
1429
        self.discard_request_mask.copy_to_gpu(num_reqs)
1430

1431
        # Copy the tensors to the GPU.
1432
1433
1434
1435
1436
        self._prepare_input_ids(
            scheduler_output,
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
1437

1438
        if self.uses_mrope:
1439
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1440
1441
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1442
1443
                non_blocking=True,
            )
1444
1445
1446
1447
1448
1449
        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,
            )
1450
1451
        else:
            # Common case (1D positions)
1452
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1453

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

1497
1498
1499
1500
1501
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
1502
            )
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
            self.set_active_loras(
                self.input_batch, num_scheduled_tokens, num_sampled_tokens
            )

        return (
            logits_indices,
            spec_decode_metadata,
        )

    def _build_attention_metadata(
        self,
1514
        num_tokens: int,
1515
        num_reqs: int,
1516
1517
1518
        max_query_len: int,
        num_tokens_padded: int | None = None,
        num_reqs_padded: int | None = None,
1519
1520
1521
1522
        ubatch_slices: UBatchSlices | None = None,
        logits_indices: torch.Tensor | None = None,
        use_spec_decode: bool = False,
        for_cudagraph_capture: bool = False,
1523
        num_scheduled_tokens: dict[str, int] | None = None,
1524
1525
1526
1527
1528
        cascade_attn_prefix_lens: list[list[int]] | None = None,
    ) -> tuple[PerLayerAttnMetadata, CommonAttentionMetadata | None]:
        """
        :return: tuple[attn_metadata, spec_decode_common_attn_metadata]
        """
1529
1530
1531
        num_tokens_padded = num_tokens_padded or num_tokens
        num_reqs_padded = num_reqs_padded or num_reqs

1532
        logits_indices_padded = None
1533
        num_logits_indices = None
1534
1535
1536
1537
1538
1539
        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
                )
1540

1541
1542
1543
1544
1545
1546
        # 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,
1547
                self.parallel_config.cp_kv_cache_interleave_size,
1548
            )
1549
1550
            self.dcp_local_seq_lens.cpu[num_reqs:].fill_(0)
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs_padded)
1551

1552
1553
1554
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1555

1556
1557
1558
1559
1560
1561
1562
1563
        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()

1564
1565
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1566
1567
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1568
1569
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1570

1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
        # Used in the below loop, uses padded shapes
        query_start_loc = self.query_start_loc.gpu[: num_reqs_padded + 1]
        query_start_loc_cpu = self.query_start_loc.cpu[: num_reqs_padded + 1]
        seq_lens = self.seq_lens.gpu[:num_reqs_padded]
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs_padded]
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs_padded
        ]

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

        spec_decode_common_attn_metadata = None

1587
1588
        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
1589
        for kv_cache_gid, kv_cache_group in enumerate(
1590
1591
            self.kv_cache_config.kv_cache_groups
        ):
1592
1593
            encoder_seq_lens, encoder_seq_lens_cpu = self._get_encoder_seq_lens(
                num_scheduled_tokens or {},
1594
                kv_cache_group.kv_cache_spec,
1595
                num_reqs_padded,
1596
            )
1597

1598
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
1599
1600
1601
                # 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(
1602
                    (num_reqs_padded, 1),
1603
                    dtype=torch.int32,
1604
1605
1606
                    device=self.device,
                )
                slot_mapping = torch.zeros(
1607
                    (num_tokens_padded,),
1608
1609
1610
                    dtype=torch.int64,
                    device=self.device,
                )
1611
            else:
1612
                blk_table = self.input_batch.block_table[kv_cache_gid]
1613
1614
                blk_table_tensor = blk_table.get_device_tensor(num_reqs_padded)
                slot_mapping = blk_table.slot_mapping.gpu[:num_tokens_padded]
1615
1616

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

1621
            common_attn_metadata = CommonAttentionMetadata(
1622
1623
1624
1625
1626
                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,
1627
1628
1629
                num_actual_tokens=num_tokens_padded,
                num_reqs=num_reqs_padded,
                max_query_len=max_query_len,
1630
                max_seq_len=max_seq_len,
1631
1632
                block_table_tensor=blk_table_tensor,
                slot_mapping=slot_mapping,
1633
                logits_indices_padded=logits_indices_padded,
1634
                num_logits_indices=num_logits_indices,
1635
                causal=True,
1636
                encoder_seq_lens=encoder_seq_lens,
1637
                encoder_seq_lens_cpu=encoder_seq_lens_cpu,
1638
                dcp_local_seq_lens=dcp_local_seq_lens,
1639
                dcp_local_seq_lens_cpu=dcp_local_seq_lens_cpu,
1640
1641
            )

1642
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1643
                if isinstance(self.drafter, EagleProposer):
1644
                    if self.drafter.attn_layer_names[0] in kv_cache_group.layer_names:
1645
1646
1647
                        spec_decode_common_attn_metadata = common_attn_metadata
                else:
                    spec_decode_common_attn_metadata = common_attn_metadata
1648

1649
1650
1651
1652
1653
1654
            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
                )
1655
                builder = attn_group.get_metadata_builder()
1656

1657
                extra_attn_metadata_args = {}
1658
                if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
1659
                    extra_attn_metadata_args = dict(
1660
1661
1662
                        num_accepted_tokens=self.num_accepted_tokens.gpu[
                            :num_reqs_padded
                        ],
1663
                        num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
1664
                            :num_reqs_padded
1665
                        ],
1666
1667
                    )

1668
1669
                if ubatch_slices is not None:
                    common_attn_metadata_list = split_attn_metadata(
1670
1671
                        ubatch_slices, common_attn_metadata
                    )
1672
                    for ubid, common_attn_metadata in enumerate(
1673
1674
                        common_attn_metadata_list
                    ):
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
                        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:
1686
1687
1688
1689
                            assert type(attn_metadata) is list
                            attn_metadata[ubid][layer_name] = attn_metadata_i
                else:
                    assert isinstance(attn_metadata, dict)
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
                    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,
                        )
1700
1701
                    for layer_name in attn_group.layer_names:
                        attn_metadata[layer_name] = attn_metadata_i
1702

1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
        if spec_decode_common_attn_metadata is not None and (
            num_reqs != num_reqs_padded or num_tokens != num_tokens_padded
        ):
            # Currently the drafter still only uses piecewise cudagraphs (and modifies
            # the attention metadata in directly), and therefore does not want to use
            # padded attention metadata.
            spec_decode_common_attn_metadata = (
                spec_decode_common_attn_metadata.unpadded(num_tokens, num_reqs)
            )

1713
        return attn_metadata, spec_decode_common_attn_metadata
1714

1715
1716
1717
    def _compute_cascade_attn_prefix_lens(
        self,
        num_scheduled_tokens: np.ndarray,
1718
        num_computed_tokens: np.ndarray,
1719
1720
1721
1722
1723
1724
1725
        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
        """
1726

1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
        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,
1741
                        num_computed_tokens,
1742
1743
1744
1745
1746
1747
1748
1749
                        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
1750

1751
1752
1753
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
1754
        num_computed_tokens: np.ndarray,
1755
        num_common_prefix_blocks: int,
1756
1757
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
    ) -> 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.
        """
1776

1777
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
        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]
1815
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
1816
1817
1818
1819
1820
        # 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.
1821
        common_prefix_len = min(common_prefix_len, num_computed_tokens.min())
1822
        # common_prefix_len should be a multiple of the block size.
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
        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
        )
1834
1835
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
1836
1837
1838
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
1839
            num_kv_heads=kv_cache_spec.num_kv_heads,
1840
            use_alibi=self.use_alibi,
1841
            use_sliding_window=use_sliding_window,
1842
            use_local_attention=use_local_attention,
1843
            num_sms=self.num_sms,
1844
            dcp_world_size=self.dcp_world_size,
1845
1846
1847
        )
        return common_prefix_len if use_cascade else 0

1848
1849
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
1850
        for index, req_id in enumerate(self.input_batch.req_ids):
1851
1852
1853
            req = self.requests[req_id]
            assert req.mrope_positions is not None

1854
1855
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1856
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
1857
1858
                req.prompt_token_ids, req.prompt_embeds
            )
1859
1860

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
1861
1862
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
            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

1876
1877
1878
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
1879
1880
1881
1882
1883
1884
1885
                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

1886
                assert req.mrope_position_delta is not None
1887
                MRotaryEmbedding.get_next_input_positions_tensor(
1888
                    out=self.mrope_positions.np,
1889
1890
1891
1892
1893
                    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,
                )
1894
1895
1896

                mrope_pos_ptr += completion_part_len

1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
    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

1944
1945
    def _calc_spec_decode_metadata(
        self,
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
        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
1962
1963
1964
1965

        # 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(
1966
1967
            num_sampled_tokens, cumsum_dtype=np.int32
        )
1968
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
1969
        logits_indices = np.repeat(
1970
1971
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
1972
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
1973
1974
1975
1976
1977
1978
        logits_indices += arange

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

        # Compute the draft logits indices.
1979
1980
1981
        # 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(
1982
1983
            num_draft_tokens, cumsum_dtype=np.int32
        )
1984
1985
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
1986
1987
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
1988
1989
1990
1991
1992
        # [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(
1993
1994
            self.device, non_blocking=True
        )
1995
1996
1997
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
1998
1999
2000
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
2001
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
2002
2003
            self.device, non_blocking=True
        )
2004
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
2005
2006
            self.device, non_blocking=True
        )
2007

2008
2009
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
2010
        draft_token_ids = self.input_ids.gpu[logits_indices]
2011
2012
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

2013
        return SpecDecodeMetadata(
2014
2015
2016
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
2017
            cu_num_sampled_tokens=cu_num_sampled_tokens,
2018
2019
2020
2021
2022
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

2023
2024
2025
2026
2027
2028
2029
    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
2030
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
2031
2032
2033
2034
2035
        # 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_(
2036
2037
2038
2039
2040
2041
            logits_indices[-1].item()
        )
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and num_logits <= self.cudagraph_batch_sizes[-1]
        ):
2042
2043
2044
2045
2046
            # 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
2047
2048
2049
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
2050
2051
        return logits_indices_padded

2052
2053
2054
2055
2056
2057
2058
2059
    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
2060
                inputs.
2061
2062
2063
2064
2065
2066

        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
        """
2067
2068
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
2069
            return [], []
2070
        # Batch the multi-modal inputs.
2071
        mm_kwargs = list[MultiModalKwargsItem]()
2072
2073
        # list of tuple (mm_hash, position_info)
        mm_hashes_pos = list[tuple[str, PlaceholderRange]]()
2074
2075
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
2076
2077

            for mm_input_id in encoder_input_ids:
2078
                mm_feature = req_state.mm_features[mm_input_id]
2079
2080
                if mm_feature.data is None:
                    continue
2081
2082
2083
                mm_hash = mm_feature.identifier
                mm_kwargs.append(mm_feature.data)
                mm_hashes_pos.append((mm_hash, mm_feature.mm_position))
2084

2085
2086
        return mm_kwargs, mm_hashes_pos

2087
2088
2089
    def _execute_mm_encoder(
        self, scheduler_output: "SchedulerOutput"
    ) -> list[torch.Tensor]:
2090
2091
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, mm_hashes_pos = self._batch_mm_kwargs_from_scheduler(
2092
2093
            scheduler_output
        )
2094
2095

        if not mm_kwargs:
2096
            return []
2097

2098
2099
2100
2101
2102
2103
2104
        # 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.
2105
        model = cast(SupportsMultiModal, self.model)
2106
        encoder_outputs: list[torch.Tensor] = []
2107
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
2108
2109
2110
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
2111
        ):
2112
            curr_group_outputs: list[torch.Tensor] = []
2113
2114

            # EVS-related change.
2115
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
2116
            # processing multimodal data. This solves the issue with scheduler
2117
2118
2119
2120
            # 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)
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
            # 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,
                        )
2137
                    )
2138

2139
                    micro_batch_outputs = model.embed_multimodal(
2140
2141
                        **micro_batch_mm_inputs
                    )
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151

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

2154
2155
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
2156
                expected_num_items=num_items,
2157
            )
2158
            encoder_outputs.extend(curr_group_outputs)
2159

2160
2161
2162
        # 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(
2163
2164
2165
                output,
                is_embed=pos_info.is_embed,
            )
2166
2167
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
2168

2169
2170
        return encoder_outputs

2171
    def _gather_mm_embeddings(
2172
2173
        self,
        scheduler_output: "SchedulerOutput",
2174
        shift_computed_tokens: int = 0,
2175
2176
2177
2178
2179
2180
2181
2182
    ) -> 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
2183
        should_sync_mrope_positions = False
2184
        should_sync_xdrope_positions = False
2185

2186
        for req_id in self.input_batch.req_ids:
2187
2188
            mm_embeds_req: list[torch.Tensor] = []

2189
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2190
            req_state = self.requests[req_id]
2191
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2192

2193
2194
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2195
2196
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212

                # 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,
2213
2214
                    num_encoder_tokens,
                )
2215
                assert start_idx < end_idx
2216

2217
                mm_hash = mm_feature.identifier
2218
                encoder_output = self.encoder_cache.get(mm_hash, None)
2219
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2220
2221
2222
2223

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

2224
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2225
2226
2227
                is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                    True if is_embed is None else is_embed
                )
2228

2229
2230
2231
2232
                mm_embeds_item = gather_mm_placeholders(
                    encoder_output[start_idx:end_idx],
                    is_embed=is_embed,
                )
2233
2234
2235
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2236
                assert req_state.mrope_positions is not None
2237
2238
2239
2240
2241
2242
2243
                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,
2244
2245
                    )
                )
2246
2247
2248
2249
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
2250
2251
2252
            req_start_idx += num_scheduled_tokens

        is_mm_embed = self.is_mm_embed.copy_to_gpu(total_num_scheduled_tokens)
2253
2254
2255

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
2256
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
2257

2258
2259
2260
2261
        if should_sync_xdrope_positions:
            self._calc_xdrope_positions(scheduler_output)
            self.xdrope_positions.copy_to_gpu(total_num_scheduled_tokens)

2262
        return mm_embeds, is_mm_embed
2263

2264
    def get_model(self) -> nn.Module:
2265
        # get raw model out of the cudagraph wrapper.
2266
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
2267
            return self.model.unwrap()
2268
2269
        return self.model

2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
    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

2285
2286
2287
2288
2289
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

2290
2291
        supported_tasks = list(model.pooler.get_supported_tasks())

2292
2293
2294
2295
        if "score" in supported_tasks:
            num_labels = getattr(self.model_config.hf_config, "num_labels", 0)
            if num_labels != 1:
                supported_tasks.remove("score")
2296
                logger.debug_once("Score API is only enabled for num_labels == 1.")
2297
2298

        return supported_tasks
2299

2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
    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)

2310
    def sync_and_slice_intermediate_tensors(
2311
2312
        self,
        num_tokens: int,
2313
        intermediate_tensors: IntermediateTensors | None,
2314
2315
        sync_self: bool,
    ) -> IntermediateTensors:
2316
2317
2318
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
2319
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
2320
2321
2322
2323
2324
2325

        # 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():
2326
                is_scattered = k == "residual" and is_rs
2327
                copy_len = num_tokens // tp if is_scattered else num_tokens
2328
                self.intermediate_tensors[k][:copy_len].copy_(
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
                    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:
2342
2343
2344
2345
2346
2347
2348
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2349
2350
        model = self.get_model()
        assert is_mixture_of_experts(model)
2351
2352
2353
        self.eplb_state.step(
            is_dummy,
            is_profile,
2354
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2355
2356
        )

2357
2358
2359
2360
2361
2362
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
    ) -> ModelRunnerOutput:
2363
2364
2365
        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"
        )
2366

2367
        hidden_states = hidden_states[:num_scheduled_tokens]
2368
2369
        seq_lens_cpu = self.seq_lens.cpu[: self.input_batch.num_reqs]

2370
        pooling_metadata = self.input_batch.get_pooling_metadata()
2371
        pooling_metadata.build_pooling_cursor(
2372
            num_scheduled_tokens_np.tolist(), seq_lens_cpu, device=hidden_states.device
2373
        )
2374

2375
2376
2377
2378
2379
2380
        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(
2381
            lambda x: x.to("cpu", non_blocking=True) if x is not None else x,
2382
2383
2384
            raw_pooler_output,
        )
        self._sync_device()
2385

2386
        pooler_output: list[torch.Tensor | None] = []
2387
        for raw_output, seq_len, prompt_len in zip(
2388
2389
            raw_pooler_output, seq_lens_cpu, pooling_metadata.prompt_lens
        ):
2390
            output = raw_output if seq_len == prompt_len else None
2391
            pooler_output.append(output)
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401

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

2402
    def _pad_for_sequence_parallelism(self, num_scheduled_tokens: int) -> int:
2403
2404
2405
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
2406
        if self.compilation_config.pass_config.enable_sp and tp_size > 1:
2407
2408
2409
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

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

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

2431
        if self.supports_mm_inputs and is_first_rank and not is_encoder_decoder:
2432
            # Run the multimodal encoder if any.
2433
2434
2435
2436
2437
2438
            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)
2439

2440
2441
2442
            # 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.
2443
            inputs_embeds_scheduled = self.model.embed_input_ids(
2444
2445
2446
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2447
            )
2448

2449
            # TODO(woosuk): Avoid the copy. Optimize.
2450
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2451

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

2494
        if self.uses_mrope:
2495
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2496
2497
        elif self.uses_xdrope_dim > 0:
            positions = self.xdrope_positions.gpu[:, :num_input_tokens]
2498
        else:
2499
            positions = self.positions.gpu[:num_input_tokens]
2500

2501
        if is_first_rank:
2502
2503
            intermediate_tensors = None
        else:
2504
            assert intermediate_tensors is not None
2505
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2506
2507
                num_input_tokens, intermediate_tensors, True
            )
2508

2509
        if is_encoder_decoder and scheduler_output.scheduled_encoder_inputs:
2510
2511
2512
2513
2514
2515
2516
            # 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})
2517

2518
2519
2520
2521
2522
2523
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
2524
            ec_connector_output,
2525
        )
2526

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

2543
        sampler_output = self.rejection_sampler(
2544
2545
            spec_decode_metadata,
            None,  # draft_probs
2546
            logits,
2547
2548
            sampling_metadata,
        )
2549
        self._update_states_after_model_execute(sampler_output.sampled_token_ids)
2550
2551
2552
        return sampler_output

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

2573
2574
2575
2576
        num_reqs = self.input_batch.num_reqs
        discard_sampled_tokens_req_indices = np.nonzero(
            self.discard_request_mask.np[:num_reqs]
        )[0]
2577
2578
2579
2580
        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)
2581

2582
2583
2584
        # 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()
2585
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2586
2587

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2588
        sampled_token_ids = sampler_output.sampled_token_ids
2589
        logprobs_tensors = sampler_output.logprobs_tensors
2590
        invalid_req_indices = []
2591
        cu_num_tokens: list[int] | None = None
2592
2593
2594
2595
2596
2597
        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)
2598
2599
2600
                # Mask out the sampled tokens that should not be sampled.
                for i in discard_sampled_tokens_req_indices:
                    valid_sampled_token_ids[int(i)].clear()
2601
2602
            else:
                # Includes spec decode tokens.
2603
                valid_sampled_token_ids, cu_num_tokens = RejectionSampler.parse_output(
2604
2605
                    sampled_token_ids,
                    self.input_batch.vocab_size,
2606
2607
                    discard_sampled_tokens_req_indices,
                    return_cu_num_tokens=logprobs_tensors is not None,
2608
                )
2609
        else:
2610
            valid_sampled_token_ids = []
2611
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2612
2613
2614
2615
2616
            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.
2617
2618
2619
2620
            # 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
2621
2622
2623
2624
2625
            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
            }
2626

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

2639
            num_sampled_ids: int = len(sampled_ids) if sampled_ids else 0
2640

2641
            if not sampled_ids:
2642
2643
2644
                continue

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

2652
2653
            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
2654
2655
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
            self.input_batch.num_tokens[req_idx] = end_idx
2656

2657
            req_id = req_ids[req_idx]
2658
2659
2660
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

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

2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
        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,
        )

2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
    @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()

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

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

2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
    def _determine_batch_execution_and_padding(
        self,
        num_tokens: int,
        num_reqs: int,
        num_scheduled_tokens_np: np.ndarray,
        max_num_scheduled_tokens: int,
        use_cascade_attn: bool,
        allow_microbatching: bool = True,
        force_eager: bool = False,
        # For cudagraph capture TODO(lucas): Refactor how we capture cudagraphs (will
        # be improved in model runner v2)
        force_uniform_decode: bool | None = None,
        force_has_lora: bool | None = None,
    ) -> tuple[
2744
2745
        CUDAGraphMode,
        BatchDescriptor,
2746
        bool,
2747
2748
        torch.Tensor | None,
        CUDAGraphStat | None,
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
    ]:
        num_tokens_padded = self._pad_for_sequence_parallelism(num_tokens)
        uniform_decode = (
            (
                (max_num_scheduled_tokens == self.uniform_decode_query_len)
                and (num_tokens_padded == max_num_scheduled_tokens * num_reqs)
            )
            if force_uniform_decode is None
            else force_uniform_decode
        )

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

        dispatch_cudagraph = (
            lambda num_tokens: self.cudagraph_dispatcher.dispatch(
                num_tokens=num_tokens,
                has_lora=has_lora,
                use_cascade_attn=use_cascade_attn,
                uniform_decode=uniform_decode,
            )
            if not force_eager
            else (CUDAGraphMode.NONE, BatchDescriptor(num_tokens_padded))
        )

        cudagraph_mode, batch_descriptor = dispatch_cudagraph(num_tokens_padded)
        num_tokens_padded = batch_descriptor.num_tokens

        # Extra coordination when running data-parallel since we need to coordinate
        # across ranks
2782
        should_ubatch, num_tokens_across_dp = False, None
2783
2784
2785
2786
2787
2788
2789
2790
2791
        if self.vllm_config.parallel_config.data_parallel_size > 1:
            # Disable DP padding when running eager to avoid excessive padding when
            # running prefills. This lets us set cudagraph_mode="NONE" on the prefiller
            # in a P/D setup and still use CUDA graphs (enabled by this padding) on the
            # decoder.
            allow_dp_padding = (
                self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            )

2792
2793
            should_ubatch, num_tokens_across_dp = coordinate_batch_across_dp(
                num_tokens_unpadded=num_tokens,
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
                parallel_config=self.parallel_config,
                allow_microbatching=allow_microbatching,
                allow_dp_padding=allow_dp_padding,
                num_tokens_padded=num_tokens_padded,
                uniform_decode=uniform_decode,
                num_scheduled_tokens_per_request=num_scheduled_tokens_np,
            )

            # Extract DP padding if there is any
            if num_tokens_across_dp is not None:
                dp_rank = self.parallel_config.data_parallel_rank
                num_tokens_padded = int(num_tokens_across_dp[dp_rank].item())

                # Re-dispatch with DP padding
                cudagraph_mode, batch_descriptor = dispatch_cudagraph(num_tokens_padded)
                # Assert to make sure the agreed upon token count is correct otherwise
                # num_tokens_across_dp will no-longer be valid
                assert batch_descriptor.num_tokens == num_tokens_padded

2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
        cudagraph_stats = None
        if self.vllm_config.observability_config.cudagraph_metrics:
            cudagraph_stats = CUDAGraphStat(
                num_unpadded_tokens=num_tokens,
                num_padded_tokens=batch_descriptor.num_tokens,
                num_paddings=batch_descriptor.num_tokens - num_tokens,
                runtime_mode=str(cudagraph_mode),
            )

        return (
            cudagraph_mode,
            batch_descriptor,
2825
            should_ubatch,
2826
2827
2828
            num_tokens_across_dp,
            cudagraph_stats,
        )
2829

2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
    def _register_layerwise_nvtx_hooks(self) -> None:
        """
        Register layerwise NVTX hooks if --enable-layerwise-nvtx-tracing is enabled
        to trace detailed information of each layer or module in the model.
        """

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

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

2866
2867
2868
2869
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
2870
        intermediate_tensors: IntermediateTensors | None = None,
2871
2872
2873
2874
2875
2876
    ) -> 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."
            )
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891

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

2892
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2893
        with record_function_or_nullcontext("gpu_model_runner: preprocess"):
2894
2895
2896
2897
            with self.synchronize_input_prep():
                # Update persistent batch states.
                self._update_states(scheduler_output)

2898
2899
2900
2901
2902
2903
2904
2905
                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)

2906
                if not num_scheduled_tokens:
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
                    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.
2918
                        self._dummy_run(1)
2919
2920
2921
2922
                    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(
2923
2924
                        scheduler_output, self.vllm_config
                    )
2925
                if self.cache_config.kv_sharing_fast_prefill:
2926
                    assert not self.num_prompt_logprobs, (
2927
2928
                        "--kv-sharing-fast-prefill produces incorrect "
                        "logprobs for prompt tokens, tokens, please disable "
2929
2930
                        "it when the requests need prompt logprobs"
                    )
2931

2932
2933
2934
2935
2936
                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())
2937
                num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
2938

2939
2940
2941
                (
                    logits_indices,
                    spec_decode_metadata,
2942
                ) = self._prepare_inputs(
2943
2944
                    scheduler_output,
                    num_scheduled_tokens_np,
2945
2946
2947
2948
                )

                cascade_attn_prefix_lens = None
                # Disable cascade attention when using microbatching (DBO)
2949
                if self.cascade_attn_enabled and not self.parallel_config.enable_dbo:
2950
2951
2952
                    # Pre-compute cascade attention prefix lengths
                    cascade_attn_prefix_lens = self._compute_cascade_attn_prefix_lens(
                        num_scheduled_tokens_np,
2953
                        self.input_batch.num_computed_tokens_cpu[:num_reqs],
2954
2955
2956
                        scheduler_output.num_common_prefix_blocks,
                    )

2957
2958
2959
                (
                    cudagraph_mode,
                    batch_desc,
2960
                    should_ubatch,
2961
                    num_tokens_across_dp,
2962
                    cudagraph_stats,
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
                ) = self._determine_batch_execution_and_padding(
                    num_tokens=num_tokens_unpadded,
                    num_reqs=num_reqs,
                    num_scheduled_tokens_np=num_scheduled_tokens_np,
                    max_num_scheduled_tokens=max_num_scheduled_tokens,
                    use_cascade_attn=cascade_attn_prefix_lens is not None,
                )

                logger.debug(
                    "Running batch with cudagraph_mode: %s, batch_descriptor: %s, "
2973
                    "should_ubatch: %s, num_tokens_across_dp: %s",
2974
2975
                    cudagraph_mode,
                    batch_desc,
2976
                    should_ubatch,
2977
2978
2979
2980
2981
2982
2983
                    num_tokens_across_dp,
                )

                num_tokens_padded = batch_desc.num_tokens
                num_reqs_padded = (
                    batch_desc.num_reqs if batch_desc.num_reqs is not None else num_reqs
                )
2984
2985
2986
2987
2988
2989
                ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
                    should_ubatch,
                    num_scheduled_tokens_np,
                    num_tokens_padded,
                    num_reqs_padded,
                )
2990

2991
2992
                pad_attn = cudagraph_mode == CUDAGraphMode.FULL

2993
2994
2995
                use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
                ubatch_slices_attn = ubatch_slices_padded if pad_attn else ubatch_slices

2996
                (attn_metadata, spec_decode_common_attn_metadata) = (
2997
                    self._build_attention_metadata(
2998
2999
                        num_tokens=num_tokens_unpadded,
                        num_tokens_padded=num_tokens_padded if pad_attn else None,
3000
                        num_reqs=num_reqs,
3001
3002
                        num_reqs_padded=num_reqs_padded if pad_attn else None,
                        max_query_len=max_num_scheduled_tokens,
3003
                        ubatch_slices=ubatch_slices_attn,
3004
3005
                        logits_indices=logits_indices,
                        use_spec_decode=use_spec_decode,
3006
                        num_scheduled_tokens=scheduler_output.num_scheduled_tokens,
3007
3008
3009
                        cascade_attn_prefix_lens=cascade_attn_prefix_lens,
                    )
                )
3010

3011
3012
3013
3014
3015
3016
3017
3018
3019
            (
                input_ids,
                inputs_embeds,
                positions,
                intermediate_tensors,
                model_kwargs,
                ec_connector_output,
            ) = self._preprocess(
                scheduler_output, num_tokens_padded, intermediate_tensors
3020
            )
3021

3022
        # Set cudagraph mode to none if calc_kv_scales is true.
3023
3024
3025
        # KV scales calculation involves dynamic operations that are incompatible
        # with CUDA graph capture.
        if self.calculate_kv_scales:
3026
            cudagraph_mode = CUDAGraphMode.NONE
3027
3028
            # Mark KV scales as calculated after the first forward pass
            self.calculate_kv_scales = False
3029

3030
3031
        # Run the model.
        # Use persistent buffers for CUDA graphs.
3032
3033
        with (
            set_forward_context(
3034
3035
                attn_metadata,
                self.vllm_config,
3036
                num_tokens=num_tokens_padded,
3037
                num_tokens_across_dp=num_tokens_across_dp,
3038
3039
                cudagraph_runtime_mode=cudagraph_mode,
                batch_descriptor=batch_desc,
3040
                ubatch_slices=ubatch_slices_padded,
3041
            ),
3042
            record_function_or_nullcontext("gpu_model_runner: forward"),
3043
3044
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
3045
            model_output = self._model_forward(
3046
3047
3048
3049
3050
3051
3052
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

3053
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
3054
            if self.use_aux_hidden_state_outputs:
3055
                # True when EAGLE 3 is used.
3056
3057
                hidden_states, aux_hidden_states = model_output
            else:
3058
                # Common case.
3059
3060
3061
                hidden_states = model_output
                aux_hidden_states = None

3062
3063
3064
3065
3066
            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)
3067
                    hidden_states.kv_connector_output = kv_connector_output
3068
                    self.kv_connector_output = kv_connector_output
3069
                    return hidden_states
3070

3071
                if self.is_pooling_model:
3072
                    # Return the pooling output.
3073
3074
3075
                    output = self._pool(
                        hidden_states, num_scheduled_tokens, num_scheduled_tokens_np
                    )
3076
3077
                    output.kv_connector_output = kv_connector_output
                    return output
3078
3079

                sample_hidden_states = hidden_states[logits_indices]
3080
                logits = self.model.compute_logits(sample_hidden_states)
3081
3082
3083
3084
            else:
                # Rare case.
                assert not self.is_pooling_model

3085
                sample_hidden_states = hidden_states[logits_indices]
3086
                if not get_pp_group().is_last_rank:
3087
                    all_gather_tensors = {
3088
                        "residual": not is_residual_scattered_for_sp(
3089
                            self.vllm_config, num_tokens_padded
3090
                        )
3091
                    }
3092
                    get_pp_group().send_tensor_dict(
3093
3094
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
3095
3096
                        all_gather_tensors=all_gather_tensors,
                    )
3097
3098
                    logits = None
                else:
3099
                    logits = self.model.compute_logits(sample_hidden_states)
3100

3101
                model_output_broadcast_data: dict[str, Any] = {}
3102
3103
3104
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

3105
                broadcasted = get_pp_group().broadcast_tensor_dict(
3106
3107
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
3108
3109
                assert broadcasted is not None
                logits = broadcasted["logits"]
3110

3111
3112
3113
3114
3115
3116
3117
3118
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3119
            ec_connector_output,
3120
            cudagraph_stats,
3121
        )
3122
        self.kv_connector_output = kv_connector_output
3123
3124
3125
3126
3127
3128
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
3129
3130
3131
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

3132
3133
        if self.execute_model_state is None:
            # Nothing to do (PP non-final rank case), output isn't used.
3134
            if not kv_connector_output:
3135
                return None  # type: ignore[return-value]
3136
3137
3138
3139
3140
3141
3142
3143
3144

            # 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
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3155
            ec_connector_output,
3156
            cudagraph_stats,
3157
3158
3159
3160
3161
3162
3163
3164
3165
        ) = 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
            )
3166

3167
        with record_function_or_nullcontext("gpu_model_runner: sample"):
3168
3169
            sampler_output = self._sample(logits, spec_decode_metadata)

3170
3171
        self.input_batch.prev_sampled_token_ids = None

3172
        def propose_draft_token_ids(sampled_token_ids):
3173
            assert spec_decode_common_attn_metadata is not None
3174
            with record_function_or_nullcontext("gpu_model_runner: draft"):
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
                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,
                )

3186
        spec_config = self.speculative_config
3187
        use_padded_batch_for_eagle = (
3188
3189
3190
            spec_config is not None
            and spec_config.use_eagle()
            and not spec_config.disable_padded_drafter_batch
3191
        )
3192
3193
3194
        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
3195
        if (
3196
3197
3198
            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
3199
        ):
3200
            effective_drafter_max_model_len = (
3201
                spec_config.draft_model_config.max_model_len
3202
            )
3203
        input_fits_in_drafter = spec_decode_common_attn_metadata and (
3204
            spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
3205
3206
            <= effective_drafter_max_model_len
        )
3207
        if use_padded_batch_for_eagle:
3208
3209
            assert self.speculative_config is not None
            assert isinstance(self.drafter, EagleProposer)
3210
3211
3212
3213
3214
3215
            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:
3216
                assert spec_decode_common_attn_metadata is not None
3217
3218
3219
3220
3221
3222
                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,
3223
                        self.discard_request_mask.gpu,
3224
3225
3226
3227
3228
                    )
                )
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
3229

3230
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
3231
3232
3233
3234
3235
3236
3237
3238
            (
                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,
3239
3240
3241
3242
3243
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
3244
                scheduler_output.total_num_scheduled_tokens,
3245
                spec_decode_metadata,
3246
            )
3247

3248
3249
3250
3251
3252
        if (
            self.speculative_config
            and not use_padded_batch_for_eagle
            and input_fits_in_drafter
        ):
3253
3254
3255
            # 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)
3256

3257
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
3258
            self.eplb_step()
3259
3260
3261
3262
3263
3264
3265
3266
3267
        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,
3268
3269
3270
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
3271
                num_nans_in_logits=num_nans_in_logits,
3272
                cudagraph_stats=cudagraph_stats,
3273
            )
3274

3275
3276
        if not self.use_async_scheduling:
            return output
3277
3278
3279
3280
3281
3282
3283
3284
3285
        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,
3286
                vocab_size=self.input_batch.vocab_size,
3287
3288
3289
3290
3291
            )
        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
3292
            # any requests with sampling params that require output ids.
3293
3294
3295
3296
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
3297
3298
3299

        return async_output

3300
    def take_draft_token_ids(self) -> DraftTokenIds | None:
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
        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)

3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
    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()

3342
3343
3344
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
3345
        sampled_token_ids: torch.Tensor | list[list[int]],
3346
3347
3348
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
3349
3350
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3351
        common_attn_metadata: CommonAttentionMetadata,
3352
    ) -> list[list[int]] | torch.Tensor:
3353
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3354
3355
3356
        spec_config = self.speculative_config
        assert spec_config is not None
        if spec_config.method == "ngram":
3357
            assert isinstance(sampled_token_ids, list)
3358
            assert isinstance(self.drafter, NgramProposer)
3359
            draft_token_ids = self.drafter.propose(
3360
3361
                sampled_token_ids,
                self.input_batch.req_ids,
3362
3363
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
3364
3365
                self.input_batch.spec_decode_unsupported_reqs,
            )
3366
        elif spec_config.method == "suffix":
3367
3368
3369
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
            draft_token_ids = self.drafter.propose(self.input_batch, sampled_token_ids)
3370
        elif spec_config.method == "medusa":
3371
            assert isinstance(sampled_token_ids, list)
3372
            assert isinstance(self.drafter, MedusaProposer)
3373

3374
3375
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
3376
3377
3378
3379
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
3380
3381
3382
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
3383
                for num_draft, tokens in zip(
3384
3385
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
3386
                    indices.append(offset + len(tokens) - 1)
3387
                    offset += num_draft + 1
3388
                indices = torch.tensor(indices, device=self.device)
3389
3390
                hidden_states = sample_hidden_states[indices]

3391
            draft_token_ids = self.drafter.propose(
3392
3393
3394
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
            )
3395
        elif spec_config.use_eagle():
3396
            assert isinstance(self.drafter, EagleProposer)
3397

3398
            if spec_config.disable_padded_drafter_batch:
3399
3400
3401
                # 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.
3402
3403
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
3404
                    "padded-batch is disabled."
3405
                )
3406
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
3407
3408
3409
3410
3411
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
3412
3413
3414
3415
3416
            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.
3417
3418
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
3419
                    "padded-batch is enabled."
3420
3421
                )
                next_token_ids, valid_sampled_tokens_count = (
3422
3423
3424
3425
3426
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
3427
                        self.discard_request_mask.gpu,
3428
                    )
3429
                )
3430
3431
3432
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
3433

3434
            if spec_decode_metadata is None:
3435
                token_indices_to_sample = None
3436
                # input_ids can be None for multimodal models.
3437
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
3438
                target_positions = self._get_positions(num_scheduled_tokens)
3439
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3440
                    assert aux_hidden_states is not None
3441
                    target_hidden_states = torch.cat(
3442
3443
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
3444
3445
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
3446
            else:
3447
                if spec_config.disable_padded_drafter_batch:
3448
                    token_indices_to_sample = None
3449
3450
3451
3452
3453
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
3454
3455
3456
3457
3458
3459
3460
3461
3462
                    target_token_ids = self.input_ids.gpu[token_indices]
                    target_positions = self._get_positions(token_indices)
                    if self.use_aux_hidden_state_outputs:
                        assert aux_hidden_states is not None
                        target_hidden_states = torch.cat(
                            [h[token_indices] for h in aux_hidden_states], dim=-1
                        )
                    else:
                        target_hidden_states = hidden_states[token_indices]
3463
                else:
3464
                    common_attn_metadata, token_indices_to_sample = (
3465
3466
3467
                        self.drafter.prepare_inputs_padded(
                            common_attn_metadata,
                            spec_decode_metadata,
3468
3469
3470
                            valid_sampled_tokens_count,
                        )
                    )
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
                    total_num_tokens = common_attn_metadata.num_actual_tokens
                    # When padding the batch, token_indices is just a range
                    target_token_ids = self.input_ids.gpu[:total_num_tokens]
                    target_positions = self._get_positions(total_num_tokens)
                    if self.use_aux_hidden_state_outputs:
                        assert aux_hidden_states is not None
                        target_hidden_states = torch.cat(
                            [h[:total_num_tokens] for h in aux_hidden_states], dim=-1
                        )
                    else:
                        target_hidden_states = hidden_states[:total_num_tokens]
3482

3483
            if self.supports_mm_inputs:
3484
3485
3486
3487
3488
3489
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
3490

3491
            draft_token_ids = self.drafter.propose(
3492
3493
3494
3495
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
3496
                last_token_indices=token_indices_to_sample,
3497
                sampling_metadata=sampling_metadata,
3498
                common_attn_metadata=common_attn_metadata,
3499
                mm_embed_inputs=mm_embed_inputs,
3500
            )
3501

3502
        return draft_token_ids
3503

3504
3505
3506
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
3507
3508
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
3509
                f"Allowed configs: {allowed_config_names}"
3510
            )
3511
3512
3513
3514
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

3515
3516
3517
3518
3519
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
3520
3521
3522
3523
3524
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
3525
3526
3527
3528
3529
        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)
        )
3530

3531
3532
3533
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0
3534
        with DeviceMemoryProfiler() as m:
3535
            time_before_load = time.perf_counter()
3536
            model_loader = get_model_loader(self.load_config)
3537
            self.model = model_loader.load_model(
3538
3539
                vllm_config=self.vllm_config, model_config=self.model_config
            )
3540
            if self.lora_config:
3541
3542
3543
                self.model = self.load_lora_model(
                    self.model, self.vllm_config, self.device
                )
3544
            if hasattr(self, "drafter"):
3545
                logger.info_once("Loading drafter model...")
3546
                self.drafter.load_model(self.model)
3547
3548
3549
3550
3551
                if (
                    hasattr(self.drafter, "model")
                    and is_mixture_of_experts(self.drafter.model)
                    and self.parallel_config.enable_eplb
                ):
3552
3553
3554
                    spec_config = self.vllm_config.speculative_config
                    assert spec_config is not None
                    assert spec_config.draft_model_config is not None
3555
3556
                    logger.info_once(
                        "EPLB is enabled for drafter model %s.",
3557
                        spec_config.draft_model_config.model,
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
                    )

                    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,
3574
                        spec_config.draft_model_config,
3575
3576
3577
3578
3579
3580
                        global_expert_load,
                        old_global_expert_indices,
                        rank_mapping,
                    )
                    eplb_models += 1

3581
            if self.use_aux_hidden_state_outputs:
3582
                if not supports_eagle3(self.get_model()):
3583
3584
                    raise RuntimeError(
                        "Model does not support EAGLE3 interface but "
3585
3586
                        "aux_hidden_state_outputs was requested"
                    )
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599

                # 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)
3600
            time_after_load = time.perf_counter()
3601
        self.model_memory_usage = m.consumed_memory
3602
        logger.info_once(
3603
            "Model loading took %.4f GiB memory and %.6f seconds",
3604
3605
            self.model_memory_usage / GiB_bytes,
            time_after_load - time_before_load,
3606
            scope="local",
3607
        )
3608
        prepare_communication_buffer_for_model(self.model)
3609
3610
3611
3612
        if (drafter := getattr(self, "drafter", None)) and (
            drafter_model := getattr(drafter, "model", None)
        ):
            prepare_communication_buffer_for_model(drafter_model)
3613
        mm_config = self.model_config.multimodal_config
3614
        self.is_multimodal_pruning_enabled = (
3615
            supports_multimodal_pruning(self.get_model())
3616
3617
            and mm_config is not None
            and mm_config.is_multimodal_pruning_enabled()
3618
        )
3619

3620
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
            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(
3632
                self.model,
3633
                self.model_config,
3634
3635
3636
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
3637
            )
3638
3639
            if self.eplb_state.is_async:
                self.eplb_state.start_async_loop(rank_mapping=rank_mapping)
3640

3641
        if (
3642
3643
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
3644
            and supports_dynamo()
3645
        ):
3646
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
3647
            compilation_counter.stock_torch_compile_count += 1
3648
            self.model.compile(fullgraph=True, backend=backend)
3649
            return
3650
        # for other compilation modes, cudagraph behavior is controlled by
3651
3652
3653
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
3654
3655
3656
        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:
3657
3658
3659
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
3660
        elif self.parallel_config.enable_dbo:
3661
            if cudagraph_mode.has_full_cudagraphs():
3662
3663
3664
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
3665
            else:
3666
3667
3668
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
3669

3670
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
        """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

3694
    def reload_weights(self) -> None:
3695
        assert getattr(self, "model", None) is not None, (
3696
            "Cannot reload weights before model is loaded."
3697
        )
3698
3699
        model_loader = get_model_loader(self.load_config)
        logger.info("Reloading weights inplace...")
3700
        model_loader.load_weights(self.get_model(), model_config=self.model_config)
3701

3702
3703
3704
3705
3706
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
3707
            self.get_model(),
3708
            tensorizer_config=tensorizer_config,
3709
            model_config=self.model_config,
3710
3711
        )

3712
3713
3714
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
3715
        num_scheduled_tokens: dict[str, int],
3716
    ) -> dict[str, LogprobsTensors | None]:
3717
        num_prompt_logprobs_dict = self.num_prompt_logprobs
3718
3719
3720
        if not num_prompt_logprobs_dict:
            return {}

3721
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
3722
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
3723
3724
3725
3726
3727

        # 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():
3728
3729
3730
3731
            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
3732
3733
3734

            # Get metadata for this request.
            request = self.requests[req_id]
3735
3736
3737
3738
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

3739
3740
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
3741
3742
                self.device, non_blocking=True
            )
3743

3744
3745
3746
3747
3748
3749
            # 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(
3750
3751
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
3752
3753
                in_progress_dict[req_id] = logprobs_tensors

3754
            # Determine number of logits to retrieve.
3755
3756
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
3757
            num_remaining_tokens = num_prompt_tokens - start_tok
3758
            if num_tokens <= num_remaining_tokens:
3759
                # This is a chunk, more tokens remain.
3760
3761
3762
                # 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.
3763
3764
3765
3766
3767
                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)
3768
3769
3770
3771
3772
3773
3774
                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
3775
3776
3777
3778
3779

            # 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]
3780
            offset = self.query_start_loc.np[req_idx].item()
3781
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
3782
            logits = self.model.compute_logits(prompt_hidden_states)
3783
3784
3785
3786

            # 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.
3787
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
3788
3789

            # Compute prompt logprobs.
3790
3791
            logprobs = self.sampler.compute_logprobs(logits)
            token_ids, logprobs, ranks = self.sampler.gather_logprobs(
3792
3793
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
3794
3795

            # Transfer GPU->CPU async.
3796
3797
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
3798
3799
3800
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
3801
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
3802
3803
                ranks, non_blocking=True
            )
3804
3805
3806
3807
3808

        # 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]
3809
            del in_progress_dict[req_id]
3810
3811

        # Must synchronize the non-blocking GPU->CPU transfers.
3812
        if prompt_logprobs_dict:
3813
            self._sync_device()
3814
3815
3816

        return prompt_logprobs_dict

3817
3818
    def _get_nans_in_logits(
        self,
3819
        logits: torch.Tensor | None,
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
    ) -> 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])
3831
3832
3833
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
3834
3835
3836
3837
            return num_nans_in_logits
        except IndexError:
            return {}

3838
3839
3840
3841
3842
3843
    @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
3844
         - during DP rank dummy run
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
        """
        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(
3856
                    self.input_ids.gpu,
3857
3858
                    low=0,
                    high=self.model_config.get_vocab_size(),
3859
3860
                    dtype=input_ids.dtype,
                )
3861

3862
            logger.debug_once("Randomizing dummy data for DP Rank")
3863
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
3864
3865
3866
            yield
            input_ids.fill_(0)

3867
3868
3869
3870
3871
3872
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
3873
3874
        assert self.mm_budget is not None

3875
3876
        dummy_decoder_data = self.mm_registry.get_decoder_dummy_data(
            model_config=self.model_config,
3877
            seq_len=self.max_model_len,
3878
            mm_counts={modality: 1},
3879
            cache=self.mm_budget.cache,
3880
3881
3882
3883
        )
        dummy_mm_data = dummy_decoder_data.multi_modal_data

        # Result in the maximum GPU consumption of the model
3884
3885
        dummy_mm_item = dummy_mm_data[modality][0]
        dummy_mm_items = [dummy_mm_item] * max_items_per_batch
3886

3887
3888
3889
3890
3891
3892
3893
3894
        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,
            )
        )
3895

3896
3897
3898
3899
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
3900
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
3901
3902
        force_attention: bool = False,
        uniform_decode: bool = False,
3903
        allow_microbatching: bool = True,
3904
3905
        skip_eplb: bool = False,
        is_profile: bool = False,
3906
        create_mixed_batch: bool = False,
3907
        remove_lora: bool = True,
3908
        activate_lora: bool = False,
Rémi Delacourt's avatar
Rémi Delacourt committed
3909
        is_graph_capturing: bool = False,
3910
    ) -> tuple[torch.Tensor, torch.Tensor]:
3911
3912
3913
3914
3915
3916
3917
        """
        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.
3918
                - if not set will determine the cudagraph mode based on using
3919
                    the self.cudagraph_dispatcher.
3920
3921
3922
3923
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
3924
            force_attention: If True, always create attention metadata. Used to
3925
3926
3927
3928
                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.
3929
3930
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
3931
            remove_lora: If False, dummy LoRAs are not destroyed after the run
3932
            activate_lora: If False, dummy_run is performed without LoRAs.
3933
        """
3934
3935
3936
3937
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
3938

3939
        # If cudagraph_mode.decode_mode() == FULL and
3940
        # cudagraph_mode.separate_routine(). This means that we are using
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
        # 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.
3952
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
3953

3954
3955
3956
3957
3958
        # 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
3959
3960
3961
3962
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
3963
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
3964
3965
3966
3967
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
3968
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
3969
3970
3971
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
3972
            assert not create_mixed_batch
3973
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
3974
3975
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
3976
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
3977
3978
3979
3980
3981
3982
        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

3983
3984
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
3985
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
3986
3987
        num_tokens_unpadded = int(num_scheduled_tokens.sum())

3988
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
3989

3990
        _cudagraph_mode, batch_desc, should_ubatch, num_tokens_across_dp, _ = (
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
            self._determine_batch_execution_and_padding(
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs,
                num_scheduled_tokens_np=num_scheduled_tokens,
                max_num_scheduled_tokens=max_query_len,
                use_cascade_attn=False,
                allow_microbatching=allow_microbatching,
                force_eager=is_profile
                or (cudagraph_runtime_mode == CUDAGraphMode.NONE),
                # `force_uniform_decode` is used for cudagraph capture; because for
                # capturing mixed prefill-decode batches, we sometimes use
                # num_tokens == num_reqs which looks like a uniform decode batch to the
                # dispatcher; but we actually want to capture a piecewise cudagraph
                force_uniform_decode=uniform_decode,
                # `force_has_lora` is used for cudagraph capture; because LoRA is
                # activated later in the context manager, but we need to know the
                # LoRA state when determining the batch descriptor for capture
                force_has_lora=activate_lora,
4009
4010
            )
        )
4011
4012
4013

        if cudagraph_runtime_mode is None:
            cudagraph_runtime_mode = _cudagraph_mode
4014
        else:
4015
4016
4017
4018
4019
4020
4021
4022
4023
            assert cudagraph_runtime_mode == _cudagraph_mode, (
                f"Cudagraph runtime mode mismatch in dummy_run. "
                f"Expected {_cudagraph_mode}, but got {cudagraph_runtime_mode}."
            )

        num_tokens_padded = batch_desc.num_tokens
        num_reqs_padded = (
            batch_desc.num_reqs if batch_desc.num_reqs is not None else num_reqs
        )
4024
4025
4026
        ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
            should_ubatch, num_scheduled_tokens, num_tokens_padded, num_reqs_padded
        )
4027

4028
        attn_metadata: PerLayerAttnMetadata | None = None
4029
4030
4031

        # If force_attention is True, we always capture attention. Otherwise,
        # it only happens for cudagraph_runtime_mode=FULL.
4032
        if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
4033
4034
4035
4036
4037
4038
            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:
4039
                seq_lens = max_query_len  # type: ignore[assignment]
4040
            self.seq_lens.np[:num_reqs] = seq_lens
4041
4042
            self.seq_lens.np[num_reqs:] = 0
            self.seq_lens.copy_to_gpu()
4043

4044
4045
            cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
            self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
4046
4047
            self.query_start_loc.copy_to_gpu()

4048
            pad_attn = cudagraph_runtime_mode == CUDAGraphMode.FULL
4049
            attn_metadata, _ = self._build_attention_metadata(
4050
4051
4052
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs_padded,
                max_query_len=max_query_len,
4053
                ubatch_slices=ubatch_slices_padded if pad_attn else ubatch_slices,
4054
                for_cudagraph_capture=is_graph_capturing,
4055
            )
4056

4057
        with self.maybe_dummy_run_with_lora(
4058
4059
4060
4061
4062
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            activate_lora,
            remove_lora,
4063
        ):
4064
            # Make sure padding doesn't exceed max_num_tokens
4065
4066
            assert num_tokens_padded <= self.max_num_tokens
            model_kwargs = self._init_model_kwargs(num_tokens_padded)
4067
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
4068
                input_ids = None
4069
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_padded]
4070
                model_kwargs = {
4071
                    **model_kwargs,
4072
4073
                    **self._dummy_mm_kwargs(num_reqs),
                }
4074
4075
            elif self.enable_prompt_embeds:
                input_ids = None
4076
4077
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_padded]
                model_kwargs = self._init_model_kwargs(num_tokens_padded)
4078
            else:
4079
                input_ids = self.input_ids.gpu[:num_tokens_padded]
4080
                inputs_embeds = None
4081

4082
            if self.uses_mrope:
4083
                positions = self.mrope_positions.gpu[:, :num_tokens_padded]
4084
            elif self.uses_xdrope_dim > 0:
4085
                positions = self.xdrope_positions.gpu[:, :num_tokens_padded]
4086
            else:
4087
                positions = self.positions.gpu[:num_tokens_padded]
4088
4089
4090
4091
4092
4093
4094
4095
4096

            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,
4097
4098
4099
                            device=self.device,
                        )
                    )
4100
4101

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
4102
                    num_tokens_padded, None, False
4103
                )
4104

4105
            if ubatch_slices_padded is not None:
4106
4107
4108
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
4109
                num_tokens_padded = ubatch_slices_padded[0].num_tokens
4110
                if num_tokens_across_dp is not None:
4111
                    num_tokens_across_dp[:] = num_tokens_padded
4112

4113
4114
4115
            with (
                self.maybe_randomize_inputs(input_ids),
                set_forward_context(
4116
4117
                    attn_metadata,
                    self.vllm_config,
4118
                    num_tokens=num_tokens_padded,
4119
4120
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4121
                    batch_descriptor=batch_desc,
4122
                    ubatch_slices=ubatch_slices_padded,
4123
4124
                ),
            ):
4125
                outputs = self.model(
4126
4127
4128
4129
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
4130
                    **model_kwargs,
4131
                )
4132

4133
4134
4135
4136
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
4137

4138
            if self.speculative_config and self.speculative_config.use_eagle():
4139
                assert isinstance(self.drafter, EagleProposer)
4140
                use_cudagraphs = (
Rémi Delacourt's avatar
Rémi Delacourt committed
4141
                    cudagraph_runtime_mode.has_mode(CUDAGraphMode.PIECEWISE)
4142
4143
                    and not self.speculative_config.enforce_eager
                )
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154

                # 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
4155
                    is_graph_capturing=is_graph_capturing,
4156
                )
4157

4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
        # We register layerwise NVTX hooks here after the first dynamo tracing is
        # done to avoid nvtx operations in hook functions being traced by
        # torch dynamo and causing graph breaks.
        # Note that for DYNAMO_ONCE and VLLM_COMPILE mode,
        # compiled model's dynamo tracing is only done once and the compiled model's
        # __call__ function is replaced by calling the compiled function.
        # So it's safe to register hooks here. Hooks will be registered to
        # both compiled and uncompiled models but they will never
        # be called on the compiled model execution path.
        self._register_layerwise_nvtx_hooks()

4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
        # 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)

4179
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
4180
4181
4182
4183
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
4184
4185
4186
4187
4188
4189

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
4190
4191
4192
4193
        # 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)
4194

4195
        logits = self.model.compute_logits(hidden_states)
4196
4197
        num_reqs = logits.size(0)

4198
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213

        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)],
4214
            spec_token_ids=[[] for _ in range(num_reqs)],
4215
4216
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
4217
            logitsprocs=LogitsProcessors(),
4218
        )
4219
        try:
4220
4221
4222
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
4223
        except RuntimeError as e:
4224
            if "out of memory" in str(e):
4225
4226
4227
4228
                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 "
4229
4230
                    "initializing the engine."
                ) from e
4231
4232
            else:
                raise e
4233
        if self.speculative_config:
4234
4235
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
4236
4237
                draft_token_ids, self.device
            )
4238
4239
4240
4241
4242
4243

            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
4244
4245
4246
4247
4248
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
4249
            )
4250
4251
4252
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
4253
                logits,
4254
4255
                dummy_metadata,
            )
4256
        return sampler_output
4257

4258
    def _dummy_pooler_run_task(
4259
4260
        self,
        hidden_states: torch.Tensor,
4261
4262
        task: PoolingTask,
    ) -> PoolerOutput:
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
        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

4274
        dummy_prompt_lens = torch.tensor(
4275
4276
            num_scheduled_tokens_list,
            device="cpu",
4277
        )
4278
4279
4280
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
4281

4282
        model = cast(VllmModelForPooling, self.get_model())
4283
        dummy_pooling_params = PoolingParams(task=task)
4284
        dummy_pooling_params.verify(task=task, model_config=self.model_config)
4285
        to_update = model.pooler.get_pooling_updates(task)
4286
4287
        to_update.apply(dummy_pooling_params)

4288
        dummy_metadata = PoolingMetadata(
4289
4290
4291
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
4292
            pooling_states=[PoolingStates() for i in range(num_reqs)],
4293
        )
4294

4295
        dummy_metadata.build_pooling_cursor(
4296
4297
4298
            num_scheduled_tokens_list,
            seq_lens_cpu=dummy_prompt_lens,
            device=hidden_states.device,
4299
        )
4300

4301
        try:
4302
4303
4304
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
4305
        except RuntimeError as e:
4306
            if "out of memory" in str(e):
4307
                raise RuntimeError(
4308
4309
4310
                    "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 "
4311
4312
                    "initializing the engine."
                ) from e
4313
4314
            else:
                raise e
4315
4316
4317
4318
4319
4320
4321

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

        if not supported_pooling_tasks:
4325
4326
4327
4328
4329
4330
            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."
            )
4331

4332
        output_size = dict[PoolingTask, float]()
4333
        for task in supported_pooling_tasks:
4334
4335
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
4336
            output_size[task] = sum(o.nbytes for o in output)
4337
4338
4339
4340
            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)
4341

4342
    def profile_run(self) -> None:
4343
        # Profile with multimodal encoder & encoder cache.
4344
        if self.supports_mm_inputs:
4345
4346
            mm_config = self.model_config.multimodal_config
            if mm_config is not None and mm_config.skip_mm_profiling:
4347
                logger.info(
4348
                    "Skipping memory profiling for multimodal encoder and "
4349
4350
                    "encoder cache."
                )
4351
4352
4353
4354
4355
4356
4357
4358
            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.
4359
                    dummy_modality = mm_budget.get_modality_with_max_tokens()
4360
4361
4362
                    max_mm_items_per_batch = mm_budget.max_items_per_batch_by_modality[
                        dummy_modality
                    ]
4363
4364
4365
4366
4367
4368
4369
4370
4371

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

4373
4374
4375
4376
4377
                    # Create dummy batch of multimodal inputs.
                    batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                        dummy_modality,
                        max_mm_items_per_batch,
                    )
4378

4379
                    # Run multimodal encoder.
4380
                    dummy_encoder_outputs = self.model.embed_multimodal(
4381
4382
                        **batched_dummy_mm_inputs
                    )
4383

4384
4385
4386
4387
                    sanity_check_mm_encoder_outputs(
                        dummy_encoder_outputs,
                        expected_num_items=max_mm_items_per_batch,
                    )
4388

4389
4390
4391
                    # 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
4392
4393
                    # (max_tokens_for_modality, hidden_size) and scatter
                    # encoder output into it.
4394
                    encoder_output_shape = dummy_encoder_outputs[0].shape
4395
4396
4397
4398
4399
                    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]
4400
4401
4402
                        expanded_outputs = []
                        for output in dummy_encoder_outputs:
                            expanded = output.new_zeros(
4403
                                (max_mm_tokens_per_item, encoder_hidden_size)
4404
                            )
4405
4406
4407
4408
4409
4410
                            num_tokens = output.shape[0]
                            expanded[:num_tokens].copy_(output)
                            expanded_outputs.append(expanded)

                        dummy_encoder_outputs = expanded_outputs

4411
                    # Cache the dummy encoder outputs.
4412
                    self.encoder_cache["tmp"] = dict(enumerate(dummy_encoder_outputs))
4413

4414
        # Add `is_profile` here to pre-allocate communication buffers
4415
4416
4417
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
4418
        if get_pp_group().is_last_rank:
4419
4420
4421
4422
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
4423
        else:
4424
            output = None
4425
        self._sync_device()
4426
        del hidden_states, output
4427
        self.encoder_cache.clear()
4428
        gc.collect()
4429

4430
    def capture_model(self) -> int:
4431
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
4432
            logger.warning(
4433
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
4434
4435
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
4436
            return 0
4437

4438
4439
        compilation_counter.num_gpu_runner_capture_triggers += 1

4440
4441
        start_time = time.perf_counter()

4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
        @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()
4456
                    gc.collect()
4457

4458
4459
4460
        # 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.
4461
        set_cudagraph_capturing_enabled(True)
4462
        with freeze_gc(), graph_capture(device=self.device):
4463
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
4464
            cudagraph_mode = self.compilation_config.cudagraph_mode
4465
            assert cudagraph_mode is not None
4466
4467
4468
4469
4470
4471
4472
4473
4474

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

4475
4476
            if cudagraph_mode.mixed_mode() != CUDAGraphMode.NONE:
                cudagraph_runtime_mode = cudagraph_mode.mixed_mode()
4477
                # make sure we capture the largest batch size first
4478
4479
4480
                compilation_cases = list(
                    product(reversed(self.cudagraph_batch_sizes), lora_cases)
                )
4481
4482
4483
                self._capture_cudagraphs(
                    compilation_cases,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4484
4485
                    uniform_decode=False,
                )
4486

4487
4488
            # Capture full cudagraph for uniform decode batches if we
            # don't already have full mixed prefill-decode cudagraphs.
4489
4490
4491
4492
4493
4494
4495
            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
                )
4496
                decode_cudagraph_batch_sizes = [
4497
4498
                    x
                    for x in self.cudagraph_batch_sizes
4499
                    if max_num_tokens >= x >= self.uniform_decode_query_len
4500
                ]
4501
4502
4503
                compilation_cases_decode = list(
                    product(reversed(decode_cudagraph_batch_sizes), lora_cases)
                )
4504
4505
4506
                self._capture_cudagraphs(
                    compilation_cases=compilation_cases_decode,
                    cudagraph_runtime_mode=CUDAGraphMode.FULL,
4507
4508
                    uniform_decode=True,
                )
4509

4510
4511
4512
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

4513
4514
4515
        # 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
4516
        # we may do lazy capturing in future that still allows capturing
4517
4518
        # after here.
        set_cudagraph_capturing_enabled(False)
4519
4520
4521
4522
4523

        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.
4524
        logger.info_once(
4525
4526
4527
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
4528
            scope="local",
4529
        )
4530
        return cuda_graph_size
4531

4532
4533
    def _capture_cudagraphs(
        self,
4534
        compilation_cases: list[tuple[int, bool]],
4535
4536
4537
4538
4539
4540
4541
        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}"
4542
4543
4544
4545
4546
4547
4548
4549

        # 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",
4550
4551
4552
                    cudagraph_runtime_mode.name,
                ),
            )
4553

4554
        # We skip EPLB here since we don't want to record dummy metrics
4555
        for num_tokens, activate_lora in compilation_cases:
4556
            # We currently only capture ubatched graphs when its a FULL
4557
4558
4559
            # 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
4560
4561
4562
4563
            allow_microbatching = (
                self.parallel_config.enable_dbo
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
4564
4565
4566
4567
4568
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
4569
            )
4570

4571
4572
4573
4574
4575
4576
            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.
4577
4578
4579
4580
4581
4582
4583
4584
4585
                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,
4586
                    activate_lora=activate_lora,
4587
4588
4589
4590
4591
4592
4593
4594
                )
            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,
4595
                activate_lora=activate_lora,
Rémi Delacourt's avatar
Rémi Delacourt committed
4596
                is_graph_capturing=True,
4597
            )
4598
        self.maybe_remove_all_loras(self.lora_config)
4599

4600
4601
4602
4603
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
4604
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
4605

4606
4607
4608
4609
4610
4611
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
4612
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
4613
            layer_type = cast(type[Any], AttentionLayerBase)
4614
            layers = get_layers_from_vllm_config(
4615
                self.vllm_config, layer_type, kv_cache_group_spec.layer_names
4616
            )
4617
4618
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
4619
            # Dedupe based on full class name; this is a bit safer than
4620
4621
4622
4623
            # 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.
4624
            for layer_name in kv_cache_group_spec.layer_names:
4625
                attn_backend = layers[layer_name].get_attn_backend()
4626
4627
4628
4629

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
4630
                        attn_backend,  # type: ignore[arg-type]
4631
4632
                    )

4633
4634
4635
                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):
4636
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
4637
                key = (full_cls_name, layer_kv_cache_spec)
4638
4639
4640
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
4641
                attn_backend_layers[key].append(layer_name)
4642
4643
4644
4645
            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()),
            )
4646
4647

        def create_attn_groups(
4648
            attn_backends_map: dict[AttentionGroupKey, list[str]],
4649
            kv_cache_group_id: int,
4650
4651
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
4652
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
4653
                attn_group = AttentionGroup(
4654
                    attn_backend,
4655
                    layer_names,
4656
                    kv_cache_spec,
4657
                    kv_cache_group_id,
4658
4659
                )

4660
4661
4662
                attn_groups.append(attn_group)
            return attn_groups

4663
        attention_backend_maps = []
4664
        attention_backend_list = []
4665
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
4666
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
4667
            attention_backend_maps.append(attn_backends[0])
4668
            attention_backend_list.append(attn_backends[1])
4669
4670

        # Resolve cudagraph_mode before actually initialize metadata_builders
4671
4672
4673
        self._check_and_update_cudagraph_mode(
            attention_backend_list, kv_cache_config.kv_cache_groups
        )
4674

4675
4676
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
4677

4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
    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
4696
        # Calculate reorder batch threshold (if needed)
4697
4698
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
4699
4700
        self.calculate_reorder_batch_threshold()

4701
    def _check_and_update_cudagraph_mode(
4702
4703
4704
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
4705
    ) -> None:
4706
        """
4707
        Resolve the cudagraph_mode when there are multiple attention
4708
        groups with potential conflicting CUDA graph support.
4709
4710
4711
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
4712
        min_cg_support = AttentionCGSupport.ALWAYS
4713
        min_cg_backend_name = None
4714

4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
        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__
4727
4728
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
4729
        assert cudagraph_mode is not None
4730
        # check cudagraph for mixed batch is supported
4731
4732
4733
4734
4735
4736
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4737
                f"with {min_cg_backend_name} backend (support: "
4738
4739
                f"{min_cg_support})"
            )
4740
4741
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
4742
4743
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
4744
                    "make sure compilation mode is VLLM_COMPILE"
4745
                )
4746
4747
4748
4749
4750
                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"
4751
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4752
                    CUDAGraphMode.FULL_AND_PIECEWISE
4753
                )
4754
4755
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
4756
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4757
                    CUDAGraphMode.FULL_DECODE_ONLY
4758
                )
4759
4760
            logger.warning(msg)

4761
        # check that if we are doing decode full-cudagraphs it is supported
4762
4763
4764
4765
4766
4767
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4768
                f"with {min_cg_backend_name} backend (support: "
4769
4770
                f"{min_cg_support})"
            )
4771
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
4772
4773
4774
4775
4776
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
4777
                    "attention is compiled piecewise"
4778
4779
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4780
                    CUDAGraphMode.PIECEWISE
4781
                )
4782
            else:
4783
4784
                msg += (
                    "; setting cudagraph_mode=NONE because "
4785
                    "attention is not compiled piecewise"
4786
4787
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4788
                    CUDAGraphMode.NONE
4789
                )
4790
4791
            logger.warning(msg)

4792
4793
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
4794
4795
4796
4797
4798
4799
4800
4801
        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 "
4802
                f"{min_cg_backend_name} (support: {min_cg_support})"
4803
            )
4804
4805
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
4806
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4807
                    CUDAGraphMode.PIECEWISE
4808
                )
4809
4810
            else:
                msg += "; setting cudagraph_mode=NONE"
4811
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4812
                    CUDAGraphMode.NONE
4813
                )
4814
4815
4816
4817
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
4818
4819
4820
4821
4822
4823
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
4824
                f"supported with {min_cg_backend_name} backend ("
4825
4826
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
4827
                "and make sure compilation mode is VLLM_COMPILE"
4828
            )
4829

4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
        # 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
            )
4844
4845
4846
4847
            capture_sizes = self.compilation_config.cudagraph_capture_sizes
            self.cudagraph_batch_sizes = (
                capture_sizes if capture_sizes is not None else []
            )
4848

4849
4850
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
4851
        self.compilation_config.cudagraph_mode = cudagraph_mode
4852
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
4853
            cudagraph_mode, self.uniform_decode_query_len
4854
        )
4855

4856
4857
    def calculate_reorder_batch_threshold(self) -> None:
        """
4858
4859
4860
4861
        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.
4862
        """
4863
4864
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

4865
        reorder_batch_thresholds: list[int | None] = [
4866
4867
4868
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
4869
4870
4871
4872
4873
        # 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
4874
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)  # type: ignore[assignment]
4875

4876
4877
4878
    @staticmethod
    def select_common_block_size(
        kv_manager_block_size: int, attn_groups: list[AttentionGroup]
4879
4880
    ) -> int:
        """
4881
4882
4883
4884
4885
        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.
4886
4887
4888
4889
4890
4891

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

        Returns:
4892
            The selected block size
4893
4894

        Raises:
4895
            ValueError: If no valid block size found
4896
4897
        """

4898
4899
4900
4901
4902
4903
4904
4905
        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
4906
                for supported_size in backend.get_supported_kernel_block_sizes():
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
                    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
4937
            for supported_size in backend.get_supported_kernel_block_sizes()
4938
4939
            if isinstance(supported_size, int)
        )
4940

4941
4942
4943
4944
4945
4946
        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}. ")
4947

4948
4949
4950
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
4951
4952
4953
4954
4955
4956
4957
        """
        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.
4958
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4959
4960
4961
4962
        """
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
4963
            if not isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec)
4964
        ]
4965
4966
4967
4968

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
4969
4970
4971
            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
4972
4973
                "for more details."
            )
4974
4975
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
4976
                max_model_len=max(self.max_model_len, self.max_encoder_len),
4977
4978
4979
4980
4981
                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,
4982
                kernel_block_sizes=kernel_block_sizes,
4983
                is_spec_decode=bool(self.vllm_config.speculative_config),
4984
                logitsprocs=self.input_batch.logitsprocs,
4985
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
4986
                is_pooling_model=self.is_pooling_model,
4987
                num_speculative_tokens=self.num_spec_tokens,
4988
4989
            )

4990
    def _allocate_kv_cache_tensors(
4991
4992
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
4993
        """
4994
4995
4996
        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.

4997
        Args:
4998
            kv_cache_config: The KV cache config
4999
        Returns:
5000
            dict[str, torch.Tensor]: A map between layer names to their
5001
            corresponding memory buffer for KV cache.
5002
        """
5003
5004
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
5005
5006
5007
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
5008
5009
5010
5011
5012
            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:
5013
5014
5015
5016
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
5017
5018
5019
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
5020
5021
        return kv_cache_raw_tensors

5022
5023
5024
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

5025
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
5026
5027
        if not self.kv_cache_config.kv_cache_groups:
            return
5028
5029
        for attn_groups in self.attn_groups:
            yield from attn_groups
5030

5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
    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 = []
5046
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
5047
5048
5049
5050
5051
5052
            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):
5053
                continue
5054
            elif isinstance(kv_cache_spec, AttentionSpec):
5055
5056
5057
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
5058
                attn_groups = self.attn_groups[kv_cache_gid]
5059
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
5060
                selected_kernel_size = self.select_common_block_size(
5061
5062
5063
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
5064
            elif isinstance(kv_cache_spec, MambaSpec):
5065
5066
                # This is likely Mamba or other non-attention cache,
                # no splitting.
5067
                kernel_block_sizes.append(kv_cache_spec.block_size)
5068
5069
5070
5071
5072
5073
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

5074
5075
5076
5077
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
5078
        kernel_block_sizes: list[int],
5079
    ) -> dict[str, torch.Tensor]:
5080
        """
5081
        Reshape the KV cache tensors to the desired shape and dtype.
5082

5083
        Args:
5084
5085
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
5086
                correct size but uninitialized shape.
5087
            kernel_block_sizes: The kernel block sizes for each KV cache group.
5088
        Returns:
5089
            Dict[str, torch.Tensor]: A map between layer names to their
5090
5091
            corresponding memory buffer for KV cache.
        """
5092
        kv_caches: dict[str, torch.Tensor] = {}
5093
        has_attn, has_mamba = False, False
5094
5095
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5096
            attn_backend = group.backend
5097
5098
5099
5100
            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]
5101
            for layer_name in group.layer_names:
5102
5103
                if layer_name in self.runner_only_attn_layers:
                    continue
5104
5105
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
5106
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
5107
                if isinstance(kv_cache_spec, AttentionSpec):
5108
                    has_attn = True
5109
5110
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
5111
5112
5113
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

5114
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
5115
                        kernel_num_blocks,
5116
                        kernel_block_size,
5117
5118
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
5119
5120
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
5121
                    dtype = kv_cache_spec.dtype
5122
                    try:
5123
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
5124
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
5125
                    except (AttributeError, NotImplementedError):
5126
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
5127
5128
5129
5130
5131
                    # 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.
5132
5133
5134
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
5135
5136
5137
5138
5139
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
5140
5141
5142
5143
5144
5145
                    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
5146
                elif isinstance(kv_cache_spec, MambaSpec):
5147
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
5148
5149
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
5150
                    storage_offset_bytes = 0
5151
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
5152
5153
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
5154
5155
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
5156
                        target_shape = (num_blocks, *shape)
5157
5158
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
5159
                        assert storage_offset_bytes % dtype_size == 0
5160
5161
5162
5163
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
5164
                            storage_offset=storage_offset_bytes // dtype_size,
5165
                        )
Chen Zhang's avatar
Chen Zhang committed
5166
                        state_tensors.append(tensor)
5167
                        storage_offset_bytes += stride[0] * dtype_size
5168
5169

                    kv_caches[layer_name] = state_tensors
5170
                else:
5171
                    raise NotImplementedError
5172
5173

        if has_attn and has_mamba:
5174
            self._update_hybrid_attention_mamba_layout(kv_caches)
5175

5176
5177
        return kv_caches

5178
    def _update_hybrid_attention_mamba_layout(
5179
5180
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
5181
        """
5182
5183
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
5184
5185

        Args:
5186
            kv_caches: The KV cache buffer of each layer.
5187
5188
        """

5189
5190
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5191
            for layer_name in group.layer_names:
5192
                kv_cache = kv_caches[layer_name]
5193
5194
5195
5196
                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 "
5197
                        f"a tensor of shape {kv_cache.shape}"
5198
                    )
5199
                    hidden_size = kv_cache.shape[2:].numel()
5200
5201
5202
5203
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
5204

5205
    def initialize_kv_cache_tensors(
5206
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
5207
    ) -> dict[str, torch.Tensor]:
5208
5209
5210
5211
5212
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
5213
5214
            kernel_block_sizes: The kernel block sizes for each KV cache group.

5215
        Returns:
5216
            Dict[str, torch.Tensor]: A map between layer names to their
5217
5218
            corresponding memory buffer for KV cache.
        """
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242

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

5244
        # Set up cross-layer KV cache sharing
5245
5246
        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)
5247
5248
            kv_caches[layer_name] = kv_caches[target_layer_name]

5249
5250
5251
5252
5253
5254
5255
5256
5257
        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,
        )
5258
5259
5260
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
5261
5262
        self, kv_cache_config: KVCacheConfig
    ) -> None:
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
        """
        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.
5281
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
5282
5283
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
5284
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
5285
5286
                else:
                    break
5287

5288
5289
5290
5291
5292
5293
5294
    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
        """
5295
        kv_cache_config = deepcopy(kv_cache_config)
5296
        self.kv_cache_config = kv_cache_config
5297
        self.may_add_encoder_only_layers_to_kv_cache_config()
5298
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
5299
        self.initialize_attn_backend(kv_cache_config)
5300
5301
5302
5303
5304
5305
        # 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)
5306
5307
5308
5309

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

5310
        # Reinitialize need to after initialize_attn_backend
5311
5312
5313
5314
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
5315

5316
5317
5318
5319
5320
5321
        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
5322
        if has_kv_transfer_group():
5323
            kv_transfer_group = get_kv_transfer_group()
5324
5325
5326
5327
5328
5329
5330
            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)
5331
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
5332

5333
        if self.dcp_world_size > 1:
5334
5335
            layer_type = cast(type[Any], AttentionLayerBase)
            layers = get_layers_from_vllm_config(self.vllm_config, layer_type)
5336
            for layer in layers.values():
5337
5338
5339
5340
                layer_impl = getattr(layer, "impl", None)
                if layer_impl is None:
                    continue
                assert layer_impl.need_to_return_lse_for_decode, (
5341
5342
                    "DCP requires attention impls to return"
                    " the softmax lse for decode, but the impl "
5343
                    f"{layer_impl.__class__.__name__} "
5344
5345
                    "does not return the softmax lse for decode."
                )
5346

5347
5348
5349
5350
5351
    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
5352
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
5353
5354
5355
        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:
5356
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
5357
5358
5359
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
5360
5361
                    dtype=self.kv_cache_dtype,
                )
5362
5363
5364
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
5365
5366
5367
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
5368
5369
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
5370
5371
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
5372

5373
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
5374
        """
5375
        Generates the KVCacheSpec by parsing the kv cache format from each
5376
5377
        Attention module in the static forward context.
        Returns:
5378
            KVCacheSpec: A dictionary mapping layer names to their KV cache
5379
5380
            format. Layers that do not need KV cache are not included.
        """
5381
5382
        if has_ec_transfer() and get_ec_transfer().is_producer:
            return {}
5383
        kv_cache_spec: dict[str, KVCacheSpec] = {}
5384
5385
        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
5386
        for layer_name, attn_module in attn_layers.items():
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
            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
5402

5403
        return kv_cache_spec
5404

5405
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
5406
5407
5408
5409
5410
5411
5412
5413
        # 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.
5414
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
5415
5416
5417
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
5418
        return pinned.tolist()