gpu_model_runner.py 219 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
8
from collections import defaultdict
from collections.abc import Iterator
9
from contextlib import contextmanager
10
from copy import copy, deepcopy
11
from functools import reduce
12
from itertools import product
13
from typing import TYPE_CHECKING, Any, NamedTuple, TypeAlias, cast
14
15
16
17
18

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

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

152
153
154
155
156
157
158
159
160
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,
)
161

162
if TYPE_CHECKING:
163
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
164
    from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
165
166
167

logger = init_logger(__name__)

168
169
AttnMetadataDict: TypeAlias = dict[str, AttentionMetadata]
# list when ubatching is enabled
170
PerLayerAttnMetadata: TypeAlias = list[AttnMetadataDict] | AttnMetadataDict
171

172

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

        # 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
193
        self.vocab_size = vocab_size
194
        self._logprobs_tensors = logprobs_tensors
195
196
197
198
199

        # 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)
200
            self.sampled_token_ids_cpu = self._sampled_token_ids.to(
201
202
                "cpu", non_blocking=True
            )
203
204
205
206
207
            self._logprobs_tensors_cpu = (
                self._logprobs_tensors.to_cpu_nonblocking()
                if self._logprobs_tensors
                else None
            )
208
            self.async_copy_ready_event.record()
209
210
211

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

213
214
        This function blocks until the copy is finished.
        """
215
        self.async_copy_ready_event.synchronize()
216

217
218
        # Release the device tensors once the copy has completed.
        del self._logprobs_tensors
219
        del self._sampled_token_ids
220
221
222
223
224
225
226
227
228
229
        max_gen_len = self.sampled_token_ids_cpu.shape[-1]
        if max_gen_len == 1:
            valid_sampled_token_ids: list[np.ndarray] = [
                row for row in self.sampled_token_ids_cpu.numpy()
            ]
        else:
            valid_sampled_token_ids = RejectionSampler.parse_output(
                self.sampled_token_ids_cpu,
                self.vocab_size,
            )
230
        for i in self._invalid_req_indices:
Cyrus Leung's avatar
Cyrus Leung committed
231
            valid_sampled_token_ids[i] = np.array([])
232
233
234

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
235
236
237
238
        if self._logprobs_tensors_cpu:
            # NOTE(nick): this will need to be updated to use cu_num_accepted_tokens
            # for async sched + spec decode + logprobs compatibility.
            output.logprobs = self._logprobs_tensors_cpu.tolists()
239
240
241
        return output


242
243
244
245
246
247
248
249
250
251
252
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
253
    ec_connector_output: ECConnectorOutput | None
254
255


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

275
        from vllm.model_executor.models.utils import set_cpu_offload_max_bytes
276
277

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

279
280
281
282
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
283
        self.device = device
284
285
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
286
287
288
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
289

290
        self.is_pooling_model = model_config.runner_type == "pooling"
291
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
292
        self.is_multimodal_raw_input_only_model = (
293
294
            model_config.is_multimodal_raw_input_only_model
        )
295
296
        # This will be overridden in load_model()
        self.is_multimodal_pruning_enabled = False
297
        self.max_model_len = model_config.max_model_len
298
299
300

        # Always set to false after the first forward pass
        self.calculate_kv_scales = self.cache_config.calculate_kv_scales
301
        self.dcp_world_size = self.parallel_config.decode_context_parallel_size
302
        self.dcp_rank = 0 if self.dcp_world_size <= 1 else get_dcp_group().rank_in_group
303
        self.max_num_tokens = scheduler_config.max_num_batched_tokens
304
        self.max_num_reqs = scheduler_config.max_num_seqs
305

306
307
308
309
310
        # 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 = (
311
312
313
            self.parallel_config.distributed_executor_backend == "external_launcher"
            and len(get_pp_group().ranks) > 0
        )
314

315
        # Model-related.
316
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
317
        self.hidden_size = model_config.get_hidden_size()
318
        self.attention_chunk_size = model_config.attention_chunk_size
319
        # Only relevant for models using ALiBi (e.g, MPT)
320
        self.use_alibi = model_config.uses_alibi
321

322
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
323

324
        # Multi-modal data support
325
        self.mm_registry = MULTIMODAL_REGISTRY
326
        self.uses_mrope = model_config.uses_mrope
327
        self.uses_custom_attention_masks = model_config.uses_custom_attention_masks
328
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
329
330
            model_config
        )
331

332
333
334
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
335
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
336
337
338
        else:
            self.max_encoder_len = 0

339
        # Sampler
340
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
341

342
        self.eplb_state: EplbState | None = None
343
344
345
346
347
348
        """
        State of the expert parallelism load balancer.

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

349
        # Lazy initializations
350
        # self.model: nn.Module  # Set after load_model
351
        # Initialize in initialize_kv_cache
352
        self.kv_caches: list[torch.Tensor] = []
353
354
        # indexes: [kv_cache_group_id][attn_group]
        self.attn_groups: list[list[AttentionGroup]] = []
355
356
        # self.kv_cache_config: KVCacheConfig

357
358
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
359

360
        self.use_aux_hidden_state_outputs = False
361
362
363
364
365
        # 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:
366
367
368
            self.drafter: (
                NgramProposer | SuffixDecodingProposer | EagleProposer | MedusaProposer
            )
369
370
            if self.speculative_config.method == "ngram":
                self.drafter = NgramProposer(self.vllm_config)
371
372
            elif self.speculative_config.method == "suffix":
                self.drafter = SuffixDecodingProposer(self.vllm_config)
373
            elif self.speculative_config.use_eagle():
374
                self.drafter = EagleProposer(self.vllm_config, self.device, self)
375
376
377
378
                if self.speculative_config.method == "eagle3":
                    self.use_aux_hidden_state_outputs = True
            elif self.speculative_config.method == "medusa":
                self.drafter = MedusaProposer(
379
                    vllm_config=self.vllm_config, device=self.device
380
                )
381
            else:
382
383
384
385
                raise ValueError(
                    "Unknown speculative decoding method: "
                    f"{self.speculative_config.method}"
                )
386
            self.rejection_sampler = RejectionSampler(self.sampler)
387

388
389
390
391
        self.num_spec_tokens = 0
        if self.speculative_config:
            self.num_spec_tokens = self.speculative_config.num_speculative_tokens

392
        # Request states.
393
        self.requests: dict[str, CachedRequestState] = {}
394
        self.comm_stream = torch.cuda.Stream()
395

396
397
398
399
400
401
402
403
404
        # 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.
405
        custom_logitsprocs = model_config.logits_processors
406
407
        self.input_batch = InputBatch(
            max_num_reqs=self.max_num_reqs,
408
409
410
            # 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),
411
412
413
            max_num_batched_tokens=self.max_num_tokens,
            device=self.device,
            pin_memory=self.pin_memory,
414
            vocab_size=self.model_config.get_vocab_size(),
415
            block_sizes=[self.cache_config.block_size],
416
            kernel_block_sizes=[self.cache_config.block_size],
417
            is_spec_decode=bool(self.vllm_config.speculative_config),
418
            logitsprocs=build_logitsprocs(
419
420
421
                self.vllm_config,
                self.device,
                self.pin_memory,
422
                self.is_pooling_model,
423
                custom_logitsprocs,
424
            ),
425
426
427
            # 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),
428
            is_pooling_model=self.is_pooling_model,
429
            dcp_kv_cache_interleave_size=self.parallel_config.dcp_kv_cache_interleave_size,
430
        )
431

432
        self.use_async_scheduling = self.scheduler_config.async_scheduling
433
434
435
436
437
        # 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.
438
        self.prepare_inputs_event: torch.Event | None = None
439
440
        if self.use_async_scheduling:
            self.async_output_copy_stream = torch.cuda.Stream()
441
            self.prepare_inputs_event = torch.Event()
442

443
        # self.cudagraph_batch_sizes sorts in ascending order.
444
445
446
447
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
448
449
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
450
            )
451

452
        # Cache the device properties.
453
        self._init_device_properties()
454

455
        # Persistent buffers for CUDA graphs.
456
457
458
459
460
        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
        )
461
        self.seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
462
463
464
465
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
466
467
468
        # 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.
469
470
471
472
473
474
475
        self.inputs_embeds = self._make_buffer(
            self.max_num_tokens, self.hidden_size, dtype=self.dtype, numpy=False
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
        self.discard_request_indices = self._make_buffer(
            self.max_num_reqs, dtype=torch.int64
        )
476
477
        self.num_discarded_requests = 0

478
479
480
481
482
483
        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
        )
484

485
486
        # Only relevant for multimodal models
        if self.supports_mm_inputs:
487
            self.is_mm_embed = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
488

489
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
490
        if self.uses_mrope:
Roger Wang's avatar
Roger Wang committed
491
492
493
494
            # 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
495
496
497
498
499
500

            # 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
501
            self.mrope_positions = self._make_buffer(
502
503
                (3, self.max_num_tokens + 1), dtype=torch.int64
            )
504

505
        # None in the first PP rank. The rest are set after load_model.
506
        self.intermediate_tensors: IntermediateTensors | None = None
507

508
        # OPTIMIZATION: Cache the tensors rather than creating them every step.
509
        # Keep in int64 to avoid overflow with long context
510
511
512
513
        self.arange_np = np.arange(
            max(self.max_num_reqs + 1, self.max_model_len, self.max_num_tokens),
            dtype=np.int64,
        )
514

515
516
517
518
519
        # 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] = {}
520
521
522
523
524
        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(
525
526
                self.max_num_tokens, dtype=torch.int32, device=self.device
            )
527

528
        self.uniform_decode_query_len = 1 + self.num_spec_tokens
529
530
531
532

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

533
534
535
536
537
538
539
540
541
        self.mm_budget = (
            MultiModalBudget(
                self.model_config,
                self.scheduler_config,
                self.mm_registry,
            )
            if self.supports_mm_inputs
            else None
        )
542

543
        self.reorder_batch_threshold: int | None = None
544

545
546
547
548
549
        # 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()

550
        # Cached outputs.
551
        self._draft_token_ids: list[list[int]] | torch.Tensor | None = None
552
        self.transfer_event = torch.Event()
553
        self.sampled_token_ids_pinned_cpu = torch.empty(
554
            (self.max_num_reqs, 1),
555
556
            dtype=torch.int64,
            device="cpu",
557
558
            pin_memory=self.pin_memory,
        )
559

560
561
        # Pre-allocated tensor for copying valid sampled token counts to CPU,
        # with dedicated stream for overlapping and event for coordination.
562
        self.valid_sampled_token_count_event: torch.Event | None = None
563
564
        self.valid_sampled_token_count_copy_stream: torch.cuda.Stream | None = None
        if self.use_async_scheduling and self.num_spec_tokens:
565
            self.valid_sampled_token_count_event = torch.Event()
566
567
568
569
570
571
572
573
            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,
        )

574
575
        # Ephemeral state transferred between execute_model() and sample_tokens().
        self.execute_model_state: ExecuteModelState | None = None
576
        self.kv_connector_output: KVConnectorOutput | None = None
577

578
579
580
581
    def reset_mm_cache(self) -> None:
        if self.mm_budget:
            self.mm_budget.reset_cache()

582
583
584
585
586
587
588
589
590
591
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
            return self.positions.gpu[:num_tokens]
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
            return self.positions.gpu[num_tokens]

592
    def _make_buffer(
593
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
594
595
596
597
598
599
600
601
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
602

603
604
605
    def _init_model_kwargs(self, num_tokens: int):
        model_kwargs = dict[str, Any]()

606
        if not self.is_pooling_model:
607
608
            return model_kwargs

609
610
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
611
612
613

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
614
615
616
617
618
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
619
620
621
622
623
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

624
        seq_lens = self.seq_lens.gpu[:num_reqs]
625
626
627
628
629
630
631
632
        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(
633
634
            device=self.device
        )
635
636
        return model_kwargs

637
    def _may_reorder_batch(self, scheduler_output: "SchedulerOutput") -> None:
638
639
        """
        Update the order of requests in the batch based on the attention
640
        backend's needs. For example, some attention backends (namely MLA) may
641
642
643
644
645
646
        want to separate requests based on if the attention computation will be
        compute-bound or memory-bound.

        Args:
            scheduler_output: The scheduler output.
        """
647
648
649
650
651
652
653
654
        # 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

655
656
657
658
        if self.reorder_batch_threshold is not None:
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
659
660
                decode_threshold=self.reorder_batch_threshold,
            )
661

662
663
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
664
        """Initialize attributes from torch.cuda.get_device_properties"""
665
666
667
668
669
670
671
        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()

672
    def _update_states(self, scheduler_output: "SchedulerOutput") -> None:
673
674
675
676
677
678
        """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.

679
680
        The SamplingMetadata is updated and copied to the GPU if there is a
        new/resumed/paused/finished request in the batch.
681
682
        """
        # Remove finished requests from the cached states.
683
684
        for req_id in scheduler_output.finished_req_ids:
            self.requests.pop(req_id, None)
685
686
687
688
689
690
691
        # 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:
692
            self.input_batch.remove_request(req_id)
693
694

        # Free the cached encoder outputs.
695
696
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
697

698
699
700
701
702
703
704
705
706
707
708
709
710
        # Remove the unscheduled requests from the persistent batch.
        # NOTE(woosuk): The unscheduled requests are either preempted requests
        # or running requests that are not scheduled in this step. We remove
        # them from the persistent batch but keep their cached states since
        # they will be scheduled again sometime in the future.
        scheduled_req_ids = scheduler_output.num_scheduled_tokens.keys()
        cached_req_ids = self.input_batch.req_id_to_index.keys()
        unscheduled_req_ids = cached_req_ids - scheduled_req_ids
        # NOTE(woosuk): The persistent batch optimization assumes that
        # consecutive batches contain mostly the same requests. If batches
        # have low request overlap (e.g., alternating between two distinct
        # sets of requests), this optimization becomes very inefficient.
        for req_id in unscheduled_req_ids:
711
            self.input_batch.remove_request(req_id)
712

713
        reqs_to_add: list[CachedRequestState] = []
714
        # Add new requests to the cached states.
715
716
717
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
            sampling_params = new_req_data.sampling_params
718
            pooling_params = new_req_data.pooling_params
719

720
721
722
723
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
724
725
726
727
728
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

729
730
            if self.is_pooling_model:
                assert pooling_params is not None
731
732
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
733

734
                model = cast(VllmModelForPooling, self.get_model())
735
                to_update = model.pooler.get_pooling_updates(task)
736
737
                to_update.apply(pooling_params)

738
            req_state = CachedRequestState(
739
                req_id=req_id,
740
                prompt_token_ids=new_req_data.prompt_token_ids,
741
                prompt_embeds=new_req_data.prompt_embeds,
742
                mm_features=new_req_data.mm_features,
743
                sampling_params=sampling_params,
744
                pooling_params=pooling_params,
745
                generator=generator,
746
747
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
748
                output_token_ids=[],
749
                lora_request=new_req_data.lora_request,
750
            )
751
752
            self.requests[req_id] = req_state

753
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
754
            if self.uses_mrope:
755
                self._init_mrope_positions(req_state)
756

757
            reqs_to_add.append(req_state)
758

759
        # Update the states of the running/resumed requests.
760
        is_last_rank = get_pp_group().is_last_rank
761
        req_data = scheduler_output.scheduled_cached_reqs
762
763
764
765
766

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

767
        for i, req_id in enumerate(req_data.req_ids):
768
            req_state = self.requests[req_id]
769
770
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
771
            resumed_from_preemption = req_id in req_data.resumed_req_ids
772
            num_output_tokens = req_data.num_output_tokens[i]
773
            req_index = self.input_batch.req_id_to_index.get(req_id)
774

775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
            # 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)
798

799
            # Update the cached states.
800
            req_state.num_computed_tokens = num_computed_tokens
801
802
803
804
805
806
807
808

            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.
809
810
811
                num_new_tokens = (
                    num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                )
812
813
814
815
                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:
816
                    req_state.output_token_ids.extend(new_token_ids[-num_new_tokens:])
817
818
819
820
821
            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:
822
823
824
825
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
826
827
                    self.input_batch.num_tokens[req_index] = end_idx
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
828

829
            # Update the block IDs.
830
            if not resumed_from_preemption:
831
832
                if new_block_ids is not None:
                    # Append the new blocks to the existing block IDs.
833
                    for block_ids, new_ids in zip(req_state.block_ids, new_block_ids):
834
                        block_ids.extend(new_ids)
835
            else:
836
                assert req_index is None
837
                assert new_block_ids is not None
838
839
                # The request is resumed from preemption.
                # Replace the existing block IDs with the new ones.
840
                req_state.block_ids = new_block_ids
841
842
843
844
845

            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.
846
847
848
849
850
851
852

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

853
                reqs_to_add.append(req_state)
854
855
856
                continue

            # Update the persistent batch.
857
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
858
            if new_block_ids is not None:
859
                self.input_batch.block_table.append_row(new_block_ids, req_index)
860
861
862
863
864
865
866

            # 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)
867
                self.input_batch.token_ids_cpu[
868
869
870
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
871
                self.input_batch.num_tokens[req_index] = end_token_index
872

873
            # Add spec_token_ids to token_ids_cpu.
874
            spec_token_ids = scheduler_output.scheduled_spec_decode_tokens.get(
875
                req_id, []
876
            )
877
878
879
880
881
            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:
882
883
884
                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[
885
886
                    req_index, start_index:end_token_index
                ] = spec_token_ids
887
888
                # NOTE(woosuk): `num_tokens` here may include spec tokens.
                self.input_batch.num_tokens[req_index] += num_spec_tokens
889
890
891
892
893
894
895

            # 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.
            self.input_batch.spec_token_ids[req_index] = spec_token_ids
896

897
898
899
900
901
902
903
904
905
            # 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)
906
907
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
908
909
        for request in reqs_to_add:
            self.input_batch.add_request(request)
910

911
912
913
914
915
916
        # 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()
917

918
    def _update_states_after_model_execute(
919
920
        self, output_token_ids: torch.Tensor
    ) -> None:
921
922
923
924
925
926
927
928
929
930
931
932
        """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.
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
        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()
        )
953
954
955
        for i, num_tokens in enumerate(num_accepted_tokens):
            self.input_batch.num_accepted_tokens_cpu[i] = num_tokens

956
    def _init_mrope_positions(self, req_state: CachedRequestState):
957
958
        model = self.get_model()
        assert supports_mrope(model), "M-RoPE support is not implemented."
959
960

        req_state.mrope_positions, req_state.mrope_position_delta = (
961
            model.get_mrope_input_positions(
962
                req_state.prompt_token_ids,
963
                req_state.mm_features,
964
            )
965
        )
966

967
    def _extract_mm_kwargs(
968
        self,
969
970
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
971
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
972
            return {}
973

974
975
        mm_kwargs = list[MultiModalKwargsItem]()
        for req in scheduler_output.scheduled_new_reqs:
976
977
978
            for feature in req.mm_features:
                if feature.data is not None:
                    mm_kwargs.append(feature.data)
979

980
        # Input all modalities at once
981
        model = cast(SupportsMultiModal, self.model)
982
983
        mm_kwargs_combined: BatchedTensorInputs = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
984
985
986
987
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
988
            multimodal_cpu_fields=model.multimodal_cpu_fields,
989
990
        ):
            mm_kwargs_combined.update(mm_kwargs_group)
991

992
        return mm_kwargs_combined
993

994
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
995
        if not self.is_multimodal_raw_input_only_model:
996
            return {}
997

998
999
1000
1001
1002
        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)
1003

1004
1005
1006
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
1007
        cumsum_dtype: np.dtype | None = None,
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
    ) -> 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

1024
    def _prepare_input_ids(
1025
1026
1027
1028
        self,
        scheduler_output: "SchedulerOutput",
        total_num_scheduled_tokens: int,
        cu_num_tokens: np.ndarray,
1029
    ) -> None:
1030
        """Prepare the input IDs for the current batch.
1031

1032
1033
1034
1035
1036
1037
1038
        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)
1039
1040
1041
            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)
1042
1043
1044
1045
1046
1047
1048
            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
1049
1050
1051
1052
        sample_flattened_indices: list[int] = []
        spec_flattened_indices: list[int] = []
        prev_common_req_indices: list[int] = []
        prev_draft_token_indices: list[int] = []
1053
1054
        indices_match = True
        max_flattened_index = -1
1055
1056
1057
        total_num_spec_tokens = 0
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens

1058
1059
1060
1061
1062
        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.
1063
1064
                draft_len = len(scheduled_spec_tokens.get(req_id, ()))
                total_num_spec_tokens += draft_len
1065
                flattened_index = cu_num_tokens[cur_index].item() - 1
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
                # 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))
1081
                indices_match &= prev_index == flattened_index
1082
                max_flattened_index = max(max_flattened_index, flattened_index)
1083
1084
1085
        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:
1086
1087
1088
            # 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)
1089
1090
1091
            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)
1092
1093
        if num_commmon_tokens == 0:
            # No requests in common with the previous iteration
1094
            # So input_ids.cpu will have all the input ids.
1095
1096
1097
1098
1099
1100
1101
            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_(
1102
1103
1104
                self.input_batch.prev_sampled_token_ids[:num_commmon_tokens, 0],
                non_blocking=True,
            )
1105
1106
            if self.enable_prompt_embeds:
                self.is_token_ids.gpu[:num_commmon_tokens] = True
1107
            return
1108
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1109
1110
        sampled_tokens_index_tensor = torch.tensor(
            sample_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
1111
        ).to(self.device, non_blocking=True)
1112
        prev_common_req_indices_tensor = torch.tensor(
1113
1114
            prev_common_req_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1115
1116
        self.input_ids.gpu.scatter_(
            dim=0,
1117
            index=sampled_tokens_index_tensor,
1118
            src=self.input_batch.prev_sampled_token_ids[
1119
1120
1121
                prev_common_req_indices_tensor, 0
            ],
        )
1122

1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
        # 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],
        )

1146
1147
    def _get_encoder_seq_lens(
        self,
1148
        scheduled_encoder_inputs: dict[str, list[int]],
1149
1150
        kv_cache_spec: KVCacheSpec,
        num_reqs: int,
1151
    ) -> np.ndarray | None:
1152
1153
1154
1155
1156
1157
        if not isinstance(kv_cache_spec, CrossAttentionSpec):
            return None

        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
        encoder_seq_lens = np.zeros(num_reqs, dtype=np.int32)
1158
        for req_id in scheduled_encoder_inputs:
1159
1160
1161
1162
1163
            req_index = self.input_batch.req_id_to_index[req_id]
            encoder_seq_lens[req_index] = self.max_encoder_len

        return encoder_seq_lens

1164
    def _prepare_inputs(
1165
1166
1167
1168
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
        max_num_scheduled_tokens: int,
1169
1170
    ) -> tuple[
        torch.Tensor,
1171
1172
1173
        SpecDecodeMetadata | None,
        UBatchSlices | None,
        torch.Tensor | None,
1174
    ]:
1175
1176
        """
        :return: tuple[
1177
            logits_indices, spec_decode_metadata,
1178
            ubatch_slices, num_tokens_across_dp,
1179
1180
        ]
        """
1181
1182
1183
1184
1185
1186
1187
        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.
1188
        self.input_batch.block_table.commit_block_table(num_reqs)
1189
1190
1191

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

1194
1195
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1196
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1197
1198

        # Get positions.
1199
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1200
1201
1202
1203
1204
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1205

1206
1207
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1208
        if self.uses_mrope:
1209
1210
            self._calc_mrope_positions(scheduler_output)

1211
1212
1213
1214
        # 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.
1215
1216
1217
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1218
        token_indices_tensor = torch.from_numpy(token_indices)
1219

1220
1221
1222
        # 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.
1223
1224
1225
1226
1227
1228
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1229
        if self.enable_prompt_embeds:
1230
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1231
1232
1233
1234
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1235
1236
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269

        # 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:
1270
1271
1272
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1273
1274

                output_idx += num_sched
1275

1276
1277
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1278
1279

        # Prepare the attention metadata.
1280
        self.query_start_loc.np[0] = 0
1281
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1282
1283
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1284
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1285
        self.query_start_loc.copy_to_gpu()
1286
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1287

1288
        num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
1289
        num_tokens_padded = self._get_num_input_tokens(num_tokens_unpadded)
1290
1291
1292
        uniform_decode = (
            max_num_scheduled_tokens == self.uniform_decode_query_len
        ) and (total_num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
1293
1294
1295
1296
1297
1298
1299

        # Disable DP padding when running eager to avoid excessive padding when
        # running prefills. This lets us set enforce_eager on the prefiller in
        # a P/D setup and still use CUDA graphs (enabled by this padding) on the
        # decoder.
        allow_dp_padding = self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE

1300
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
1301
1302
1303
1304
1305
1306
1307
            num_tokens_unpadded=num_tokens_unpadded,
            parallel_config=self.parallel_config,
            allow_microbatching=True,
            allow_dp_padding=allow_dp_padding,
            num_tokens_padded=num_tokens_padded,
            uniform_decode=uniform_decode,
            num_scheduled_tokens_per_request=num_scheduled_tokens,
1308
        )
1309

1310
        self.seq_lens.np[:num_reqs] = (
1311
1312
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1313
        # Fill unused with 0 for full cuda graph mode.
1314
1315
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
1316

1317
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1318
1319
1320
1321
1322
1323
1324
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

        # Record the index of requests that should not be sampled,
        # so that we could clear the sampled tokens before returning
        discard_requests_mask = self.seq_lens.np[:num_reqs] < num_tokens_np
        discard_request_indices = np.nonzero(discard_requests_mask)[0]
        self.num_discarded_requests = len(discard_request_indices)
1325
1326
1327
        self.discard_request_indices.np[: self.num_discarded_requests] = (
            discard_request_indices
        )
1328
1329
1330

        self.discard_request_indices.copy_to_gpu(self.num_discarded_requests)

1331
        # Copy the tensors to the GPU.
1332
1333
1334
1335
1336
        self._prepare_input_ids(
            scheduler_output,
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
1337

1338
        if self.uses_mrope:
1339
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1340
1341
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1342
1343
                non_blocking=True,
            )
1344
1345
        else:
            # Common case (1D positions)
1346
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1347

1348
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
1349
1350
1351
1352
1353
1354
1355
        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
1356
            num_draft_tokens = None
1357
            spec_decode_metadata = None
1358
            num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
1359
1360
1361
1362
1363
        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)
1364
1365
1366
            # 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)
1367
1368
1369
1370
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
1371
1372
                req_idx = self.input_batch.req_id_to_index[req_id]
                num_draft_tokens[req_idx] = len(draft_token_ids)
1373
1374
1375
1376
1377
1378
1379
1380
                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
                )
1381
            spec_decode_metadata = self._calc_spec_decode_metadata(
1382
1383
                num_draft_tokens, cu_num_tokens
            )
1384
            logits_indices = spec_decode_metadata.logits_indices
1385
            num_sampled_tokens = num_draft_tokens + 1
1386
            # For DECODE only cuda graph of some attention backends (e.g., GDN).
1387
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
1388
1389
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
1390

1391
1392
1393
1394
1395
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
1396
            )
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
            self.set_active_loras(
                self.input_batch, num_scheduled_tokens, num_sampled_tokens
            )

        return (
            logits_indices,
            spec_decode_metadata,
            ubatch_slices,
            num_tokens_across_dp,
        )

    def _build_attention_metadata(
        self,
        total_num_scheduled_tokens: int,
        max_num_scheduled_tokens: int,
        num_reqs: int,
        ubatch_slices: UBatchSlices | None = None,
        logits_indices: torch.Tensor | None = None,
        use_spec_decode: bool = False,
        for_cudagraph_capture: bool = False,
        scheduled_encoder_inputs: dict[str, list[int]] | None = None,
        cascade_attn_prefix_lens: list[list[int]] | None = None,
    ) -> tuple[PerLayerAttnMetadata, CommonAttentionMetadata | None]:
        """
        :return: tuple[attn_metadata, spec_decode_common_attn_metadata]
        """
        logits_indices_padded = None
1424
        num_logits_indices = None
1425
1426
1427
1428
1429
1430
        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
                )
1431

1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
        # 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,
                self.parallel_config.dcp_kv_cache_interleave_size,
            )
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs)

1442
1443
1444
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1445

1446
1447
        # Used in the below loop
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1448
        query_start_loc_cpu = self.query_start_loc.cpu[: num_reqs + 1]
1449
        seq_lens = self.seq_lens.gpu[:num_reqs]
1450
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs]
1451
1452
1453
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs
        ]
1454
1455
1456
1457
1458
1459

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

1460
        spec_decode_common_attn_metadata = None
1461
1462
1463
1464
1465
1466
1467
1468
1469

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

1470
1471
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1472
1473
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1474
1475
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1476

1477
1478
        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
1479
        for kv_cache_gid, kv_cache_group in enumerate(
1480
1481
            self.kv_cache_config.kv_cache_groups
        ):
1482
            encoder_seq_lens = self._get_encoder_seq_lens(
1483
1484
1485
                scheduled_encoder_inputs or {},
                kv_cache_group.kv_cache_spec,
                num_reqs,
1486
            )
1487

1488
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
1489
1490
1491
1492
1493
                # Encoder-only layers do not have KV cache, so we need to
                # create a dummy block table and slot mapping for them.
                blk_table_tensor = torch.zeros(
                    (num_reqs, 1),
                    dtype=torch.int32,
1494
1495
1496
                    device=self.device,
                )
                slot_mapping = torch.zeros(
1497
                    (total_num_scheduled_tokens,),
1498
1499
1500
                    dtype=torch.int64,
                    device=self.device,
                )
1501
            else:
1502
                blk_table = self.input_batch.block_table[kv_cache_gid]
1503
                blk_table_tensor = blk_table.get_device_tensor(num_reqs)
1504
                slot_mapping = blk_table.slot_mapping.gpu[:total_num_scheduled_tokens]
1505
1506
1507

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

1510
            common_attn_metadata = CommonAttentionMetadata(
1511
1512
1513
1514
1515
                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,
1516
1517
1518
                num_reqs=num_reqs,
                num_actual_tokens=total_num_scheduled_tokens,
                max_query_len=max_num_scheduled_tokens,
1519
                max_seq_len=max_seq_len,
1520
1521
                block_table_tensor=blk_table_tensor,
                slot_mapping=slot_mapping,
1522
                logits_indices_padded=logits_indices_padded,
1523
                num_logits_indices=num_logits_indices,
1524
                causal=True,
1525
                encoder_seq_lens=encoder_seq_lens,
1526
                dcp_local_seq_lens=dcp_local_seq_lens,
1527
                dcp_local_seq_lens_cpu=dcp_local_seq_lens_cpu,
1528
1529
            )

1530
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1531
                if isinstance(self.drafter, EagleProposer):
1532
                    if self.drafter.attn_layer_names[0] in kv_cache_group.layer_names:
1533
1534
1535
                        spec_decode_common_attn_metadata = common_attn_metadata
                else:
                    spec_decode_common_attn_metadata = common_attn_metadata
1536

1537
1538
1539
1540
1541
1542
            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
                )
1543
                builder = attn_group.get_metadata_builder()
1544

1545
                extra_attn_metadata_args = {}
1546
                if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
1547
                    extra_attn_metadata_args = dict(
1548
1549
1550
1551
                        num_accepted_tokens=self.num_accepted_tokens.gpu[:num_reqs],
                        num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
                            :num_reqs
                        ],
1552
1553
                    )

1554
1555
                if ubatch_slices is not None:
                    common_attn_metadata_list = split_attn_metadata(
1556
1557
                        ubatch_slices, common_attn_metadata
                    )
1558
                    for ubid, common_attn_metadata in enumerate(
1559
1560
                        common_attn_metadata_list
                    ):
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
                        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:
1572
1573
1574
1575
                            assert type(attn_metadata) is list
                            attn_metadata[ubid][layer_name] = attn_metadata_i
                else:
                    assert isinstance(attn_metadata, dict)
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
                    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,
                        )
1586
1587
                    for layer_name in attn_group.layer_names:
                        attn_metadata[layer_name] = attn_metadata_i
1588

1589
        return attn_metadata, spec_decode_common_attn_metadata
1590

1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
    def _compute_cascade_attn_prefix_lens(
        self,
        num_scheduled_tokens: np.ndarray,
        num_common_prefix_blocks: list[int],
    ) -> list[list[int]] | None:
        """
        :return: Optional[cascade_attn_prefix_lens]
            cascade_attn_prefix_lens is 2D: ``[kv_cache_group_id][attn_group_idx]``,
            None if we should not use cascade attention
        """
1601

1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
        use_cascade_attn = False
        num_kv_cache_groups = len(self.kv_cache_config.kv_cache_groups)
        cascade_attn_prefix_lens: list[list[int]] = [
            [] for _ in range(num_kv_cache_groups)
        ]

        for kv_cache_gid in range(num_kv_cache_groups):
            for attn_group in self.attn_groups[kv_cache_gid]:
                if isinstance(attn_group.kv_cache_spec, EncoderOnlyAttentionSpec):
                    cascade_attn_prefix_len = 0
                else:
                    # 0 if cascade attention should not be used
                    cascade_attn_prefix_len = self._compute_cascade_attn_prefix_len(
                        num_scheduled_tokens,
                        num_common_prefix_blocks[kv_cache_gid],
                        attn_group.kv_cache_spec,
                        attn_group.get_metadata_builder(),
                    )
                cascade_attn_prefix_lens[kv_cache_gid].append(cascade_attn_prefix_len)
                use_cascade_attn |= cascade_attn_prefix_len > 0

        return cascade_attn_prefix_lens if use_cascade_attn else None
1624

1625
1626
1627
1628
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
        num_common_prefix_blocks: int,
1629
1630
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
    ) -> 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.
        """
1649

1650
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
        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]
1688
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
1689
1690
1691
1692
1693
1694
1695
        # If we use [A, B, C, D] as the common prefix for Request 1-3,
        # then Request 3 will be processed only by the first kernel,
        # and the second kernel will get an empty input. While this is not
        # a fundamental problem, our current implementation does not support
        # this case.
        num_reqs = len(num_scheduled_tokens)
        common_prefix_len = min(
1696
1697
            common_prefix_len, self.input_batch.num_computed_tokens_cpu[:num_reqs].min()
        )
1698
        # common_prefix_len should be a multiple of the block size.
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
        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
        )
1710
1711
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
1712
1713
1714
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
1715
            num_kv_heads=kv_cache_spec.num_kv_heads,
1716
            use_alibi=self.use_alibi,
1717
            use_sliding_window=use_sliding_window,
1718
            use_local_attention=use_local_attention,
1719
            num_sms=self.num_sms,
1720
            dcp_world_size=self.dcp_world_size,
1721
1722
1723
        )
        return common_prefix_len if use_cascade else 0

1724
1725
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
1726
        for index, req_id in enumerate(self.input_batch.req_ids):
1727
1728
1729
            req = self.requests[req_id]
            assert req.mrope_positions is not None

1730
1731
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1732
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
1733
1734
                req.prompt_token_ids, req.prompt_embeds
            )
1735
1736

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
1737
1738
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
            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

1752
1753
1754
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
1755
1756
1757
1758
1759
1760
1761
                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

1762
                MRotaryEmbedding.get_next_input_positions_tensor(
1763
                    out=self.mrope_positions.np,
1764
1765
1766
1767
1768
                    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,
                )
1769
1770
1771

                mrope_pos_ptr += completion_part_len

1772
1773
    def _calc_spec_decode_metadata(
        self,
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
        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
1790
1791
1792
1793

        # 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(
1794
1795
            num_sampled_tokens, cumsum_dtype=np.int32
        )
1796
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
1797
        logits_indices = np.repeat(
1798
1799
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
1800
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
1801
1802
1803
1804
1805
1806
        logits_indices += arange

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

        # Compute the draft logits indices.
1807
1808
1809
        # 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(
1810
1811
            num_draft_tokens, cumsum_dtype=np.int32
        )
1812
1813
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
1814
1815
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
1816
1817
1818
1819
1820
        # [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(
1821
1822
            self.device, non_blocking=True
        )
1823
1824
1825
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
1826
1827
1828
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
1829
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
1830
1831
            self.device, non_blocking=True
        )
1832
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
1833
1834
            self.device, non_blocking=True
        )
1835

1836
1837
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
1838
        draft_token_ids = self.input_ids.gpu[logits_indices]
1839
1840
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

1841
        return SpecDecodeMetadata(
1842
1843
1844
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
1845
            cu_num_sampled_tokens=cu_num_sampled_tokens,
1846
1847
1848
1849
1850
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

1851
1852
1853
1854
1855
1856
1857
    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
1858
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
1859
1860
1861
1862
1863
        # 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_(
1864
1865
1866
1867
1868
1869
            logits_indices[-1].item()
        )
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and num_logits <= self.cudagraph_batch_sizes[-1]
        ):
1870
1871
1872
1873
1874
            # 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
1875
1876
1877
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
1878
1879
        return logits_indices_padded

1880
1881
1882
1883
1884
1885
1886
1887
    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
1888
                inputs.
1889
1890
1891
1892
1893
1894

        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
        """
1895
1896
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
1897
            return [], []
1898
        # Batch the multi-modal inputs.
1899
        mm_kwargs = list[MultiModalKwargsItem]()
1900
1901
        # list of tuple (mm_hash, position_info)
        mm_hashes_pos = list[tuple[str, PlaceholderRange]]()
1902
1903
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
1904
1905

            for mm_input_id in encoder_input_ids:
1906
1907
1908
1909
                mm_feature = req_state.mm_features[mm_input_id]
                mm_hash = mm_feature.identifier
                mm_kwargs.append(mm_feature.data)
                mm_hashes_pos.append((mm_hash, mm_feature.mm_position))
1910

1911
1912
1913
1914
1915
        return mm_kwargs, mm_hashes_pos

    def _execute_mm_encoder(self, scheduler_output: "SchedulerOutput"):
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, mm_hashes_pos = self._batch_mm_kwargs_from_scheduler(
1916
1917
            scheduler_output
        )
1918
1919
1920
1921

        if not mm_kwargs:
            return

1922
1923
1924
1925
1926
1927
1928
        # 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.
1929
        model = cast(SupportsMultiModal, self.model)
1930
        encoder_outputs = []
1931
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
1932
1933
1934
1935
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
1936
            multimodal_cpu_fields=model.multimodal_cpu_fields,
1937
        ):
1938
1939
1940
            curr_group_outputs = []

            # EVS-related change.
1941
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
1942
            # processing multimodal data. This solves the issue with scheduler
1943
1944
1945
1946
            # 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)
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
            # TODO(ywang96): Fix memory profiling to take EVS into account and
            # remove this hack.
            if (
                self.is_multimodal_pruning_enabled
                and modality == "video"
                and num_items > 1
            ):
                for video_mm_kwargs_item in filter(
                    lambda item: item.modality == "video", mm_kwargs
                ):
                    _, _, micro_batch_mm_inputs = next(
                        group_mm_kwargs_by_modality(
                            [video_mm_kwargs_item],
                            device=self.device,
                            pin_memory=self.pin_memory,
                            merge_by_field_config=model.merge_by_field_config,
1963
                            multimodal_cpu_fields=model.multimodal_cpu_fields,
1964
                        )
1965
                    )
1966

1967
                    micro_batch_outputs = model.embed_multimodal(
1968
1969
                        **micro_batch_mm_inputs
                    )
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979

                    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.
1980
                curr_group_outputs = model.embed_multimodal(**mm_kwargs_group)
1981

1982
1983
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
1984
                expected_num_items=num_items,
1985
            )
1986
            encoder_outputs.extend(curr_group_outputs)
1987

1988
1989
1990
        # 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(
1991
1992
1993
                output,
                is_embed=pos_info.is_embed,
            )
1994
1995
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
1996
1997

    def _gather_mm_embeddings(
1998
1999
        self,
        scheduler_output: "SchedulerOutput",
2000
        shift_computed_tokens: int = 0,
2001
2002
2003
2004
2005
2006
2007
2008
    ) -> 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
2009
        should_sync_mrope_positions = False
2010

2011
        for req_id in self.input_batch.req_ids:
2012
2013
            mm_embeds_req: list[torch.Tensor] = []

2014
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2015
            req_state = self.requests[req_id]
2016
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2017

2018
2019
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2020
2021
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037

                # 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,
2038
2039
                    num_encoder_tokens,
                )
2040
                assert start_idx < end_idx
2041

2042
                mm_hash = mm_feature.identifier
2043
                encoder_output = self.encoder_cache.get(mm_hash, None)
2044
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2045
2046
2047
2048

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

2049
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2050
2051
2052
                is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                    True if is_embed is None else is_embed
                )
2053

2054
2055
2056
2057
                mm_embeds_item = gather_mm_placeholders(
                    encoder_output[start_idx:end_idx],
                    is_embed=is_embed,
                )
2058
2059
2060
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2061
                assert req_state.mrope_positions is not None
2062
2063
2064
2065
2066
2067
2068
                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,
2069
2070
                    )
                )
2071
2072
2073
2074
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
2075
2076
2077
            req_start_idx += num_scheduled_tokens

        is_mm_embed = self.is_mm_embed.copy_to_gpu(total_num_scheduled_tokens)
2078
2079
2080

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
2081
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
2082

2083
        return mm_embeds, is_mm_embed
2084

2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
    def _extract_encoder_inputs(
        self,
        scheduler_output: "SchedulerOutput",
    ) -> dict[str, torch.Tensor]:
        """Extract encoder inputs for encoder-decoder models.

        This method extracts multimodal input features from scheduled encoder
        inputs and formats them for the encoder-decoder model forward pass.
        """
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, _ = self._batch_mm_kwargs_from_scheduler(scheduler_output)

        if not mm_kwargs:
            return {}

        # Group MM kwargs by modality and extract features
2101
        model = cast(SupportsMultiModal, self.model)
2102
2103
        encoder_features = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
2104
2105
2106
2107
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
2108
            multimodal_cpu_fields=model.multimodal_cpu_fields,
2109
2110
2111
2112
2113
2114
2115
2116
        ):
            # Add the grouped features to encoder_features dict
            # This allows the model to receive them as kwargs (e.g.,
            # input_features=...)
            encoder_features.update(mm_kwargs_group)

        return encoder_features

2117
    def get_model(self) -> nn.Module:
2118
        # get raw model out of the cudagraph wrapper.
2119
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
2120
            return self.model.unwrap()
2121
2122
        return self.model

2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
    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

2138
2139
2140
2141
2142
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

2143
2144
        supported_tasks = list(model.pooler.get_supported_tasks())

2145
        if self.scheduler_config.enable_chunked_prefill:
2146
2147
2148
2149
            if "token_embed" in supported_tasks:
                supported_tasks.remove("token_embed")
            if "token_classify" in supported_tasks:
                supported_tasks.remove("token_classify")
2150

2151
2152
            logger.debug_once(
                "Chunked prefill is not supported with "
2153
2154
                "token_embed and token_classify tasks "
                "which using ALL pooling. "
2155
2156
2157
                "Please turn off chunked prefill by "
                "`--no-enable-chunked-prefill` before using it."
            )
2158
2159
2160
2161
2162

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

        return supported_tasks
2166

2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
    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)

2177
    def sync_and_slice_intermediate_tensors(
2178
2179
2180
2181
2182
        self,
        num_tokens: int,
        intermediate_tensors: IntermediateTensors,
        sync_self: bool,
    ) -> IntermediateTensors:
2183
2184
2185
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
2186
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
2187
2188
2189
2190
2191
2192

        # 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():
2193
                is_scattered = k == "residual" and is_rs
2194
                copy_len = num_tokens // tp if is_scattered else num_tokens
2195
                self.intermediate_tensors[k][:copy_len].copy_(
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
                    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:
2209
2210
2211
2212
2213
2214
2215
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2216
2217
        model = self.get_model()
        assert is_mixture_of_experts(model)
2218
2219
2220
        self.eplb_state.step(
            is_dummy,
            is_profile,
2221
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2222
2223
        )

2224
2225
2226
2227
    # This is where the second ubatch is adjusted to account for the padding.
    # Should be called after attention metadata creation. This just pads
    # the second ubatch slice out to the total number of tokens
    # (num_tokens + padding)
2228
2229
    @staticmethod
    def pad_out_ubatch_slice(ubatch_slices: UBatchSlices, num_total_tokens: int):
2230
2231
2232
2233
2234
2235
        padded_second_ubatch_slice = slice(
            ubatch_slices[1].token_slice.start, num_total_tokens
        )
        ubatch_slices[1] = UBatchSlice(
            padded_second_ubatch_slice, padded_second_ubatch_slice
        )
2236

2237
2238
2239
2240
2241
2242
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
    ) -> ModelRunnerOutput:
2243
2244
2245
        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"
        )
2246

2247
        hidden_states = hidden_states[:num_scheduled_tokens]
2248
        pooling_metadata = self.input_batch.get_pooling_metadata()
2249
2250
2251
2252
        pooling_metadata.build_pooling_cursor(
            num_scheduled_tokens_np.tolist(), device=hidden_states.device
        )
        seq_lens_cpu = self.seq_lens.cpu[: self.input_batch.num_reqs]
2253

2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
        model = cast(VllmModelForPooling, self.model)
        raw_pooler_output: PoolerOutput = model.pooler(
            hidden_states=hidden_states,
            pooling_metadata=pooling_metadata,
        )
        raw_pooler_output = json_map_leaves(
            lambda x: x.to("cpu", non_blocking=True),
            raw_pooler_output,
        )
        self._sync_device()
2264

2265
        pooler_output: list[torch.Tensor | None] = []
2266
        for raw_output, seq_len, prompt_len in zip(
2267
2268
            raw_pooler_output, seq_lens_cpu, pooling_metadata.prompt_lens
        ):
2269
            output = raw_output if seq_len == prompt_len else None
2270
            pooler_output.append(output)
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280

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

2281
    def _get_num_input_tokens(self, num_scheduled_tokens: int) -> int:
2282
2283
2284
2285
2286
2287
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and hasattr(self, "cudagraph_batch_sizes")
            and self.cudagraph_batch_sizes
            and num_scheduled_tokens <= self.cudagraph_batch_sizes[-1]
        ):
2288
2289
2290
2291
2292
2293
2294
2295
            # Use CUDA graphs.
            # Add padding to the batch size.
            return self.vllm_config.pad_for_cudagraph(num_scheduled_tokens)

        # Eager mode.
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
2296
2297
2298
2299
        if (
            self.compilation_config.pass_config.enable_sequence_parallelism
            and tp_size > 1
        ):
2300
2301
2302
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

2303
    def _preprocess(
2304
2305
        self,
        scheduler_output: "SchedulerOutput",
2306
        num_input_tokens: int,  # Padded
2307
        intermediate_tensors: IntermediateTensors | None = None,
2308
    ) -> tuple[
2309
2310
        torch.Tensor | None,
        torch.Tensor | None,
2311
        torch.Tensor,
2312
        IntermediateTensors | None,
2313
        dict[str, Any],
2314
        ECConnectorOutput | None,
2315
    ]:
2316
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2317
        is_first_rank = get_pp_group().is_first_rank
2318

2319
2320
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
2321
2322
        ec_connector_output = None

2323
2324
        if (
            self.supports_mm_inputs
2325
            and is_first_rank
2326
2327
            and not self.model_config.is_encoder_decoder
        ):
2328
            # Run the multimodal encoder if any.
2329
2330
2331
2332
2333
2334
            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)
2335

2336
2337
2338
            # 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.
2339
            inputs_embeds_scheduled = self.model.embed_input_ids(
2340
2341
2342
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2343
            )
2344

2345
            # TODO(woosuk): Avoid the copy. Optimize.
2346
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2347

2348
            input_ids = None
2349
            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
2350
2351
2352
2353
            model_kwargs = {
                **self._init_model_kwargs(num_scheduled_tokens),
                **self._extract_mm_kwargs(scheduler_output),
            }
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371

            # Generate custom attention masks for models that require them.
            # V1 pre-generates embeddings, so forward() skips prepare_attn_masks().
            # Check mm_features (mm_embeds is empty during decode).
            has_mm_features = any(
                req_state.mm_features for req_state in self.requests.values()
            )
            if (
                self.uses_custom_attention_masks
                and has_mm_features
                and hasattr(self.model, "generate_attention_masks")
            ):
                mask_kwargs = self.model.generate_attention_masks(
                    self.input_ids.gpu[:num_scheduled_tokens],
                    self.positions.gpu[:num_scheduled_tokens],
                    mask_dtype=self.model.dtype,
                )
                model_kwargs.update(mask_kwargs)
2372
        elif self.enable_prompt_embeds and is_first_rank:
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
            # 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).
2385
2386
2387
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
2388
                .squeeze(1)
2389
            )
2390
2391
2392
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
2393
                tokens_to_embeds = self.model.embed_input_ids(input_ids=token_ids)
2394
2395
2396
2397
2398
                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
2399
        else:
2400
2401
2402
2403
            # 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.
2404
            input_ids = self.input_ids.gpu[:num_input_tokens]
2405
            inputs_embeds = None
2406
            model_kwargs = self._init_model_kwargs(num_input_tokens)
2407
        if self.uses_mrope:
2408
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2409
        else:
2410
            positions = self.positions.gpu[:num_input_tokens]
2411

2412
        if is_first_rank:
2413
2414
            intermediate_tensors = None
        else:
2415
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2416
2417
                num_input_tokens, intermediate_tensors, True
            )
2418

2419
2420
2421
2422
        if (
            self.model_config.is_encoder_decoder
            and scheduler_output.scheduled_encoder_inputs
        ):
2423
2424
2425
            encoder_inputs = self._extract_encoder_inputs(scheduler_output)
            model_kwargs.update(encoder_inputs)

2426
2427
2428
2429
2430
2431
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
2432
            ec_connector_output,
2433
        )
2434

2435
    def _sample(
2436
        self,
2437
2438
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2439
    ) -> SamplerOutput:
2440
        # Sample the next token and get logprobs if needed.
2441
        sampling_metadata = self.input_batch.sampling_metadata
2442
        if spec_decode_metadata is None:
2443
2444
2445
            # 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()
2446
            return self.sampler(
2447
2448
2449
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
2450

2451
        sampler_output = self.rejection_sampler(
2452
2453
            spec_decode_metadata,
            None,  # draft_probs
2454
            logits,
2455
2456
            sampling_metadata,
        )
2457
        self._update_states_after_model_execute(sampler_output.sampled_token_ids)
2458
2459
2460
        return sampler_output

    def _bookkeeping_sync(
2461
2462
2463
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
2464
        logits: torch.Tensor | None,
2465
2466
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
2467
        spec_decode_metadata: SpecDecodeMetadata | None,
2468
    ) -> tuple[
2469
        dict[str, int],
2470
        LogprobsLists | None,
Cyrus Leung's avatar
Cyrus Leung committed
2471
        list[np.ndarray],
2472
        dict[str, LogprobsTensors | None],
2473
2474
2475
        list[str],
        dict[str, int],
        list[int],
2476
    ]:
2477
2478
2479
2480
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

2481
2482
2483
        discard_sampled_tokens_req_indices = self.discard_request_indices.np[
            : self.num_discarded_requests
        ]
2484
2485
2486
2487
        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)
2488

2489
2490
2491
        # 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()
2492
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2493
2494

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2495
        sampled_token_ids = sampler_output.sampled_token_ids
2496
        invalid_req_indices = []
Cyrus Leung's avatar
Cyrus Leung committed
2497
        valid_sampled_token_ids: list[np.ndarray]
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
        if not self.use_async_scheduling:
            # Get the valid generated tokens.
            max_gen_len = sampled_token_ids.shape[-1]
            if max_gen_len == 1:
                # No spec decode tokens.
                valid_sampled_token_ids = self._to_list(sampled_token_ids)
            else:
                # Includes spec decode tokens.
                valid_sampled_token_ids = self.rejection_sampler.parse_output(
                    sampled_token_ids,
                    self.input_batch.vocab_size,
                )
            # Mask out the sampled tokens that should not be sampled.
            for i in discard_sampled_tokens_req_indices:
Cyrus Leung's avatar
Cyrus Leung committed
2512
                valid_sampled_token_ids[int(i)] = np.array([])
2513
        else:
2514
            valid_sampled_token_ids = []
2515
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2516
2517
2518
2519
2520
            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.
2521
2522
2523
2524
            # 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
2525
2526
2527
2528
2529
            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
            }
2530

2531
2532
2533
2534
2535
        # 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.
2536
        req_ids = self.input_batch.req_ids
2537
2538
2539
2540
        logprobs_tensors = sampler_output.logprobs_tensors
        cu_num_accepted_tokens = (
            [0] if spec_decode_metadata and logprobs_tensors else None
        )
2541
        for req_idx in range(num_sampled_tokens):
Cyrus Leung's avatar
Cyrus Leung committed
2542
            sampled_ids: np.ndarray | None
2543
            if self.use_async_scheduling:
Cyrus Leung's avatar
Cyrus Leung committed
2544
2545
2546
                sampled_ids = (
                    np.array([-1]) if req_idx not in invalid_req_indices_set else None
                )
2547
2548
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
2549

Cyrus Leung's avatar
Cyrus Leung committed
2550
2551
2552
            num_sampled_ids: int = (
                sampled_ids.shape[0] if sampled_ids is not None else 0
            )
2553
2554
2555
2556
2557
2558

            if cu_num_accepted_tokens is not None:
                cu_num_accepted_tokens.append(
                    cu_num_accepted_tokens[-1] + num_sampled_ids
                )

Cyrus Leung's avatar
Cyrus Leung committed
2559
            if sampled_ids is None or num_sampled_ids == 0:
2560
2561
2562
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
2563
            end_idx = start_idx + num_sampled_ids
2564
2565
2566
2567
            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}"
2568
            )
2569

2570
2571
            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
2572
2573
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
            self.input_batch.num_tokens[req_idx] = end_idx
2574

2575
            req_id = req_ids[req_idx]
2576
2577
2578
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

2579
2580
        logprobs_lists = (
            logprobs_tensors.tolists(cu_num_accepted_tokens)
2581
            if not self.use_async_scheduling and logprobs_tensors is not None
2582
2583
2584
2585
2586
2587
2588
2589
2590
            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,
        )

2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
        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,
        )

2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
    @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()

2616
2617
    def _model_forward(
        self,
2618
2619
2620
2621
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
2622
2623
2624
2625
2626
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
2627
        Motivation: We can inspect only this method versus
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
        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,
        )

2648
2649
2650
2651
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
2652
        intermediate_tensors: IntermediateTensors | None = None,
2653
2654
2655
2656
2657
2658
    ) -> 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."
            )
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673

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

2674
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2675
        with record_function_or_nullcontext("gpu_model_runner: preprocess"):
2676
2677
2678
2679
            with self.synchronize_input_prep():
                # Update persistent batch states.
                self._update_states(scheduler_output)

2680
2681
2682
2683
2684
2685
2686
2687
                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)

2688
                if not num_scheduled_tokens:
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
                    if (
                        self.parallel_config.distributed_executor_backend
                        == "external_launcher"
                        and self.parallel_config.data_parallel_size > 1
                    ):
                        # this is a corner case when both external launcher
                        # and DP are enabled, num_scheduled_tokens could be
                        # 0, and has_unfinished_requests in the outer loop
                        # returns True. before returning early here we call
                        # dummy run to ensure coordinate_batch_across_dp
                        # is called into to avoid out of sync issues.
                        self._dummy_run(1)
2701
2702
2703
2704
                    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(
2705
2706
                        scheduler_output, self.vllm_config
                    )
2707
2708
2709
2710
                if self.cache_config.kv_sharing_fast_prefill:
                    assert not self.input_batch.num_prompt_logprobs, (
                        "--kv-sharing-fast-prefill produces incorrect "
                        "logprobs for prompt tokens, tokens, please disable "
2711
2712
                        "it when the requests need prompt logprobs"
                    )
2713

2714
2715
2716
2717
2718
2719
                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())

2720
2721
2722
2723
                (
                    logits_indices,
                    spec_decode_metadata,
                    ubatch_slices,
2724
                    num_tokens_across_dp,
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
                ) = self._prepare_inputs(
                    scheduler_output, num_scheduled_tokens_np, max_num_scheduled_tokens
                )

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

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

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

2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
                dp_rank = self.parallel_config.data_parallel_rank
                if ubatch_slices:
                    assert num_tokens_across_dp is not None
                    num_input_tokens = int(num_tokens_across_dp[dp_rank].item())
                    self.pad_out_ubatch_slice(ubatch_slices, num_input_tokens)
                elif num_tokens_across_dp is not None:
                    num_input_tokens = int(num_tokens_across_dp[dp_rank].item())
                else:
                    num_input_tokens = self._get_num_input_tokens(
                        scheduler_output.total_num_scheduled_tokens
                    )
2768

2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
                (
                    input_ids,
                    inputs_embeds,
                    positions,
                    intermediate_tensors,
                    model_kwargs,
                    ec_connector_output,
                ) = self._preprocess(
                    scheduler_output, num_input_tokens, intermediate_tensors
                )
2779

2780
2781
2782
            uniform_decode = (
                max_num_scheduled_tokens == self.uniform_decode_query_len
            ) and (num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
2783
            batch_descriptor = BatchDescriptor(
2784
2785
2786
                num_tokens=num_input_tokens,
                uniform_decode=uniform_decode,
                has_lora=len(self.input_batch.lora_id_to_lora_request) > 0,
2787
2788
            )
            cudagraph_runtime_mode, batch_descriptor = (
2789
2790
2791
2792
                self.cudagraph_dispatcher.dispatch(
                    batch_descriptor,
                    use_cascade_attn=cascade_attn_prefix_lens is not None,
                )
2793
            )
2794

2795
        # Set cudagraph mode to none if calc_kv_scales is true.
2796
2797
2798
2799
2800
2801
        # KV scales calculation involves dynamic operations that are incompatible
        # with CUDA graph capture.
        if self.calculate_kv_scales:
            cudagraph_runtime_mode = CUDAGraphMode.NONE
            # Mark KV scales as calculated after the first forward pass
            self.calculate_kv_scales = False
2802

2803
2804
        # Run the model.
        # Use persistent buffers for CUDA graphs.
2805
2806
        with (
            set_forward_context(
2807
2808
2809
2810
2811
2812
                attn_metadata,
                self.vllm_config,
                num_tokens=num_input_tokens,
                num_tokens_across_dp=num_tokens_across_dp,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                batch_descriptor=batch_descriptor,
2813
                ubatch_slices=ubatch_slices,
2814
            ),
2815
            record_function_or_nullcontext("gpu_model_runner: forward"),
2816
2817
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
2818
            model_output = self._model_forward(
2819
2820
2821
2822
2823
2824
2825
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

2826
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
2827
            if self.use_aux_hidden_state_outputs:
2828
                # True when EAGLE 3 is used.
2829
2830
                hidden_states, aux_hidden_states = model_output
            else:
2831
                # Common case.
2832
2833
2834
                hidden_states = model_output
                aux_hidden_states = None

2835
2836
2837
2838
2839
            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)
2840
                    hidden_states.kv_connector_output = kv_connector_output
2841
                    self.kv_connector_output = kv_connector_output
2842
                    return hidden_states
2843

2844
                if self.is_pooling_model:
2845
                    # Return the pooling output.
2846
2847
2848
                    output = self._pool(
                        hidden_states, num_scheduled_tokens, num_scheduled_tokens_np
                    )
2849
2850
                    output.kv_connector_output = kv_connector_output
                    return output
2851
2852

                sample_hidden_states = hidden_states[logits_indices]
2853
                logits = self.model.compute_logits(sample_hidden_states)
2854
2855
2856
2857
            else:
                # Rare case.
                assert not self.is_pooling_model

2858
                sample_hidden_states = hidden_states[logits_indices]
2859
                if not get_pp_group().is_last_rank:
2860
                    all_gather_tensors = {
2861
2862
2863
                        "residual": not is_residual_scattered_for_sp(
                            self.vllm_config, num_input_tokens
                        )
2864
                    }
2865
                    get_pp_group().send_tensor_dict(
2866
2867
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
2868
2869
                        all_gather_tensors=all_gather_tensors,
                    )
2870
2871
                    logits = None
                else:
2872
                    logits = self.model.compute_logits(sample_hidden_states)
2873
2874
2875
2876
2877

                model_output_broadcast_data = {}
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

2878
2879
2880
                model_output_broadcast_data = get_pp_group().broadcast_tensor_dict(
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
2881
2882
2883
                assert model_output_broadcast_data is not None
                logits = model_output_broadcast_data["logits"]

2884
2885
2886
2887
2888
2889
2890
2891
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
2892
            ec_connector_output,
2893
        )
2894
        self.kv_connector_output = kv_connector_output
2895
2896
2897
2898
2899
2900
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
2901
2902
2903
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

2904
2905
        if self.execute_model_state is None:
            # Nothing to do (PP non-final rank case), output isn't used.
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
            if not kv_connector_output:
                return None  # noqa

            # 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
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
2927
            ec_connector_output,
2928
2929
2930
2931
2932
2933
2934
2935
2936
        ) = 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
            )
2937

2938
        with record_function_or_nullcontext("gpu_model_runner: sample"):
2939
2940
            sampler_output = self._sample(logits, spec_decode_metadata)

2941
2942
        self.input_batch.prev_sampled_token_ids = None

Cyrus Leung's avatar
Cyrus Leung committed
2943
2944
2945
        def propose_draft_token_ids(
            sampled_token_ids: torch.Tensor | list[np.ndarray],
        ) -> None:
2946
            assert spec_decode_common_attn_metadata is not None
2947
            with record_function_or_nullcontext("gpu_model_runner: draft"):
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
                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,
                )

2959
2960
2961
2962
2963
        use_padded_batch_for_eagle = (
            self.speculative_config
            and self.speculative_config.use_eagle()
            and not self.speculative_config.disable_padded_drafter_batch
        )
2964
2965
2966
        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
2967
2968
2969
2970
2971
        if (
            self.speculative_config
            and self.speculative_config.draft_model_config is not None
            and self.speculative_config.draft_model_config.max_model_len is not None
        ):
2972
            effective_drafter_max_model_len = (
2973
2974
                self.speculative_config.draft_model_config.max_model_len
            )
2975
        input_fits_in_drafter = spec_decode_common_attn_metadata and (
2976
            spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
2977
2978
            <= effective_drafter_max_model_len
        )
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
        if use_padded_batch_for_eagle:
            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:
                next_token_ids, valid_sampled_tokens_count = (
                    self.drafter.prepare_next_token_ids_padded(
                        spec_decode_common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
                        self.discard_request_indices.gpu,
                        self.num_discarded_requests,
                    )
                )
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
2999

3000
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
3001
3002
3003
3004
3005
3006
3007
3008
            (
                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,
3009
3010
3011
3012
3013
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
3014
                scheduler_output.total_num_scheduled_tokens,
3015
                spec_decode_metadata,
3016
            )
3017

3018
3019
3020
3021
3022
        if (
            self.speculative_config
            and not use_padded_batch_for_eagle
            and input_fits_in_drafter
        ):
3023
3024
3025
            # 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)
3026

3027
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
3028
            self.eplb_step()
3029
3030
3031
3032
3033
3034
3035
3036
3037
        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,
3038
3039
3040
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
3041
3042
                num_nans_in_logits=num_nans_in_logits,
            )
3043

3044
3045
        if not self.use_async_scheduling:
            return output
3046
3047
3048
3049
3050
3051
3052
3053
3054
        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,
3055
                vocab_size=self.input_batch.vocab_size,
3056
3057
3058
3059
3060
            )
        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
3061
            # any requests with sampling params that require output ids.
3062
3063
3064
3065
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
3066
3067
3068

        return async_output

3069
    def take_draft_token_ids(self) -> DraftTokenIds | None:
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
        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)

3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
    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()

3111
3112
3113
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
Cyrus Leung's avatar
Cyrus Leung committed
3114
        sampled_token_ids: torch.Tensor | list[np.ndarray],
3115
3116
3117
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
3118
3119
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3120
        common_attn_metadata: CommonAttentionMetadata,
Cyrus Leung's avatar
Cyrus Leung committed
3121
    ) -> torch.Tensor | list[list[int]]:
3122
3123
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
        if self.speculative_config.method == "ngram":
3124
            assert isinstance(sampled_token_ids, list)
3125
            assert isinstance(self.drafter, NgramProposer)
3126
            draft_token_ids = self.drafter.propose(
3127
3128
                sampled_token_ids,
                self.input_batch.req_ids,
3129
3130
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
3131
3132
                self.input_batch.spec_decode_unsupported_reqs,
            )
3133
3134
3135
3136
        elif self.speculative_config.method == "suffix":
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
            draft_token_ids = self.drafter.propose(self.input_batch, sampled_token_ids)
3137
        elif self.speculative_config.method == "medusa":
3138
            assert isinstance(sampled_token_ids, list)
3139
            assert isinstance(self.drafter, MedusaProposer)
3140

3141
3142
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
3143
3144
3145
3146
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
3147
3148
3149
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
3150
                for num_draft, tokens in zip(
3151
3152
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
Cyrus Leung's avatar
Cyrus Leung committed
3153
                    indices.append(offset + tokens.shape[0] - 1)
3154
                    offset += num_draft + 1
3155
                indices = torch.tensor(indices, device=self.device)
3156
3157
                hidden_states = sample_hidden_states[indices]

3158
            draft_token_ids = self.drafter.propose(
3159
3160
3161
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
            )
3162
        elif self.speculative_config.use_eagle():
3163
            assert isinstance(self.drafter, EagleProposer)
3164
3165
3166
3167
3168

            if self.speculative_config.disable_padded_drafter_batch:
                # 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.
3169
3170
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
3171
                    "padded-batch is disabled."
3172
                )
3173
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
3174
3175
3176
3177
3178
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
3179
3180
3181
3182
3183
            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.
3184
3185
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
3186
                    "padded-batch is enabled."
3187
3188
                )
                next_token_ids, valid_sampled_tokens_count = (
3189
3190
3191
3192
3193
3194
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
                        self.discard_request_indices.gpu,
3195
                        self.num_discarded_requests,
3196
                    )
3197
                )
3198
3199
3200
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
3201

3202
            if spec_decode_metadata is None:
3203
                token_indices_to_sample = None
3204
                # input_ids can be None for multimodal models.
3205
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
3206
                target_positions = self._get_positions(num_scheduled_tokens)
3207
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3208
                    assert aux_hidden_states is not None
3209
                    target_hidden_states = torch.cat(
3210
3211
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
3212
3213
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
3214
            else:
3215
3216
                if self.speculative_config.disable_padded_drafter_batch:
                    token_indices_to_sample = None
3217
3218
3219
3220
3221
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
3222
                else:
3223
                    common_attn_metadata, token_indices, token_indices_to_sample = (
3224
3225
3226
                        self.drafter.prepare_inputs_padded(
                            common_attn_metadata,
                            spec_decode_metadata,
3227
3228
3229
                            valid_sampled_tokens_count,
                        )
                    )
3230

3231
                target_token_ids = self.input_ids.gpu[token_indices]
3232
                target_positions = self._get_positions(token_indices)
3233
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
3234
                    assert aux_hidden_states is not None
3235
                    target_hidden_states = torch.cat(
3236
3237
                        [h[token_indices] for h in aux_hidden_states], dim=-1
                    )
3238
3239
                else:
                    target_hidden_states = hidden_states[token_indices]
3240

3241
            if self.supports_mm_inputs:
3242
3243
3244
3245
3246
3247
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
3248

3249
            draft_token_ids = self.drafter.propose(
3250
3251
3252
3253
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
3254
                last_token_indices=token_indices_to_sample,
3255
                sampling_metadata=sampling_metadata,
3256
                common_attn_metadata=common_attn_metadata,
3257
                mm_embed_inputs=mm_embed_inputs,
3258
            )
3259

3260
        return draft_token_ids
3261

3262
3263
3264
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
3265
3266
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
3267
                f"Allowed configs: {allowed_config_names}"
3268
            )
3269
3270
3271
3272
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

3273
3274
3275
3276
3277
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
3278
3279
3280
3281
3282
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
3283
3284
3285
3286
3287
        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)
        )
3288

3289
3290
3291
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0
3292
        with DeviceMemoryProfiler() as m:
3293
            time_before_load = time.perf_counter()
3294
            model_loader = get_model_loader(self.load_config)
3295
            self.model = model_loader.load_model(
3296
3297
                vllm_config=self.vllm_config, model_config=self.model_config
            )
3298
            if self.lora_config:
3299
3300
3301
                self.model = self.load_lora_model(
                    self.model, self.vllm_config, self.device
                )
3302
            if hasattr(self, "drafter"):
3303
                logger.info_once("Loading drafter model...")
3304
                self.drafter.load_model(self.model)
3305
3306
3307
3308
3309
3310
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
                if (
                    hasattr(self.drafter, "model")
                    and is_mixture_of_experts(self.drafter.model)
                    and self.parallel_config.enable_eplb
                ):
                    logger.info_once(
                        "EPLB is enabled for drafter model %s.",
                        self.vllm_config.speculative_config.draft_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
                    )
                    if self.eplb_state is None:
                        self.eplb_state = EplbState(self.parallel_config, self.device)
                    self.eplb_state.add_model(
                        self.drafter.model,
                        self.vllm_config.speculative_config.draft_model_config,
                        global_expert_load,
                        old_global_expert_indices,
                        rank_mapping,
                    )
                    eplb_models += 1

3336
            if self.use_aux_hidden_state_outputs:
3337
                if not supports_eagle3(self.get_model()):
3338
3339
                    raise RuntimeError(
                        "Model does not support EAGLE3 interface but "
3340
3341
                        "aux_hidden_state_outputs was requested"
                    )
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354

                # 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)
3355
            time_after_load = time.perf_counter()
3356
        self.model_memory_usage = m.consumed_memory
3357
        logger.info_once(
3358
            "Model loading took %.4f GiB memory and %.6f seconds",
3359
3360
            self.model_memory_usage / GiB_bytes,
            time_after_load - time_before_load,
3361
            scope="local",
3362
        )
3363
        prepare_communication_buffer_for_model(self.model)
3364
        self.is_multimodal_pruning_enabled = (
3365
            supports_multimodal_pruning(self.get_model())
3366
3367
            and self.model_config.multimodal_config.is_multimodal_pruning_enabled()
        )
3368

3369
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
            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(
3381
                self.model,
3382
                self.model_config,
3383
3384
3385
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
3386
3387
            )

3388
        if (
3389
3390
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
3391
            and supports_dynamo()
3392
        ):
3393
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
3394
            compilation_counter.stock_torch_compile_count += 1
3395
            self.model.compile(fullgraph=True, backend=backend)
3396
            return
3397
        # for other compilation modes, cudagraph behavior is controlled by
3398
3399
3400
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
3401
3402
3403
3404
3405
3406
3407
        if (
            self.compilation_config.cudagraph_mode.has_full_cudagraphs()
            and not self.parallel_config.enable_dbo
        ):
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
3408
3409
        elif self.parallel_config.enable_dbo:
            if self.compilation_config.cudagraph_mode.has_full_cudagraphs():
3410
3411
3412
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
3413
            else:
3414
3415
3416
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
3417

3418
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
        """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

3442
    def reload_weights(self) -> None:
3443
        assert getattr(self, "model", None) is not None, (
3444
            "Cannot reload weights before model is loaded."
3445
        )
3446
3447
        model_loader = get_model_loader(self.load_config)
        logger.info("Reloading weights inplace...")
3448
        model_loader.load_weights(self.get_model(), model_config=self.model_config)
3449

3450
3451
3452
3453
3454
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
3455
            self.get_model(),
3456
            tensorizer_config=tensorizer_config,
3457
            model_config=self.model_config,
3458
3459
        )

3460
3461
3462
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
3463
        num_scheduled_tokens: dict[str, int],
3464
    ) -> dict[str, LogprobsTensors | None]:
3465
3466
3467
3468
        num_prompt_logprobs_dict = self.input_batch.num_prompt_logprobs
        if not num_prompt_logprobs_dict:
            return {}

3469
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
3470
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
3471
3472
3473
3474
3475

        # 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():
3476
            num_tokens = num_scheduled_tokens[req_id]
3477
3478
3479

            # Get metadata for this request.
            request = self.requests[req_id]
3480
3481
3482
3483
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

3484
3485
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
3486
3487
                self.device, non_blocking=True
            )
3488

3489
3490
3491
3492
3493
3494
            # 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(
3495
3496
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
3497
3498
                in_progress_dict[req_id] = logprobs_tensors

3499
            # Determine number of logits to retrieve.
3500
3501
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
3502
            num_remaining_tokens = num_prompt_tokens - start_tok
3503
            if num_tokens <= num_remaining_tokens:
3504
                # This is a chunk, more tokens remain.
3505
3506
3507
                # 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.
3508
3509
3510
3511
3512
                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)
3513
3514
3515
3516
3517
3518
3519
                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
3520
3521
3522
3523
3524

            # 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]
3525
            offset = self.query_start_loc.np[req_idx].item()
3526
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
3527
            logits = self.model.compute_logits(prompt_hidden_states)
3528
3529
3530
3531

            # 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.
3532
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
3533
3534

            # Compute prompt logprobs.
3535
3536
            logprobs = self.sampler.compute_logprobs(logits)
            token_ids, logprobs, ranks = self.sampler.gather_logprobs(
3537
3538
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
3539
3540

            # Transfer GPU->CPU async.
3541
3542
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
3543
3544
3545
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
3546
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
3547
3548
                ranks, non_blocking=True
            )
3549
3550
3551
3552
3553

        # 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]
3554
            del in_progress_dict[req_id]
3555
3556

        # Must synchronize the non-blocking GPU->CPU transfers.
3557
        if prompt_logprobs_dict:
3558
            self._sync_device()
3559
3560
3561

        return prompt_logprobs_dict

3562
3563
    def _get_nans_in_logits(
        self,
3564
        logits: torch.Tensor | None,
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
    ) -> 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])
3576
3577
3578
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
3579
3580
3581
3582
            return num_nans_in_logits
        except IndexError:
            return {}

3583
3584
3585
3586
3587
3588
    @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
3589
         - during DP rank dummy run
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
        """
        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(
3601
                    self.input_ids.gpu,
3602
3603
                    low=0,
                    high=self.model_config.get_vocab_size(),
3604
3605
                    dtype=input_ids.dtype,
                )
3606

3607
            logger.debug_once("Randomizing dummy data for DP Rank")
3608
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
3609
3610
3611
            yield
            input_ids.fill_(0)

3612
3613
3614
3615
3616
3617
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
3618
3619
        assert self.mm_budget is not None

3620
3621
        dummy_decoder_data = self.mm_registry.get_decoder_dummy_data(
            model_config=self.model_config,
3622
            seq_len=self.max_model_len,
3623
            mm_counts={modality: 1},
3624
            cache=self.mm_budget.cache,
3625
3626
3627
3628
        )
        dummy_mm_data = dummy_decoder_data.multi_modal_data

        # Result in the maximum GPU consumption of the model
3629
3630
        dummy_mm_item = dummy_mm_data[modality][0]
        dummy_mm_items = [dummy_mm_item] * max_items_per_batch
3631

3632
        model = cast(SupportsMultiModal, self.model)
3633
3634
3635
3636
3637
3638
3639
        return next(
            mm_kwargs_group
            for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
                dummy_mm_items,
                device=self.device,
                pin_memory=self.pin_memory,
                merge_by_field_config=model.merge_by_field_config,
3640
                multimodal_cpu_fields=model.multimodal_cpu_fields,
3641
3642
            )
        )
3643

3644
3645
3646
3647
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
3648
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
3649
3650
        force_attention: bool = False,
        uniform_decode: bool = False,
3651
        allow_microbatching: bool = True,
3652
3653
        skip_eplb: bool = False,
        is_profile: bool = False,
3654
        create_mixed_batch: bool = False,
3655
        remove_lora: bool = True,
3656
        activate_lora: bool = False,
3657
    ) -> tuple[torch.Tensor, torch.Tensor]:
3658
3659
3660
3661
3662
3663
3664
        """
        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.
3665
                - if not set will determine the cudagraph mode based on using
3666
                    the self.cudagraph_dispatcher.
3667
3668
3669
3670
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
3671
            force_attention: If True, always create attention metadata. Used to
3672
3673
3674
3675
                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.
3676
3677
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
3678
            remove_lora: If False, dummy LoRAs are not destroyed after the run
3679
            activate_lora: If False, dummy_run is performed without LoRAs.
3680
        """
3681
3682
3683
3684
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
3685

3686
        # If cudagraph_mode.decode_mode() == FULL and
3687
        # cudagraph_mode.separate_routine(). This means that we are using
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
        # 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.
3699
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
3700

3701
3702
3703
3704
3705
        # 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
3706
3707
3708
3709
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
3710
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
3711
3712
3713
3714
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
3715
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
3716
3717
3718
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
3719
            assert not create_mixed_batch
3720
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
3721
3722
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
3723
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
3724
3725
3726
3727
3728
3729
        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

3730
3731
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
3732
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
3733
        total_num_scheduled_tokens = int(num_scheduled_tokens.sum())
3734
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
3735

3736
3737
3738
        # Disable DP padding when running eager
        allow_dp_padding = self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE

3739
3740
        # We currently only microbatch if the number of tokens is
        # over a certain threshold.
3741
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
3742
3743
3744
3745
3746
3747
3748
            num_tokens_unpadded=total_num_scheduled_tokens,
            parallel_config=self.vllm_config.parallel_config,
            allow_microbatching=allow_microbatching,
            allow_dp_padding=allow_dp_padding,
            num_tokens_padded=total_num_scheduled_tokens,
            uniform_decode=uniform_decode,
            num_scheduled_tokens_per_request=num_scheduled_tokens,
3749
3750
3751
        )
        num_tokens_after_padding = num_tokens
        if num_tokens_across_dp is not None:
3752
3753
            dp_rank = self.parallel_config.data_parallel_rank
            num_tokens_after_padding = int(num_tokens_across_dp[dp_rank])
3754

3755
        attn_metadata: PerLayerAttnMetadata | None = None
3756
3757
3758

        # If force_attention is True, we always capture attention. Otherwise,
        # it only happens for cudagraph_runtime_mode=FULL.
3759
        if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
3760
3761
3762
3763
3764
3765
            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:
3766
                seq_lens = max_query_len  # type: ignore[assignment]
3767
            self.seq_lens.np[:num_reqs] = seq_lens
3768
3769
            self.seq_lens.np[num_reqs:] = 0
            self.seq_lens.copy_to_gpu()
3770

3771
3772
            cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
            self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
3773
3774
            self.query_start_loc.copy_to_gpu()

3775
3776
3777
3778
3779
3780
3781
            attn_metadata, _ = self._build_attention_metadata(
                total_num_scheduled_tokens=num_tokens,
                max_num_scheduled_tokens=max_query_len,
                num_reqs=num_reqs,
                ubatch_slices=ubatch_slices,
                for_cudagraph_capture=True,
            )
3782

3783
        with self.maybe_dummy_run_with_lora(
3784
3785
3786
3787
3788
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            activate_lora,
            remove_lora,
3789
        ):
3790
3791
3792
            # Make sure padding doesn't exceed max_num_tokens
            assert num_tokens_after_padding <= self.max_num_tokens
            model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3793
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
3794
                input_ids = None
3795
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
3796
                model_kwargs = {
3797
                    **model_kwargs,
3798
3799
                    **self._dummy_mm_kwargs(num_reqs),
                }
3800
3801
            elif self.enable_prompt_embeds:
                input_ids = None
3802
3803
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
                model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3804
            else:
3805
                input_ids = self.input_ids.gpu[:num_tokens_after_padding]
3806
                inputs_embeds = None
3807

3808
            if self.uses_mrope:
3809
                positions = self.mrope_positions.gpu[:, :num_tokens_after_padding]
3810
            else:
3811
                positions = self.positions.gpu[:num_tokens_after_padding]
3812
3813
3814
3815
3816
3817
3818
3819
3820

            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,
3821
3822
3823
                            device=self.device,
                        )
                    )
3824
3825

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
3826
                    num_tokens_after_padding, None, False
3827
                )
3828
3829

            # filter out the valid batch descriptor
3830
3831
3832
3833
3834
            _cg_mode, batch_descriptor = (
                self.cudagraph_dispatcher.dispatch(
                    BatchDescriptor(
                        num_tokens=num_tokens_after_padding,
                        uniform_decode=uniform_decode,
3835
                        has_lora=activate_lora and self.lora_config is not None,
3836
3837
3838
3839
3840
                    )
                )
                if not is_profile
                else (CUDAGraphMode.NONE, None)
            )
3841
3842
3843
            if cudagraph_runtime_mode is not None:
                # we allow forcing NONE when the dispatcher disagrees to support
                # warm ups for cudagraph capture
3844
3845
3846
3847
                assert (
                    cudagraph_runtime_mode == CUDAGraphMode.NONE
                    or cudagraph_runtime_mode == _cg_mode
                ), (
3848
                    f"Cudagraph runtime mode mismatch at dummy_run. "
3849
3850
                    f"Expected {_cg_mode}, but got {cudagraph_runtime_mode}."
                )
3851
3852
            else:
                cudagraph_runtime_mode = _cg_mode
3853

3854
            if ubatch_slices is not None:
3855
3856
3857
3858
3859
3860
3861
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
                num_tokens_after_padding = ubatch_slices[0].num_tokens
                if num_tokens_across_dp is not None:
                    num_tokens_across_dp[:] = num_tokens_after_padding

3862
3863
3864
            with (
                self.maybe_randomize_inputs(input_ids),
                set_forward_context(
3865
3866
                    attn_metadata,
                    self.vllm_config,
3867
                    num_tokens=num_tokens_after_padding,
3868
3869
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
3870
                    batch_descriptor=batch_descriptor,
3871
3872
3873
                    ubatch_slices=ubatch_slices,
                ),
            ):
3874
                outputs = self.model(
3875
3876
3877
3878
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
3879
                    **model_kwargs,
3880
                )
3881

3882
3883
3884
3885
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
3886

3887
            if self.speculative_config and self.speculative_config.use_eagle():
3888
                assert isinstance(self.drafter, EagleProposer)
3889
3890
3891
3892
                use_cudagraphs = (
                    cudagraph_runtime_mode == CUDAGraphMode.PIECEWISE
                    and not self.speculative_config.enforce_eager
                )
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904

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

3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
        # 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)

3916
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
3917
3918
3919
3920
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
3921
3922
3923
3924
3925
3926

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
3927
3928
3929
3930
        # 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)
3931

3932
        logits = self.model.compute_logits(hidden_states)
3933
3934
        num_reqs = logits.size(0)

3935
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950

        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)],
3951
            spec_token_ids=[[] for _ in range(num_reqs)],
3952
3953
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
3954
            logitsprocs=LogitsProcessors(),
3955
        )
3956
        try:
3957
3958
3959
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
3960
        except RuntimeError as e:
3961
            if "out of memory" in str(e):
3962
3963
3964
3965
                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 "
3966
3967
                    "initializing the engine."
                ) from e
3968
3969
            else:
                raise e
3970
        if self.speculative_config:
3971
3972
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
3973
3974
                draft_token_ids, self.device
            )
3975
3976
3977
3978
3979
3980

            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
3981
3982
3983
3984
3985
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
3986
            )
3987
3988
3989
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
3990
                logits,
3991
3992
                dummy_metadata,
            )
3993
        return sampler_output
3994

3995
    def _dummy_pooler_run_task(
3996
3997
        self,
        hidden_states: torch.Tensor,
3998
3999
        task: PoolingTask,
    ) -> PoolerOutput:
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
        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

4011
        dummy_prompt_lens = torch.tensor(
4012
4013
            num_scheduled_tokens_list,
            device="cpu",
4014
        )
4015
4016
4017
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
4018

4019
        model = cast(VllmModelForPooling, self.get_model())
4020
        dummy_pooling_params = PoolingParams(task=task)
4021
        dummy_pooling_params.verify(task=task, model_config=self.model_config)
4022
        to_update = model.pooler.get_pooling_updates(task)
4023
4024
        to_update.apply(dummy_pooling_params)

4025
        dummy_metadata = PoolingMetadata(
4026
4027
4028
4029
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
        )
4030

4031
4032
4033
        dummy_metadata.build_pooling_cursor(
            num_scheduled_tokens_list, device=hidden_states.device
        )
4034

4035
        try:
4036
4037
4038
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
4039
        except RuntimeError as e:
4040
            if "out of memory" in str(e):
4041
                raise RuntimeError(
4042
4043
4044
                    "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 "
4045
4046
                    "initializing the engine."
                ) from e
4047
4048
            else:
                raise e
4049
4050
4051
4052
4053
4054
4055

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

        if not supported_pooling_tasks:
4059
            if self.scheduler_config.enable_chunked_prefill:
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
                raise RuntimeError(
                    f"Model {self.model_config.model} does not support "
                    "any pooling tasks with chunked prefill enabled. "
                    "Please add --no-enable-chunked-prefill to your "
                    "config or CLI args. See "
                    "https://docs.vllm.ai/en/latest/models/pooling_models.html "
                    "to learn more."
                )
            else:
                raise RuntimeError(
                    f"Model {self.model_config.model} does not support "
                    "any pooling tasks. See "
                    "https://docs.vllm.ai/en/latest/models/pooling_models.html "
                    "to learn more."
                )

4076
        output_size = dict[PoolingTask, float]()
4077
        for task in supported_pooling_tasks:
4078
4079
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
4080
            output_size[task] = sum(o.nbytes for o in output)
4081
4082
4083
4084
            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)
4085

4086
    def profile_run(self) -> None:
4087
        # Profile with multimodal encoder & encoder cache.
4088
        if self.supports_mm_inputs:
4089
            if self.model_config.multimodal_config.skip_mm_profiling:
4090
                logger.info(
4091
                    "Skipping memory profiling for multimodal encoder and "
4092
4093
                    "encoder cache."
                )
4094
4095
4096
4097
4098
4099
4100
4101
            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.
4102
                    dummy_modality = mm_budget.get_modality_with_max_tokens()
4103
4104
4105
                    max_mm_items_per_batch = mm_budget.max_items_per_batch_by_modality[
                        dummy_modality
                    ]
4106
4107
4108
4109
4110
4111
4112
4113
4114

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

4116
4117
4118
4119
4120
                    # Create dummy batch of multimodal inputs.
                    batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                        dummy_modality,
                        max_mm_items_per_batch,
                    )
4121

4122
                    # Run multimodal encoder.
4123
                    dummy_encoder_outputs = self.model.embed_multimodal(
4124
4125
                        **batched_dummy_mm_inputs
                    )
4126

4127
4128
4129
4130
                    sanity_check_mm_encoder_outputs(
                        dummy_encoder_outputs,
                        expected_num_items=max_mm_items_per_batch,
                    )
4131

4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
                    # NOTE: This happens when encoder cache needs to store
                    # the embeddings that encoder outputs are scattered onto.
                    # In this case we create dummy embeddings of size
                    # (encode_budget, hidden_size) and scatter encoder
                    # output into it.
                    encoder_output_shape = dummy_encoder_outputs[0].shape
                    if encoder_output_shape[0] < encoder_budget:
                        expanded_outputs = []
                        for output in dummy_encoder_outputs:
                            expanded = output.new_zeros(
4142
4143
                                (encoder_budget, encoder_output_shape[-1])
                            )
4144
4145
4146
4147
4148
4149
                            num_tokens = output.shape[0]
                            expanded[:num_tokens].copy_(output)
                            expanded_outputs.append(expanded)

                        dummy_encoder_outputs = expanded_outputs

4150
                    # Cache the dummy encoder outputs.
4151
                    self.encoder_cache["tmp"] = dict(enumerate(dummy_encoder_outputs))
4152

4153
        # Add `is_profile` here to pre-allocate communication buffers
4154
4155
4156
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
4157
        if get_pp_group().is_last_rank:
4158
4159
4160
4161
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
4162
        else:
4163
            output = None
4164
        self._sync_device()
4165
        del hidden_states, output
4166
        self.encoder_cache.clear()
4167
        gc.collect()
4168

4169
    def capture_model(self) -> int:
4170
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
4171
            logger.warning(
4172
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
4173
4174
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
4175
            return 0
4176

4177
4178
        compilation_counter.num_gpu_runner_capture_triggers += 1

4179
4180
        start_time = time.perf_counter()

4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
        @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()
4195
                    gc.collect()
4196

4197
4198
4199
        # 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.
4200
        set_cudagraph_capturing_enabled(True)
4201
        with freeze_gc(), graph_capture(device=self.device):
4202
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
4203
            cudagraph_mode = self.compilation_config.cudagraph_mode
4204
            assert cudagraph_mode is not None
4205
4206
4207
4208
4209
4210
4211
4212
4213

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

4214
4215
            if cudagraph_mode.mixed_mode() != CUDAGraphMode.NONE:
                cudagraph_runtime_mode = cudagraph_mode.mixed_mode()
4216
                # make sure we capture the largest batch size first
4217
4218
4219
                compilation_cases = list(
                    product(reversed(self.cudagraph_batch_sizes), lora_cases)
                )
4220
4221
4222
                self._capture_cudagraphs(
                    compilation_cases,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4223
4224
                    uniform_decode=False,
                )
4225

4226
4227
            # Capture full cudagraph for uniform decode batches if we
            # don't already have full mixed prefill-decode cudagraphs.
4228
4229
4230
4231
4232
4233
4234
            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
                )
4235
                decode_cudagraph_batch_sizes = [
4236
4237
                    x
                    for x in self.cudagraph_batch_sizes
4238
                    if max_num_tokens >= x >= self.uniform_decode_query_len
4239
                ]
4240
4241
4242
                compilation_cases_decode = list(
                    product(reversed(decode_cudagraph_batch_sizes), lora_cases)
                )
4243
4244
4245
                self._capture_cudagraphs(
                    compilation_cases=compilation_cases_decode,
                    cudagraph_runtime_mode=CUDAGraphMode.FULL,
4246
4247
                    uniform_decode=True,
                )
4248

4249
4250
4251
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

4252
4253
4254
        # 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
4255
        # we may do lazy capturing in future that still allows capturing
4256
4257
        # after here.
        set_cudagraph_capturing_enabled(False)
4258
4259
4260
4261
4262

        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.
4263
        logger.info_once(
4264
4265
4266
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
4267
            scope="local",
4268
        )
4269
        return cuda_graph_size
4270

4271
4272
    def _capture_cudagraphs(
        self,
4273
        compilation_cases: list[tuple[int, bool]],
4274
4275
4276
4277
4278
4279
4280
        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}"
4281
4282
4283
4284
4285
4286
4287
4288

        # 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",
4289
4290
4291
                    cudagraph_runtime_mode.name,
                ),
            )
4292

4293
        # We skip EPLB here since we don't want to record dummy metrics
4294
        for num_tokens, activate_lora in compilation_cases:
4295
            # We currently only capture ubatched graphs when its a FULL
4296
4297
4298
            # 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
4299
4300
4301
4302
            allow_microbatching = (
                self.parallel_config.enable_dbo
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
4303
4304
4305
4306
4307
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
4308
            )
4309

4310
4311
4312
4313
4314
4315
            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.
4316
4317
4318
4319
4320
4321
4322
4323
4324
                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,
4325
                    activate_lora=activate_lora,
4326
4327
4328
4329
4330
4331
4332
4333
                )
            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,
4334
                activate_lora=activate_lora,
4335
            )
4336
        self.maybe_remove_all_loras(self.lora_config)
4337

4338
4339
4340
4341
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
4342
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
4343

4344
4345
4346
4347
4348
4349
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
4350
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
4351
            layers = get_layers_from_vllm_config(
4352
4353
                self.vllm_config, AttentionLayerBase, kv_cache_group_spec.layer_names
            )
4354
4355
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
4356
            # Dedupe based on full class name; this is a bit safer than
4357
4358
4359
4360
            # 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.
4361
            for layer_name in kv_cache_group_spec.layer_names:
4362
                attn_backend = layers[layer_name].get_attn_backend()
4363
4364
4365
4366
4367
4368
4369

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
                        attn_backend,
                    )

4370
4371
4372
                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):
4373
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
4374
                key = (full_cls_name, layer_kv_cache_spec)
4375
4376
4377
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
4378
                attn_backend_layers[key].append(layer_name)
4379
4380
4381
4382
            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()),
            )
4383
4384

        def create_attn_groups(
4385
            attn_backends_map: dict[AttentionGroupKey, list[str]],
4386
            kv_cache_group_id: int,
4387
4388
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
4389
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
4390
                attn_group = AttentionGroup(
4391
                    attn_backend,
4392
                    layer_names,
4393
                    kv_cache_spec,
4394
                    kv_cache_group_id,
4395
4396
                )

4397
4398
4399
                attn_groups.append(attn_group)
            return attn_groups

4400
        attention_backend_maps = []
4401
        attention_backend_list = []
4402
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
4403
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
4404
            attention_backend_maps.append(attn_backends[0])
4405
            attention_backend_list.append(attn_backends[1])
4406
4407

        # Resolve cudagraph_mode before actually initialize metadata_builders
4408
4409
4410
        self._check_and_update_cudagraph_mode(
            attention_backend_list, kv_cache_config.kv_cache_groups
        )
4411

4412
4413
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
4414

4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
    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
4433
        # Calculate reorder batch threshold (if needed)
4434
4435
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
4436
4437
        self.calculate_reorder_batch_threshold()

4438
    def _check_and_update_cudagraph_mode(
4439
4440
4441
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
4442
    ) -> None:
4443
        """
4444
        Resolve the cudagraph_mode when there are multiple attention
4445
        groups with potential conflicting CUDA graph support.
4446
4447
4448
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
4449
        min_cg_support = AttentionCGSupport.ALWAYS
4450
        min_cg_backend_name = None
4451

4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
        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__
4464
4465
4466
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
        # check cudagraph for mixed batch is supported
4467
4468
4469
4470
4471
4472
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4473
                f"with {min_cg_backend_name} backend (support: "
4474
4475
                f"{min_cg_support})"
            )
4476
4477
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
4478
4479
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
4480
                    "make sure compilation mode is VLLM_COMPILE"
4481
                )
4482
4483
4484
4485
4486
                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"
4487
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4488
                    CUDAGraphMode.FULL_AND_PIECEWISE
4489
                )
4490
4491
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
4492
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4493
                    CUDAGraphMode.FULL_DECODE_ONLY
4494
                )
4495
4496
            logger.warning(msg)

4497
        # check that if we are doing decode full-cudagraphs it is supported
4498
4499
4500
4501
4502
4503
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4504
                f"with {min_cg_backend_name} backend (support: "
4505
4506
                f"{min_cg_support})"
            )
4507
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
4508
4509
4510
4511
4512
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
4513
                    "attention is compiled piecewise"
4514
4515
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4516
                    CUDAGraphMode.PIECEWISE
4517
                )
4518
            else:
4519
4520
                msg += (
                    "; setting cudagraph_mode=NONE because "
4521
                    "attention is not compiled piecewise"
4522
4523
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4524
                    CUDAGraphMode.NONE
4525
                )
4526
4527
            logger.warning(msg)

4528
4529
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
4530
4531
4532
4533
4534
4535
4536
4537
        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 "
4538
                f"{min_cg_backend_name} (support: {min_cg_support})"
4539
            )
4540
4541
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
4542
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4543
                    CUDAGraphMode.PIECEWISE
4544
                )
4545
4546
            else:
                msg += "; setting cudagraph_mode=NONE"
4547
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4548
                    CUDAGraphMode.NONE
4549
                )
4550
4551
4552
4553
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
4554
4555
4556
4557
4558
4559
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
4560
                f"supported with {min_cg_backend_name} backend ("
4561
4562
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
4563
                "and make sure compilation mode is VLLM_COMPILE"
4564
            )
4565

4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
        # 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
            )
            self.cudagraph_batch_sizes = self.compilation_config.cudagraph_capture_sizes

4582
4583
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
4584
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
4585
4586
            self.compilation_config.cudagraph_mode, self.uniform_decode_query_len
        )
4587

4588
4589
    def calculate_reorder_batch_threshold(self) -> None:
        """
4590
4591
4592
4593
        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.
4594
        """
4595
4596
4597
4598
4599
4600
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

        reorder_batch_thresholds = [
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
4601
4602
4603
4604
4605
        # 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
4606
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)
4607

4608
4609
4610
    @staticmethod
    def select_common_block_size(
        kv_manager_block_size: int, attn_groups: list[AttentionGroup]
4611
4612
    ) -> int:
        """
4613
4614
4615
4616
4617
        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.
4618
4619
4620
4621
4622
4623

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

        Returns:
4624
            The selected block size
4625
4626

        Raises:
4627
            ValueError: If no valid block size found
4628
4629
        """

4630
4631
4632
4633
4634
4635
4636
4637
        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
4638
                for supported_size in backend.supported_kernel_block_sizes:
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
                    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
4669
            for supported_size in backend.supported_kernel_block_sizes
4670
4671
            if isinstance(supported_size, int)
        )
4672

4673
4674
4675
4676
4677
4678
        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}. ")
4679

4680
4681
4682
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
4683
4684
4685
4686
4687
4688
4689
        """
        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.
4690
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4691
4692
4693
4694
        """
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
4695
            if not isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec)
4696
        ]
4697
4698
4699
4700

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
4701
4702
4703
            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
4704
4705
                "for more details."
            )
4706
4707
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
4708
                max_model_len=max(self.max_model_len, self.max_encoder_len),
4709
4710
4711
4712
4713
                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,
4714
                kernel_block_sizes=kernel_block_sizes,
4715
                is_spec_decode=bool(self.vllm_config.speculative_config),
4716
                logitsprocs=self.input_batch.logitsprocs,
4717
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
4718
                is_pooling_model=self.is_pooling_model,
4719
                num_speculative_tokens=self.num_spec_tokens,
4720
4721
            )

4722
    def _allocate_kv_cache_tensors(
4723
4724
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
4725
        """
4726
4727
4728
        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.

4729
        Args:
4730
            kv_cache_config: The KV cache config
4731
        Returns:
4732
            dict[str, torch.Tensor]: A map between layer names to their
4733
            corresponding memory buffer for KV cache.
4734
        """
4735
4736
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
4737
4738
4739
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
4740
4741
4742
4743
4744
            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:
4745
4746
4747
4748
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
4749
4750
4751
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
4752
4753
        return kv_cache_raw_tensors

4754
4755
4756
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

4757
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
4758
4759
        if not self.kv_cache_config.kv_cache_groups:
            return
4760
4761
        for attn_groups in self.attn_groups:
            yield from attn_groups
4762

4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
    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 = []
4778
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
4779
4780
4781
4782
4783
4784
            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):
4785
                continue
4786
            elif isinstance(kv_cache_spec, AttentionSpec):
4787
4788
4789
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
4790
                attn_groups = self.attn_groups[kv_cache_gid]
4791
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
4792
                selected_kernel_size = self.select_common_block_size(
4793
4794
4795
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
4796
            elif isinstance(kv_cache_spec, MambaSpec):
4797
4798
                # This is likely Mamba or other non-attention cache,
                # no splitting.
4799
                kernel_block_sizes.append(kv_cache_spec.block_size)
4800
4801
4802
4803
4804
4805
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

4806
4807
4808
4809
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
4810
        kernel_block_sizes: list[int],
4811
    ) -> dict[str, torch.Tensor]:
4812
        """
4813
        Reshape the KV cache tensors to the desired shape and dtype.
4814

4815
        Args:
4816
4817
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
4818
                correct size but uninitialized shape.
4819
            kernel_block_sizes: The kernel block sizes for each KV cache group.
4820
        Returns:
4821
            Dict[str, torch.Tensor]: A map between layer names to their
4822
4823
            corresponding memory buffer for KV cache.
        """
4824
        kv_caches: dict[str, torch.Tensor] = {}
4825
        has_attn, has_mamba = False, False
4826
4827
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
4828
            attn_backend = group.backend
4829
4830
4831
4832
            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]
4833
            for layer_name in group.layer_names:
4834
4835
                if layer_name in self.runner_only_attn_layers:
                    continue
4836
4837
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
4838
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
4839
                if isinstance(kv_cache_spec, AttentionSpec):
4840
                    has_attn = True
4841
4842
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
4843
4844
4845
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

4846
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
4847
                        kernel_num_blocks,
4848
                        kernel_block_size,
4849
4850
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
4851
4852
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
4853
                    dtype = kv_cache_spec.dtype
4854
                    try:
4855
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
4856
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
4857
                    except (AttributeError, NotImplementedError):
4858
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
4859
4860
4861
4862
4863
                    # 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.
4864
4865
4866
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
4867
4868
4869
4870
4871
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
4872
4873
4874
4875
4876
4877
                    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
4878
                elif isinstance(kv_cache_spec, MambaSpec):
4879
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
4880
4881
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
4882
                    storage_offset_bytes = 0
4883
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
4884
4885
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
4886
4887
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
4888
                        target_shape = (num_blocks, *shape)
4889
4890
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
4891
                        assert storage_offset_bytes % dtype_size == 0
4892
4893
4894
4895
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
4896
                            storage_offset=storage_offset_bytes // dtype_size,
4897
                        )
Chen Zhang's avatar
Chen Zhang committed
4898
                        state_tensors.append(tensor)
4899
                        storage_offset_bytes += stride[0] * dtype_size
4900
4901

                    kv_caches[layer_name] = state_tensors
4902
                else:
4903
                    raise NotImplementedError
4904
4905

        if has_attn and has_mamba:
4906
            self._update_hybrid_attention_mamba_layout(kv_caches)
4907

4908
4909
        return kv_caches

4910
    def _update_hybrid_attention_mamba_layout(
4911
4912
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
4913
        """
4914
4915
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
4916
4917

        Args:
4918
            kv_caches: The KV cache buffer of each layer.
4919
4920
        """

4921
4922
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
4923
            for layer_name in group.layer_names:
4924
                kv_cache = kv_caches[layer_name]
4925
4926
4927
4928
                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 "
4929
                        f"a tensor of shape {kv_cache.shape}"
4930
                    )
4931
                    hidden_size = kv_cache.shape[2:].numel()
4932
4933
4934
4935
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
4936

4937
    def initialize_kv_cache_tensors(
4938
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
4939
    ) -> dict[str, torch.Tensor]:
4940
4941
4942
4943
4944
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
4945
4946
            kernel_block_sizes: The kernel block sizes for each KV cache group.

4947
        Returns:
4948
            Dict[str, torch.Tensor]: A map between layer names to their
4949
4950
4951
4952
4953
            corresponding memory buffer for KV cache.
        """
        # 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
4954
        kv_caches = self._reshape_kv_cache_tensors(
4955
            kv_cache_config, kv_cache_raw_tensors, kernel_block_sizes
4956
        )
4957

4958
        # Set up cross-layer KV cache sharing
4959
4960
        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)
4961
4962
            kv_caches[layer_name] = kv_caches[target_layer_name]

4963
4964
4965
4966
4967
4968
4969
4970
4971
        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,
        )
4972
4973
4974
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
4975
4976
        self, kv_cache_config: KVCacheConfig
    ) -> None:
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
        """
        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.
4995
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
4996
4997
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
4998
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
4999
5000
                else:
                    break
5001

5002
5003
5004
5005
5006
5007
5008
    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
        """
5009
        kv_cache_config = deepcopy(kv_cache_config)
5010
        self.kv_cache_config = kv_cache_config
5011
        self.may_add_encoder_only_layers_to_kv_cache_config()
5012
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
5013
        self.initialize_attn_backend(kv_cache_config)
5014
5015
5016
5017
5018
5019
        # 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)
5020
5021
5022
5023

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

5024
        # Reinitialize need to after initialize_attn_backend
5025
5026
5027
5028
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
5029

5030
5031
5032
5033
5034
5035
        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
5036
        if has_kv_transfer_group():
5037
5038
5039
            kv_transfer_group = get_kv_transfer_group()
            kv_transfer_group.register_kv_caches(kv_caches)
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
5040

5041
        if self.dcp_world_size > 1:
5042
            layers = get_layers_from_vllm_config(self.vllm_config, AttentionLayerBase)
5043
5044
5045
5046
5047
            for layer in layers.values():
                assert layer.impl.need_to_return_lse_for_decode, (
                    "DCP requires attention impls to return"
                    " the softmax lse for decode, but the impl "
                    f"{layer.impl.__class__.__name__} "
5048
5049
                    "does not return the softmax lse for decode."
                )
5050

5051
5052
5053
5054
5055
    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
5056
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
5057
5058
5059
        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:
5060
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
5061
5062
5063
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
5064
5065
                    dtype=self.kv_cache_dtype,
                )
5066
5067
5068
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
5069
5070
5071
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
5072
5073
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
5074
5075
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
5076

5077
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
5078
        """
5079
        Generates the KVCacheSpec by parsing the kv cache format from each
5080
5081
        Attention module in the static forward context.
        Returns:
5082
            KVCacheSpec: A dictionary mapping layer names to their KV cache
5083
5084
            format. Layers that do not need KV cache are not included.
        """
5085
5086
        if has_ec_transfer() and get_ec_transfer().is_producer:
            return {}
5087
        kv_cache_spec: dict[str, KVCacheSpec] = {}
5088
        attn_layers = get_layers_from_vllm_config(self.vllm_config, AttentionLayerBase)
Chen Zhang's avatar
Chen Zhang committed
5089
        for layer_name, attn_module in attn_layers.items():
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
            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
5105

5106
        return kv_cache_spec
5107

Cyrus Leung's avatar
Cyrus Leung committed
5108
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[np.ndarray]:
5109
5110
5111
5112
5113
5114
5115
5116
        # 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.
5117
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
5118
5119
5120
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
Cyrus Leung's avatar
Cyrus Leung committed
5121
        return [row for row in pinned.numpy()]