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

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

import numpy as np
import torch
import torch.distributed
import torch.nn as nn
21
from tqdm import tqdm
22

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

183
184
185
186
187
188
from .utils import (
    AttentionGroup,
    add_kv_sharing_layers_to_kv_cache_groups,
    bind_kv_cache,
    sanity_check_mm_encoder_outputs,
)
189

190
if TYPE_CHECKING:
191
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
192
    from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
193
    from vllm.v1.spec_decode.ngram_proposer import NgramProposer
194
195
196

logger = init_logger(__name__)

197
198
AttnMetadataDict: TypeAlias = dict[str, AttentionMetadata]
# list when ubatching is enabled
199
PerLayerAttnMetadata: TypeAlias = list[AttnMetadataDict] | AttnMetadataDict
200

201

202
203
204
205
206
207
# Wrapper for ModelRunnerOutput to support overlapped execution.
class AsyncGPUModelRunnerOutput(AsyncModelRunnerOutput):
    def __init__(
        self,
        model_runner_output: ModelRunnerOutput,
        sampled_token_ids: torch.Tensor,
208
        logprobs_tensors: LogprobsTensors | None,
209
210
        invalid_req_indices: list[int],
        async_output_copy_stream: torch.cuda.Stream,
211
        vocab_size: int,
212
213
214
215
216
    ):
        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.
217
        self.async_copy_ready_event = torch.Event()
218
219
220
221

        # 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
222
        self.vocab_size = vocab_size
223
        self._logprobs_tensors = logprobs_tensors
224
225
226
227
228

        # 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)
229
            self.sampled_token_ids_cpu = self._sampled_token_ids.to(
230
231
                "cpu", non_blocking=True
            )
232
233
234
235
236
            self._logprobs_tensors_cpu = (
                self._logprobs_tensors.to_cpu_nonblocking()
                if self._logprobs_tensors
                else None
            )
237
            self.async_copy_ready_event.record()
238
239
240

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

242
243
        This function blocks until the copy is finished.
        """
244
        max_gen_len = self.sampled_token_ids_cpu.shape[-1]
245
        self.async_copy_ready_event.synchronize()
246

247
248
        # Release the device tensors once the copy has completed.
        del self._logprobs_tensors
249
        del self._sampled_token_ids
250
        if max_gen_len == 1:
251
            valid_sampled_token_ids = self.sampled_token_ids_cpu.tolist()
252
253
            for i in self._invalid_req_indices:
                valid_sampled_token_ids[i].clear()
254
255
256
            logprobs_lists = None
            if self._logprobs_tensors_cpu is not None:
                logprobs_lists = self._logprobs_tensors_cpu.tolists()
257
        else:
258
            valid_sampled_token_ids, logprobs_lists = RejectionSampler.parse_output(
259
260
                self.sampled_token_ids_cpu,
                self.vocab_size,
261
                self._invalid_req_indices,
262
                logprobs_tensors=self._logprobs_tensors_cpu,
263
            )
264
265
266

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
267
        output.logprobs = logprobs_lists
268
269
270
        return output


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
class AsyncGPUPoolingModelRunnerOutput(AsyncModelRunnerOutput):
    def __init__(
        self,
        model_runner_output: ModelRunnerOutput,
        raw_pooler_output: PoolerOutput,
        finished_mask: list[bool],
        async_output_copy_stream: torch.cuda.Stream,
    ):
        self._model_runner_output = model_runner_output

        # Event on the copy stream so we can synchronize the non-blocking copy.
        self.async_copy_ready_event = torch.Event()

        # Keep a reference to the device tensors to avoid them being
        # deallocated until we finish copying it to the host.
        self._raw_pooler_output = raw_pooler_output

        # 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)
292
            raw_pooler_output_cpu = json_map_leaves(
293
294
295
296
                lambda x: None if x is None else x.to("cpu", non_blocking=True),
                self._raw_pooler_output,
            )
            self.async_copy_ready_event.record()
297
298
299
300
            self._model_runner_output.pooler_output = [
                out if include else None
                for out, include in zip(raw_pooler_output_cpu, finished_mask)
            ]
301
302
303
304
305
306
307
308
309
310
311
312

    def get_output(self) -> ModelRunnerOutput:
        """Copy the device tensors to the host and return a ModelRunnerOutput.
        This function blocks until the copy is finished.
        """
        self.async_copy_ready_event.synchronize()

        # Release the device tensors once the copy has completed.
        del self._raw_pooler_output
        return self._model_runner_output


313
314
315
316
317
318
319
320
321
322
323
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
324
    ec_connector_output: ECConnectorOutput | None
325
    cudagraph_stats: CUDAGraphStat | None
326
    slot_mappings: dict[str, torch.Tensor] | list[dict[str, torch.Tensor]] | None
327
328


329
330
331
class GPUModelRunner(
    LoRAModelRunnerMixin, KVConnectorModelRunnerMixin, ECConnectorModelRunnerMixin
):
332
333
    def __init__(
        self,
334
        vllm_config: VllmConfig,
335
        device: torch.device,
336
    ):
337
338
339
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
340
        self.compilation_config = vllm_config.compilation_config
341
342
343
344
345
346
        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
347

348
349
350
351
        from vllm.model_executor.models.utils import (
            set_cpu_offload_max_bytes,
            set_cpu_offload_params,
        )
352
353

        set_cpu_offload_max_bytes(int(self.cache_config.cpu_offload_gb * 1024**3))
354
        set_cpu_offload_params(self.cache_config.cpu_offload_params)
355

356
357
358
359
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
360
        self.device = device
361
362
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
363

364
365
366
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
367

368
        self.is_pooling_model = model_config.runner_type == "pooling"
369
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
370
        self.is_multimodal_raw_input_only_model = (
371
372
            model_config.is_multimodal_raw_input_only_model
        )
373
374
        # This will be overridden in load_model()
        self.is_multimodal_pruning_enabled = False
375
        self.max_model_len = model_config.max_model_len
376
377
378

        # Always set to false after the first forward pass
        self.calculate_kv_scales = self.cache_config.calculate_kv_scales
379
        self.dcp_world_size = self.parallel_config.decode_context_parallel_size
380
        self.dcp_rank = 0 if self.dcp_world_size <= 1 else get_dcp_group().rank_in_group
381
        self.max_num_tokens = scheduler_config.max_num_batched_tokens
382
        self.max_num_reqs = scheduler_config.max_num_seqs
383

384
385
386
387
388
        # 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 = (
389
            self.parallel_config.distributed_executor_backend == "external_launcher"
390
            and len(get_pp_group().ranks) > 1
391
        )
392

393
        # Model-related.
394
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
395
        self.inputs_embeds_size = model_config.get_inputs_embeds_size()
396
        self.attention_chunk_size = model_config.attention_chunk_size
397
        # Only relevant for models using ALiBi (e.g, MPT)
398
        self.use_alibi = model_config.uses_alibi
399

400
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
401
        self.is_mm_prefix_lm = self.model_config.is_mm_prefix_lm
402

403
        # Multi-modal data support
404
        self.mm_registry = MULTIMODAL_REGISTRY
405
        self.uses_mrope = model_config.uses_mrope
406
        self.uses_xdrope_dim = model_config.uses_xdrope_dim
407
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
408
            model_config
409
        )
410

411
412
413
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
414
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
415
416
417
        else:
            self.max_encoder_len = 0

418
419
420
        # Async scheduling
        self.use_async_scheduling = self.scheduler_config.async_scheduling

421
        # Sampler
422
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
423

424
        self.eplb_state: EplbState | None = None
425
426
427
428
429
430
        """
        State of the expert parallelism load balancer.

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

431
        # Lazy initializations
432
        # self.model: nn.Module  # Set after load_model
433
        # Initialize in initialize_kv_cache
434
        self.kv_caches: list[torch.Tensor] = []
435
436
437
        # Initialize in initialize_kv_cache_tensors
        self.cross_layers_kv_cache: torch.Tensor | None = None
        self.cross_layers_attn_backend: type[AttentionBackend] | None = None
438
439
        # indexes: [kv_cache_group_id][attn_group]
        self.attn_groups: list[list[AttentionGroup]] = []
440
441
        # self.kv_cache_config: KVCacheConfig

442
443
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
444

445
        self.use_aux_hidden_state_outputs = False
446
447
448
449
450
        # 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:
451
            self.drafter: (
452
                NgramProposer  # noqa: F823
453
454
455
456
                | SuffixDecodingProposer
                | EagleProposer
                | DraftModelProposer
                | MedusaProposer
457
            )
458
            if self.speculative_config.method == "ngram":
459
460
                from vllm.v1.spec_decode.ngram_proposer import NgramProposer

461
                self.drafter = NgramProposer(self.vllm_config)
462
463
464
465
466
467
            elif self.speculative_config.uses_draft_model():
                self.drafter = DraftModelProposer(
                    vllm_config=self.vllm_config,
                    device=self.device,
                    runner=self,
                )
468
469
            elif self.speculative_config.method == "suffix":
                self.drafter = SuffixDecodingProposer(self.vllm_config)
470
            elif self.speculative_config.use_eagle():
471
                self.drafter = EagleProposer(self.vllm_config, self.device, self)
472
                if self.speculative_config.method == "eagle3":
473
474
475
                    self.use_aux_hidden_state_outputs = (
                        self.drafter.eagle3_use_aux_hidden_state
                    )
476
477
            elif self.speculative_config.method == "medusa":
                self.drafter = MedusaProposer(
478
                    vllm_config=self.vllm_config, device=self.device
479
                )
480
            else:
481
482
483
484
                raise ValueError(
                    "Unknown speculative decoding method: "
                    f"{self.speculative_config.method}"
                )
485
            self.rejection_sampler = RejectionSampler(self.sampler)
486

487
488
489
        self.num_spec_tokens = 0
        if self.speculative_config:
            self.num_spec_tokens = self.speculative_config.num_speculative_tokens
490
491
492
493
494
            draft_config = self.speculative_config.draft_model_config
            if draft_config is not None and draft_config.max_model_len is not None:
                self.effective_drafter_max_model_len = draft_config.max_model_len
            else:
                self.effective_drafter_max_model_len = self.max_model_len
495

496
        # Request states.
497
        self.requests: dict[str, CachedRequestState] = {}
498
499
500
        # NOTE(rob): num_prompt_logprobs only includes reqs
        # that are currently in the prefill phase.
        self.num_prompt_logprobs: dict[str, int] = {}
501
        self.comm_stream = torch.cuda.Stream()
502

503
504
505
506
507
508
509
510
511
        # 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.
512
513
514
515
        logits_processors = model_config.logits_processors
        custom_logitsprocs: Sequence[str | type[LogitsProcessor]] = (
            tuple(logits_processors) if logits_processors is not None else ()
        )
516
517
        self.input_batch = InputBatch(
            max_num_reqs=self.max_num_reqs,
518
519
520
            # 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),
521
522
523
            max_num_batched_tokens=self.max_num_tokens,
            device=self.device,
            pin_memory=self.pin_memory,
524
            vocab_size=self.model_config.get_vocab_size(),
525
526
            block_sizes=[self.cache_config.block_size],
            kernel_block_sizes=[self.cache_config.block_size],
527
            is_spec_decode=bool(self.vllm_config.speculative_config),
528
            logitsprocs=build_logitsprocs(
529
530
531
                self.vllm_config,
                self.device,
                self.pin_memory,
532
                self.is_pooling_model,
533
                custom_logitsprocs,
534
            ),
535
536
537
            # 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),
538
            is_pooling_model=self.is_pooling_model,
539
            cp_kv_cache_interleave_size=self.parallel_config.cp_kv_cache_interleave_size,
540
        )
541

542
543
544
545
546
        # 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.
547
        self.prepare_inputs_event: torch.Event | None = None
548
549
        if self.use_async_scheduling:
            self.async_output_copy_stream = torch.cuda.Stream()
550
            self.prepare_inputs_event = torch.Event()
551

552
        # self.cudagraph_batch_sizes sorts in ascending order.
553
554
555
556
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
557
558
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
559
            )
560

561
        # Cache the device properties.
562
        self._init_device_properties()
563

564
565
566
567
        # Encoder timing registry for observability
        self.encoder_timing_registry: dict[str, EncoderTimingStats] = {}
        self._encoder_timing_lock = threading.Lock()

568
        # Persistent buffers for CUDA graphs.
569
570
571
572
573
        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
        )
574
        self.seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
575
        self.encoder_seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
576
577
578
579
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
580
581
582
        # 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.
583
        self.inputs_embeds = self._make_buffer(
584
            self.max_num_tokens, self.inputs_embeds_size, dtype=self.dtype, numpy=False
585
586
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
587
588
        self.discard_request_mask = self._make_buffer(
            self.max_num_reqs, dtype=torch.bool
589
590
591
592
593
594
595
        )
        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
        )
596

597
598
        # Only relevant for multimodal models
        if self.supports_mm_inputs:
599
600
601
602
603
604
605
            # Double buffer to avoid race condition: previous iteration's async
            # copy may still be reading from CPU while current iteration writes.
            self.is_mm_embed_buffers = [
                self._make_buffer(self.max_num_tokens, dtype=torch.bool),
                self._make_buffer(self.max_num_tokens, dtype=torch.bool),
            ]
            self.is_mm_embed_idx = 0
606

607
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
608
        if self.uses_mrope:
Roger Wang's avatar
Roger Wang committed
609
610
611
612
            # 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
613
614
615
616
617
618

            # 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
619
            self.mrope_positions = self._make_buffer(
620
621
                (3, self.max_num_tokens + 1), dtype=torch.int64
            )
622

623
624
625
626
627
628
629
        # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
        if self.uses_xdrope_dim > 0:
            # Similar to mrope but use assigned dimension number for RoPE, 4 as default.
            self.xdrope_positions = self._make_buffer(
                (self.uses_xdrope_dim, self.max_num_tokens + 1), dtype=torch.int64
            )

630
        # None in the first PP rank. The rest are set after load_model.
631
        self.intermediate_tensors: IntermediateTensors | None = None
632

633
        # OPTIMIZATION: Cache the tensors rather than creating them every step.
634
        # Keep in int64 to avoid overflow with long context
635
636
637
638
        self.arange_np = np.arange(
            max(self.max_num_reqs + 1, self.max_model_len, self.max_num_tokens),
            dtype=np.int64,
        )
639

640
641
642
643
644
        # 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] = {}
645
646
647
648
649
        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(
650
651
                self.max_num_tokens, dtype=torch.int32, device=self.device
            )
652

653
        self.uniform_decode_query_len = 1 + self.num_spec_tokens
654
655
656
657

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

658
        self.mm_budget = (
659
            MultiModalBudget(self.vllm_config, self.mm_registry)
660
661
662
            if self.supports_mm_inputs
            else None
        )
663

664
        self.reorder_batch_threshold: int | None = None
665

666
667
668
669
670
        # 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()

671
        # Cached outputs.
672
        self._draft_token_ids: list[list[int]] | torch.Tensor | None = None
673
        self._draft_token_req_ids: list[str] | None = None
674
        self.transfer_event = torch.Event()
675
        self.sampled_token_ids_pinned_cpu = torch.empty(
676
            (self.max_num_reqs, 1),
677
678
            dtype=torch.int64,
            device="cpu",
679
680
            pin_memory=self.pin_memory,
        )
681

682
683
        # Pre-allocated tensor for copying valid sampled token counts to CPU,
        # with dedicated stream for overlapping and event for coordination.
684
        self.valid_sampled_token_count_event: torch.Event | None = None
685
        self.valid_sampled_token_count_copy_stream: torch.cuda.Stream | None = None
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
        # We also copy the drafted tokens to the CPU asynchronously,
        # in case we need them for structured outputs.
        self.draft_token_ids_event: torch.Event | None = None
        self.draft_token_ids_copy_stream: torch.cuda.Stream | None = None
        self.valid_sampled_token_count_cpu: torch.Tensor | None = None
        self.draft_token_ids_cpu: torch.Tensor | None = None
        if self.num_spec_tokens:
            self.draft_token_ids_event = torch.Event()
            self.draft_token_ids_copy_stream = torch.cuda.Stream()
            self.draft_token_ids_cpu = torch.empty(
                (self.max_num_reqs, self.num_spec_tokens),
                dtype=torch.int64,
                device="cpu",
                pin_memory=self.pin_memory,
            )
            if self.use_async_scheduling:
                self.valid_sampled_token_count_event = torch.Event()
                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,
                )
710

711
712
        # Ephemeral state transferred between execute_model() and sample_tokens().
        self.execute_model_state: ExecuteModelState | None = None
713
        self.kv_connector_output: KVConnectorOutput | None = None
714
        self.mamba_state_idx: dict[str, int] = {}
715
        self.layerwise_nvtx_hooks_registered = False
716

717
718
719
720
721
722
723
    def update_max_model_len(self, max_model_len: int) -> None:
        self.max_model_len = max_model_len
        if self.speculative_config:
            draft_config = self.speculative_config.draft_model_config
            if draft_config is None or draft_config.max_model_len is None:
                self.effective_drafter_max_model_len = self.max_model_len

724
    def reset_mm_cache(self) -> None:
725
726
727
728
        """
        Clear the multi-modal cache that was used during profiling,
        but no longer needed during inference.
        """
729
730
731
        if self.mm_budget:
            self.mm_budget.reset_cache()

732
733
734
735
736
737
738
739
    def reset_encoder_cache(self) -> None:
        """Clear the GPU-side encoder cache storing vision embeddings.

        This should be called when model weights are updated to ensure
        stale embeddings computed with old weights are not reused.
        """
        self.encoder_cache.clear()

740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
    @torch.inference_mode()
    def init_fp8_kv_scales(self) -> None:
        """
        Re-initialize the KV cache and FP8 scales after waking from sleep.
        1. Zero out the KV cache tensors to remove garbage data from re-allocation.
        2. Reset Attention layer scaling factors (_k_scale, _v_scale) to 1.0.
          If these are left at 0.0 (default after wake_up), all KV cache values
          become effectively zero, causing gibberish output.
        """
        if not self.cache_config.cache_dtype.startswith("fp8"):
            return

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

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

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

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

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

784
785
786
787
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
788
789
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, :num_tokens]
790
791
792
793
            return self.positions.gpu[:num_tokens]
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
794
795
            if self.uses_xdrope_dim > 0:
                return self.xdrope_positions.gpu[:, num_tokens]
796
797
            return self.positions.gpu[num_tokens]

798
    def _make_buffer(
799
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
800
801
802
803
804
805
806
807
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
808

809
    def _init_model_kwargs(self):
810
811
        model_kwargs = dict[str, Any]()

812
        if not self.is_pooling_model:
813
814
            return model_kwargs

815
816
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
817
818
819

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
820
821
822
823
824
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
825
826
827
828
829
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

830
        seq_lens = self.seq_lens.gpu[:num_reqs]
831
832
833
834
835
836
837
838
        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(
839
840
            device=self.device
        )
841
842
        return model_kwargs

843
    def _may_reorder_batch(self, scheduler_output: "SchedulerOutput") -> None:
844
845
        """
        Update the order of requests in the batch based on the attention
846
        backend's needs. For example, some attention backends (namely MLA) may
847
848
849
850
851
852
        want to separate requests based on if the attention computation will be
        compute-bound or memory-bound.

        Args:
            scheduler_output: The scheduler output.
        """
853
854
855
856
857
858
859
860
        # 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

861
862
863
864
        if self.reorder_batch_threshold is not None:
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
865
866
                decode_threshold=self.reorder_batch_threshold,
            )
867

868
869
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
870
        """Initialize attributes from torch.cuda.get_device_properties"""
871
872
873
874
875
876
877
        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()

878
    def _update_states(self, scheduler_output: "SchedulerOutput") -> None:
879
880
881
882
883
884
        """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.

885
886
        The SamplingMetadata is updated and copied to the GPU if there is a
        new/resumed/paused/finished request in the batch.
887
888
        """
        # Remove finished requests from the cached states.
889
890
        for req_id in scheduler_output.finished_req_ids:
            self.requests.pop(req_id, None)
891
            self.num_prompt_logprobs.pop(req_id, None)
892
893
894
895
896
897
898
        # 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:
899
            self.input_batch.remove_request(req_id)
900
901

        # Free the cached encoder outputs.
902
903
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
904

905
906
907
908
909
910
911
        # 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()
912
913
914
915
916
917
918
919
        resumed_req_ids = scheduler_output.scheduled_cached_reqs.resumed_req_ids
        # NOTE(zhuohan): cached_req_ids and resumed_req_ids are usually disjoint,
        # so `(scheduled_req_ids - resumed_req_ids) == scheduled_req_ids` holds
        # apart from the forced-preemption case in reset_prefix_cache. And in
        # that case we include the resumed_req_ids in the unscheduled set so
        # that they get cleared from the persistent batch before being re-scheduled
        # in the normal resumed request path.
        unscheduled_req_ids = cached_req_ids - (scheduled_req_ids - resumed_req_ids)
920
921
922
923
924
        # 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:
925
            self.input_batch.remove_request(req_id)
926

927
        reqs_to_add: list[CachedRequestState] = []
928
        # Add new requests to the cached states.
929
930
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
931
932
933
934
935
936
            if req_id in self.requests:
                # For streaming case only.
                req_state = self._update_streaming_request(req_id, new_req_data)
                reqs_to_add.append(req_state)
                continue

937
            sampling_params = new_req_data.sampling_params
938
            pooling_params = new_req_data.pooling_params
939

940
941
942
943
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
944
945
946
947
948
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

949
950
            if self.is_pooling_model:
                assert pooling_params is not None
951
952
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
953

954
                model = cast(VllmModelForPooling, self.get_model())
955
                to_update = model.pooler.get_pooling_updates(task)
956
957
                to_update.apply(pooling_params)

958
            req_state = CachedRequestState(
959
                req_id=req_id,
960
                prompt_token_ids=new_req_data.prompt_token_ids,
961
                prompt_embeds=new_req_data.prompt_embeds,
962
                mm_features=new_req_data.mm_features,
963
                sampling_params=sampling_params,
964
                pooling_params=pooling_params,
965
                generator=generator,
966
967
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
968
                output_token_ids=[],
969
                lora_request=new_req_data.lora_request,
970
            )
971
972
            self.requests[req_id] = req_state

973
974
975
976
977
978
979
            if sampling_params and sampling_params.prompt_logprobs is not None:
                self.num_prompt_logprobs[req_id] = (
                    self.input_batch.vocab_size
                    if sampling_params.prompt_logprobs == -1
                    else sampling_params.prompt_logprobs
                )

980
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
981
            if self.uses_mrope:
982
                self._init_mrope_positions(req_state)
983

984
985
986
987
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            if self.uses_xdrope_dim > 0:
                self._init_xdrope_positions(req_state)

988
            reqs_to_add.append(req_state)
989

990
        # Update the states of the running/resumed requests.
991
        is_last_rank = get_pp_group().is_last_rank
992
        req_data = scheduler_output.scheduled_cached_reqs
993
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens
994
995
996
997
998

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

999
        for i, req_id in enumerate(req_data.req_ids):
1000
            req_state = self.requests[req_id]
1001
1002
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
1003
            resumed_from_preemption = req_id in req_data.resumed_req_ids
1004
            num_output_tokens = req_data.num_output_tokens[i]
1005
            req_index = self.input_batch.req_id_to_index.get(req_id)
1006

1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
            if req_state.prev_num_draft_len and self.use_async_scheduling:
                # 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.
1021
1022
1023
1024
1025
1026
1027
1028
1029
                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)
1030

1031
            # Update the cached states.
1032
            req_state.num_computed_tokens = num_computed_tokens
1033
1034

            if not is_last_rank:
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
                if not req_data.new_token_ids:
                    # Async scheduled PP: Sampled tokens propagated via GPU broadcast.
                    new_token_ids: list[int] = []
                else:
                    # Non-async scheduling with PP: The scheduler sends
                    # sampled token ids 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.
                    num_new_tokens = (
                        num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                    )
                    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:
                        req_state.output_token_ids.extend(
                            new_token_ids[-num_new_tokens:]
                        )
1055
1056
1057
1058
1059
            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:
1060
1061
1062
1063
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
1064
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
1065

1066
            # Update the block IDs.
1067
            if not resumed_from_preemption:
1068
1069
                if new_block_ids is not None:
                    # Append the new blocks to the existing block IDs.
1070
                    for block_ids, new_ids in zip(req_state.block_ids, new_block_ids):
1071
                        block_ids.extend(new_ids)
1072
            else:
1073
                assert req_index is None
1074
                assert new_block_ids is not None
1075
1076
                # The request is resumed from preemption.
                # Replace the existing block IDs with the new ones.
1077
                req_state.block_ids = new_block_ids
1078
1079
1080
1081
1082

            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.
1083
1084
1085
1086
1087
1088
1089

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

1090
                reqs_to_add.append(req_state)
1091
1092
1093
                continue

            # Update the persistent batch.
1094
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
1095
            if new_block_ids is not None:
1096
                self.input_batch.block_table.append_row(new_block_ids, req_index)
1097
1098
1099
1100
1101
1102
1103

            # 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)
1104
                self.input_batch.token_ids_cpu[
1105
1106
1107
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
1108

1109
            # Add spec_token_ids to token_ids_cpu.
1110
            self.input_batch.update_req_spec_token_ids(req_state, scheduled_spec_tokens)
1111

1112
1113
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
1114
1115
        for request in reqs_to_add:
            self.input_batch.add_request(request)
1116
            self.input_batch.update_req_spec_token_ids(request, scheduled_spec_tokens)
1117

1118
1119
1120
1121
1122
1123
        # 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()
1124

1125
    def _update_states_after_model_execute(
1126
        self, output_token_ids: torch.Tensor, scheduler_output: "SchedulerOutput"
1127
    ) -> None:
1128
1129
1130
1131
1132
1133
1134
1135
        """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.
        """
1136
        if not self.speculative_config or not self.model_config.is_hybrid:
1137
1138
1139
            return

        # Find the number of accepted tokens for each sequence.
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
        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()
        )
1160
1161
        for i, num_tokens in enumerate(num_accepted_tokens):
            self.input_batch.num_accepted_tokens_cpu[i] = num_tokens
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
        if self.cache_config.mamba_cache_mode == "align":
            mamba_utils.postprocess_mamba(
                scheduler_output,
                self.kv_cache_config,
                self.input_batch,
                self.requests,
                self.mamba_state_idx,
                self.compilation_config.static_forward_context,
                self.model.get_mamba_state_copy_func(),
            )
1172

1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
    def _update_streaming_request(
        self, req_id: str, new_req_data: NewRequestData
    ) -> CachedRequestState:
        """Updates streaming session request from `scheduled_new_reqs`.

        Removes the request from InputBatch (if present), updates the cached
        state, and prepares it for re-addition to the batch.

        NOTE: prompt_token_ids includes intermediate output tokens - tokens
        previously generated but now are input context (part of the prompt).
        """
        self.input_batch.remove_request(req_id)
        req_state = self.requests[req_id]

        req_state.prompt_token_ids = new_req_data.prompt_token_ids
        req_state.mm_features = new_req_data.mm_features
        req_state.prompt_embeds = new_req_data.prompt_embeds
        req_state.sampling_params = new_req_data.sampling_params
        req_state.pooling_params = new_req_data.pooling_params
        req_state.block_ids = new_req_data.block_ids
        req_state.num_computed_tokens = new_req_data.num_computed_tokens
        req_state.num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
            req_state.prompt_token_ids, req_state.prompt_embeds
        )

        # Clear `output_token_ids` as previous output tokens are now part of
        # `prompt_token_ids`.
        req_state.output_token_ids.clear()

        if self.uses_mrope:
            self._init_mrope_positions(req_state)

        return req_state

1207
    def _init_mrope_positions(self, req_state: CachedRequestState):
1208
1209
        model = self.get_model()
        assert supports_mrope(model), "M-RoPE support is not implemented."
1210
1211
1212
1213
        assert req_state.prompt_token_ids is not None, (
            "M-RoPE requires prompt_token_ids to be available."
        )
        mrope_model = cast(SupportsMRoPE, model)
1214
1215

        req_state.mrope_positions, req_state.mrope_position_delta = (
1216
            mrope_model.get_mrope_input_positions(
1217
                req_state.prompt_token_ids,
1218
                req_state.mm_features,
1219
            )
1220
        )
1221

1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
    def _init_xdrope_positions(self, req_state: CachedRequestState):
        model = self.get_model()
        xdrope_model = cast(SupportsXDRoPE, model)
        assert req_state.prompt_token_ids is not None, (
            "XD-RoPE requires prompt_token_ids to be available."
        )
        assert supports_xdrope(model), "XD-RoPE support is not implemented."

        req_state.xdrope_positions = xdrope_model.get_xdrope_input_positions(
            req_state.prompt_token_ids,
            req_state.mm_features,
        )

1235
    def _extract_mm_kwargs(
1236
        self,
1237
1238
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
1239
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
1240
            return {}
1241

1242
        mm_kwargs = list[tuple[str, MultiModalKwargsItem]]()
1243
        for req in scheduler_output.scheduled_new_reqs:
1244
1245
            for feature in req.mm_features:
                if feature.data is not None:
1246
                    mm_kwargs.append((feature.modality, feature.data))
1247

1248
1249
1250
        # Input all modalities at once
        mm_kwargs_combined: BatchedTensorInputs = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
1251
1252
1253
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
1254
1255
        ):
            mm_kwargs_combined.update(mm_kwargs_group)
1256

1257
        return mm_kwargs_combined
1258

1259
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
1260
        if not self.is_multimodal_raw_input_only_model:
1261
            return {}
1262

1263
1264
1265
        mm_budget = self.mm_budget
        assert mm_budget is not None

1266
1267
1268
        if not mm_budget.mm_max_toks_per_item:
            return {}  # No tower modalities (embed-only mode)

1269
1270
        dummy_modality = mm_budget.get_modality_with_max_tokens()
        return self._get_mm_dummy_batch(dummy_modality, num_seqs)
1271

1272
1273
1274
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
1275
        cumsum_dtype: np.dtype | None = None,
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
    ) -> 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

1292
    def _prepare_input_ids(
1293
1294
1295
1296
        self,
        scheduler_output: "SchedulerOutput",
        total_num_scheduled_tokens: int,
        cu_num_tokens: np.ndarray,
1297
    ) -> None:
1298
        """Prepare the input IDs for the current batch.
1299

1300
1301
1302
1303
1304
1305
1306
        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)
1307
1308
1309
            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)
1310
1311
1312
1313
1314
1315
1316
            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
1317
1318
1319
1320
        sample_flattened_indices: list[int] = []
        spec_flattened_indices: list[int] = []
        prev_common_req_indices: list[int] = []
        prev_draft_token_indices: list[int] = []
1321
1322
        indices_match = True
        max_flattened_index = -1
1323
1324
1325
        total_num_spec_tokens = 0
        scheduled_spec_tokens = scheduler_output.scheduled_spec_decode_tokens

1326
1327
1328
1329
1330
        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.
1331
1332
                draft_len = len(scheduled_spec_tokens.get(req_id, ()))
                total_num_spec_tokens += draft_len
1333
                flattened_index = cu_num_tokens[cur_index].item() - 1
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
                # 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))
1349
                indices_match &= prev_index == flattened_index
1350
                max_flattened_index = max(max_flattened_index, flattened_index)
1351
1352
1353
        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:
1354
1355
1356
            # 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)
1357
1358
1359
            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)
1360
1361
        if num_commmon_tokens == 0:
            # No requests in common with the previous iteration
1362
            # So input_ids.cpu will have all the input ids.
1363
1364
1365
1366
1367
1368
1369
            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_(
1370
1371
1372
                self.input_batch.prev_sampled_token_ids[:num_commmon_tokens, 0],
                non_blocking=True,
            )
1373
1374
            if self.enable_prompt_embeds:
                self.is_token_ids.gpu[:num_commmon_tokens] = True
1375
            return
1376
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1377
1378
        sampled_tokens_index_tensor = torch.tensor(
            sample_flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
1379
        ).to(self.device, non_blocking=True)
1380
        prev_common_req_indices_tensor = torch.tensor(
1381
1382
            prev_common_req_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1383
1384
        self.input_ids.gpu.scatter_(
            dim=0,
1385
            index=sampled_tokens_index_tensor,
1386
            src=self.input_batch.prev_sampled_token_ids[
1387
1388
1389
                prev_common_req_indices_tensor, 0
            ],
        )
1390

1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
        # 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.input_ids.gpu.scatter_(
            dim=0,
            index=draft_tokens_index_tensor,
            src=draft_token_ids.flatten()[prev_draft_token_indices_tensor],
        )

1413
1414
    def _get_encoder_seq_lens(
        self,
1415
        num_scheduled_tokens: dict[str, int],
1416
1417
        kv_cache_spec: KVCacheSpec,
        num_reqs: int,
1418
        for_cudagraph_capture: bool = False,
1419
    ) -> tuple[torch.Tensor | None, np.ndarray | None]:
1420
        if not isinstance(kv_cache_spec, CrossAttentionSpec):
1421
            return None, None
1422

1423
1424
        # Zero out buffer for padding requests that are not actually scheduled (CGs)
        self.encoder_seq_lens.np[:num_reqs] = 0
1425

1426
1427
        # Build encoder_seq_lens array mapping request indices to
        # encoder lengths for inputs scheduled in this batch
1428
        for req_id in num_scheduled_tokens:
1429
            req_index = self.input_batch.req_id_to_index[req_id]
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
            req_state = self.requests[req_id]
            if req_state.mm_features is None:
                self.encoder_seq_lens.np[req_index] = 0
                continue

            # Get the total number of encoder input tokens for running encoder requests
            # whether encoding is finished or not so that cross-attention knows how
            # many encoder tokens to attend to.
            encoder_input_tokens = sum(
                feature.mm_position.length for feature in req_state.mm_features
            )
            self.encoder_seq_lens.np[req_index] = encoder_input_tokens
1442
1443
1444
1445
1446
1447
1448
1449
1450
        if for_cudagraph_capture:
            # During CUDA graph capture, we need to use realistic encoder lengths
            # so that max_seqlen_k is captured with the correct value.
            max_encoder_len = getattr(
                self.model_config.hf_config,
                "max_source_positions",
                self.max_encoder_len,
            )
            self.encoder_seq_lens.np[:num_reqs] = max_encoder_len
1451
1452
1453
1454

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

1456
        return encoder_seq_lens, encoder_seq_lens_cpu
1457

1458
    def _prepare_inputs(
1459
1460
1461
        self,
        scheduler_output: "SchedulerOutput",
        num_scheduled_tokens: np.ndarray,
1462
1463
    ) -> tuple[
        torch.Tensor,
1464
        SpecDecodeMetadata | None,
1465
    ]:
1466
1467
        """
        :return: tuple[
1468
            logits_indices, spec_decode_metadata,
1469
1470
        ]
        """
1471
1472
1473
1474
1475
1476
1477
        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.
1478
        self.input_batch.block_table.commit_block_table(num_reqs)
1479
1480
1481

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

1484
1485
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1486
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1487
1488

        # Get positions.
1489
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1490
1491
1492
1493
1494
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1495

1496
1497
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1498
        if self.uses_mrope:
1499
1500
            self._calc_mrope_positions(scheduler_output)

1501
1502
1503
1504
1505
        # Calculate XD-RoPE positions.
        # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
        if self.uses_xdrope_dim > 0:
            self._calc_xdrope_positions(scheduler_output)

1506
1507
1508
1509
        # 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.
1510
1511
1512
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1513
        token_indices_tensor = torch.from_numpy(token_indices)
1514

1515
1516
1517
        # 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.
1518
1519
1520
1521
1522
1523
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1524
        if self.enable_prompt_embeds:
1525
            is_token_ids = self.input_batch.is_token_ids_tensor.flatten()
1526
1527
1528
1529
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1530
1531
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564

        # 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:
1565
1566
1567
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1568
1569

                output_idx += num_sched
1570

1571
1572
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1573
1574

        # Prepare the attention metadata.
1575
        self.query_start_loc.np[0] = 0
1576
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1577
1578
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1579
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1580
        self.query_start_loc.copy_to_gpu()
1581
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1582

1583
        self.seq_lens.np[:num_reqs] = (
1584
1585
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1586
        # Fill unused with 0 for full cuda graph mode.
1587
1588
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
1589

1590
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1591
1592
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

1593
        # Record which requests should not be sampled,
1594
        # so that we could clear the sampled tokens before returning
1595
1596
        self.discard_request_mask.np[:num_reqs] = (
            self.seq_lens.np[:num_reqs] < num_tokens_np
1597
        )
1598
        self.discard_request_mask.copy_to_gpu(num_reqs)
1599

1600
        # Copy the tensors to the GPU.
1601
1602
1603
1604
1605
        self._prepare_input_ids(
            scheduler_output,
            total_num_scheduled_tokens,
            cu_num_tokens,
        )
1606

1607
        if self.uses_mrope:
1608
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1609
1610
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1611
1612
                non_blocking=True,
            )
1613
1614
1615
1616
1617
1618
        elif self.uses_xdrope_dim > 0:
            # Only relevant for models using XD-RoPE (e.g, HunYuan-VL)
            self.xdrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.xdrope_positions.cpu[:, :total_num_scheduled_tokens],
                non_blocking=True,
            )
1619
1620
        else:
            # Common case (1D positions)
1621
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1622

1623
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
1624
1625
1626
1627
1628
1629
1630
1631
        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
            spec_decode_metadata = None
1632
            num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
1633
1634
1635
1636
1637
        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)
1638
1639
1640
            # 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)
1641
1642
1643
1644
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
1645
1646
                req_idx = self.input_batch.req_id_to_index[req_id]
                num_draft_tokens[req_idx] = len(draft_token_ids)
1647
1648
1649
1650
1651
                if (
                    self.input_batch.num_computed_tokens_cpu[req_idx]
                    >= self.input_batch.num_prompt_tokens[req_idx]
                ):
                    num_decode_draft_tokens[req_idx] = len(draft_token_ids)
1652
            spec_decode_metadata = self._calc_spec_decode_metadata(
1653
1654
                num_draft_tokens, cu_num_tokens
            )
1655
            logits_indices = spec_decode_metadata.logits_indices
1656
            num_sampled_tokens = num_draft_tokens + 1
1657
            # For DECODE only cuda graph of some attention backends (e.g., GDN).
1658
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
1659
1660
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
1661

1662
1663
1664
1665
1666
        # Hot-Swap lora model
        if self.lora_config:
            assert (
                np.sum(num_sampled_tokens)
                <= self.vllm_config.scheduler_config.max_num_batched_tokens
1667
            )
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
            self.set_active_loras(
                self.input_batch, num_scheduled_tokens, num_sampled_tokens
            )

        return (
            logits_indices,
            spec_decode_metadata,
        )

    def _build_attention_metadata(
        self,
1679
        num_tokens: int,
1680
        num_reqs: int,
1681
1682
1683
        max_query_len: int,
        num_tokens_padded: int | None = None,
        num_reqs_padded: int | None = None,
1684
1685
1686
1687
        ubatch_slices: UBatchSlices | None = None,
        logits_indices: torch.Tensor | None = None,
        use_spec_decode: bool = False,
        for_cudagraph_capture: bool = False,
1688
        num_scheduled_tokens: dict[str, int] | None = None,
1689
        cascade_attn_prefix_lens: list[list[int]] | None = None,
1690
        slot_mappings: dict[int, torch.Tensor] | None = None,
1691
1692
1693
1694
    ) -> tuple[PerLayerAttnMetadata, CommonAttentionMetadata | None]:
        """
        :return: tuple[attn_metadata, spec_decode_common_attn_metadata]
        """
1695
1696
1697
1698
        # Attention metadata is not needed for attention free models
        if len(self.kv_cache_config.kv_cache_groups) == 0:
            return {}, None

1699
1700
        num_tokens_padded = num_tokens_padded or num_tokens
        num_reqs_padded = num_reqs_padded or num_reqs
1701
        assert num_reqs_padded is not None and num_tokens_padded is not None
1702

1703
1704
1705
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1706

1707
1708
1709
1710
1711
1712
1713
1714
        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()

1715
1716
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1717
1718
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1719
1720
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1721

1722
        kv_cache_groups = self.kv_cache_config.kv_cache_groups
1723

1724
        def _get_block_table(kv_cache_gid: int):
1725
1726
1727
            assert num_reqs_padded is not None and num_tokens_padded is not None
            kv_cache_spec = kv_cache_groups[kv_cache_gid].kv_cache_spec
            if isinstance(kv_cache_spec, EncoderOnlyAttentionSpec):
1728
                blk_table_tensor = torch.zeros(
1729
                    (num_reqs_padded, 1),
1730
                    dtype=torch.int32,
1731
1732
                    device=self.device,
                )
1733
            else:
1734
                blk_table = self.input_batch.block_table[kv_cache_gid]
1735
                blk_table_tensor = blk_table.get_device_tensor(num_reqs_padded)
1736

1737
1738
1739
            # Fill unused with -1. Needed for reshape_and_cache in full cuda
            # graph mode. `blk_table_tensor` -1 to match mamba PAD_SLOT_ID
            blk_table_tensor[num_reqs:num_reqs_padded].fill_(-1)
1740
            return blk_table_tensor
1741

1742
1743
1744
        assert slot_mappings is not None
        block_table_gid_0 = _get_block_table(0)
        slot_mapping_gid_0 = slot_mappings[0]
1745

1746
1747
        if self.model_config.enable_return_routed_experts:
            self.slot_mapping = slot_mapping_gid_0[:num_tokens].cpu().numpy()
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
        cm_base = CommonAttentionMetadata(
            query_start_loc=self.query_start_loc.gpu[: num_reqs_padded + 1],
            query_start_loc_cpu=self.query_start_loc.cpu[: num_reqs_padded + 1],
            seq_lens=self.seq_lens.gpu[:num_reqs_padded],
            _seq_lens_cpu=self.seq_lens.cpu[:num_reqs_padded],
            _num_computed_tokens_cpu=self.input_batch.num_computed_tokens_cpu_tensor[
                :num_reqs_padded
            ],
            num_reqs=num_reqs_padded,
            num_actual_tokens=num_tokens_padded,
            max_query_len=max_query_len,
            max_seq_len=max_seq_len,
            block_table_tensor=block_table_gid_0,
            slot_mapping=slot_mapping_gid_0,
            causal=True,
        )

        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.cp_kv_cache_interleave_size,
            )
            self.dcp_local_seq_lens.cpu[num_reqs:].fill_(0)
            self.dcp_local_seq_lens.copy_to_gpu(num_reqs_padded)

            cm_base.dcp_local_seq_lens = self.dcp_local_seq_lens.gpu[:num_reqs_padded]
            cm_base.dcp_local_seq_lens_cpu = self.dcp_local_seq_lens.cpu[
                :num_reqs_padded
            ]

        if logits_indices is not None and self.cache_config.kv_sharing_fast_prefill:
            cm_base.num_logits_indices = logits_indices.size(0)
            cm_base.logits_indices_padded = self._prepare_kv_sharing_fast_prefill(
                logits_indices
            )

1786
1787
1788
1789
1790
1791
1792
1793
1794
        # Cache attention metadata builds across hybrid KV-cache groups
        # The only thing that changes between different hybrid KV-cache groups when the
        # same metadata builder and KVCacheSpec is the same is the block table, so we
        # can cache the attention metadata builds and just update the block table using
        # `builder.update_block_table` if the builder supports it.
        cached_attn_metadata: dict[
            tuple[KVCacheSpec, type[AttentionMetadataBuilder]], AttentionMetadata
        ] = {}

1795
1796
1797
1798
1799
1800
1801
        def _build_attn_group_metadata(
            kv_cache_gid: int,
            attn_gid: int,
            common_attn_metadata: CommonAttentionMetadata,
            ubid: int | None = None,
        ) -> None:
            attn_group = self.attn_groups[kv_cache_gid][attn_gid]
1802
            builder = attn_group.get_metadata_builder(ubid or 0)
1803
1804
1805
1806
            kv_cache_spec = kv_cache_groups[kv_cache_gid].kv_cache_spec
            if isinstance(kv_cache_spec, UniformTypeKVCacheSpecs):
                kv_cache_spec = kv_cache_spec.kv_cache_specs[attn_group.layer_names[0]]
            cache_key = (kv_cache_spec, type(builder))
1807

1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
            cascade_attn_prefix_len = (
                cascade_attn_prefix_lens[kv_cache_gid][attn_gid]
                if cascade_attn_prefix_lens
                else 0
            )

            extra_attn_metadata_args = {}
            if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
                assert ubid is None, "UBatching not supported with GDN yet"
                extra_attn_metadata_args = dict(
                    num_accepted_tokens=self.num_accepted_tokens.gpu[:num_reqs_padded],
                    num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
                        :num_reqs_padded
                    ],
                )

            if for_cudagraph_capture:
                attn_metadata_i = builder.build_for_cudagraph_capture(
                    common_attn_metadata
                )
1828
1829
1830
1831
1832
1833
1834
1835
1836
            elif (
                cache_key in cached_attn_metadata
                and builder.supports_update_block_table
            ):
                attn_metadata_i = builder.update_block_table(
                    cached_attn_metadata[cache_key],
                    common_attn_metadata.block_table_tensor,
                    common_attn_metadata.slot_mapping,
                )
1837
1838
1839
1840
1841
1842
            else:
                attn_metadata_i = builder.build(
                    common_prefix_len=cascade_attn_prefix_len,
                    common_attn_metadata=common_attn_metadata,
                    **extra_attn_metadata_args,
                )
1843
1844
                if builder.supports_update_block_table:
                    cached_attn_metadata[cache_key] = attn_metadata_i
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867

            if ubid is None:
                assert isinstance(attn_metadata, dict)
                attn_metadata_dict = attn_metadata
            else:
                assert isinstance(attn_metadata, list)
                attn_metadata_dict = attn_metadata[ubid]

            for layer_name in attn_group.layer_names:
                attn_metadata_dict[layer_name] = attn_metadata_i

        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
        spec_decode_common_attn_metadata = None
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_groups):
            cm = copy(cm_base)  # shallow copy

            # Basically only the encoder seq_lens, block_table and slot_mapping change
            # for each kv_cache_group.
            cm.encoder_seq_lens, cm.encoder_seq_lens_cpu = self._get_encoder_seq_lens(
                num_scheduled_tokens or {},
                kv_cache_group.kv_cache_spec,
                num_reqs_padded,
1868
                for_cudagraph_capture=for_cudagraph_capture,
1869
            )
1870
            if kv_cache_gid > 0:
1871
1872
                cm.block_table_tensor = _get_block_table(kv_cache_gid)
                cm.slot_mapping = slot_mappings[kv_cache_gid]
1873

1874
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1875
                if isinstance(self.drafter, EagleProposer):
1876
                    if self.drafter.attn_layer_names[0] in kv_cache_group.layer_names:
1877
                        spec_decode_common_attn_metadata = cm
1878
                else:
1879
                    spec_decode_common_attn_metadata = cm
1880

1881
            for attn_gid in range(len(self.attn_groups[kv_cache_gid])):
1882
                if ubatch_slices is not None:
1883
1884
1885
                    for ubid, _cm in enumerate(split_attn_metadata(ubatch_slices, cm)):
                        _build_attn_group_metadata(kv_cache_gid, attn_gid, _cm, ubid)

1886
                else:
1887
                    _build_attn_group_metadata(kv_cache_gid, attn_gid, cm)
1888

1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
        if self.is_mm_prefix_lm:
            req_doc_ranges = {}
            for req_id in self.input_batch.req_ids:
                image_doc_ranges = []
                req_state = self.requests[req_id]
                for mm_feature in req_state.mm_features:
                    pos_info = mm_feature.mm_position
                    img_doc_range = pos_info.extract_embeds_range()
                    image_doc_ranges.extend(img_doc_range)
                req_idx = self.input_batch.req_id_to_index[req_id]
                req_doc_ranges[req_idx] = image_doc_ranges

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

1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
        if spec_decode_common_attn_metadata is not None and (
            num_reqs != num_reqs_padded or num_tokens != num_tokens_padded
        ):
            # Currently the drafter still only uses piecewise cudagraphs (and modifies
            # the attention metadata in directly), and therefore does not want to use
            # padded attention metadata.
            spec_decode_common_attn_metadata = (
                spec_decode_common_attn_metadata.unpadded(num_tokens, num_reqs)
            )

1919
        return attn_metadata, spec_decode_common_attn_metadata
1920

1921
1922
1923
    def _compute_cascade_attn_prefix_lens(
        self,
        num_scheduled_tokens: np.ndarray,
1924
        num_computed_tokens: np.ndarray,
1925
1926
1927
1928
1929
1930
1931
        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
        """
1932

1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
        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,
1947
                        num_computed_tokens,
1948
1949
1950
1951
1952
1953
1954
1955
                        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
1956

1957
1958
1959
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
1960
        num_computed_tokens: np.ndarray,
1961
        num_common_prefix_blocks: int,
1962
1963
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
    ) -> 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.
        """
1982

1983
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
        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]
2021
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
2022
2023
2024
2025
2026
        # 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.
2027
        common_prefix_len = min(common_prefix_len, num_computed_tokens.min())
2028
        # common_prefix_len should be a multiple of the block size.
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
        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
        )
2040
2041
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
2042
2043
2044
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
2045
            num_kv_heads=kv_cache_spec.num_kv_heads,
2046
            use_alibi=self.use_alibi,
2047
            use_sliding_window=use_sliding_window,
2048
            use_local_attention=use_local_attention,
2049
            num_sms=self.num_sms,
2050
            dcp_world_size=self.dcp_world_size,
2051
2052
2053
        )
        return common_prefix_len if use_cascade else 0

2054
2055
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
2056
        for index, req_id in enumerate(self.input_batch.req_ids):
2057
2058
2059
            req = self.requests[req_id]
            assert req.mrope_positions is not None

2060
2061
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2062
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
2063
2064
                req.prompt_token_ids, req.prompt_embeds
            )
2065
2066

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
2067
2068
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
            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

2082
2083
2084
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
2085
2086
2087
2088
2089
2090
2091
                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

2092
                assert req.mrope_position_delta is not None
2093
                MRotaryEmbedding.get_next_input_positions_tensor(
2094
                    out=self.mrope_positions.np,
2095
2096
2097
2098
2099
                    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,
                )
2100
2101
2102

                mrope_pos_ptr += completion_part_len

2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
    def _calc_xdrope_positions(self, scheduler_output: "SchedulerOutput"):
        xdrope_pos_ptr = 0
        for index, req_id in enumerate(self.input_batch.req_ids):
            req = self.requests[req_id]
            assert req.xdrope_positions is not None

            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
                req.prompt_token_ids, req.prompt_embeds
            )

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
            else:
                prompt_part_len = num_scheduled_tokens
                completion_part_len = 0

            assert num_scheduled_tokens == prompt_part_len + completion_part_len

            if prompt_part_len > 0:
                # prompt's xdrope_positions are pre-computed
                dst_start = xdrope_pos_ptr
                dst_end = xdrope_pos_ptr + prompt_part_len
                src_start = num_computed_tokens
                src_end = num_computed_tokens + prompt_part_len

                self.xdrope_positions.cpu[:, dst_start:dst_end] = req.xdrope_positions[
                    :, src_start:src_end
                ]
                xdrope_pos_ptr += prompt_part_len

            if completion_part_len > 0:
                # compute completion's xdrope_positions on-the-fly
                dst_start = xdrope_pos_ptr
                dst_end = xdrope_pos_ptr + completion_part_len

                XDRotaryEmbedding.get_next_input_positions_tensor(
                    out=self.xdrope_positions.np,
                    out_offset=dst_start,
                    context_len=num_computed_tokens + prompt_part_len,
                    num_new_tokens=completion_part_len,
                )

                xdrope_pos_ptr += completion_part_len

2150
2151
    def _calc_spec_decode_metadata(
        self,
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
        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
2168
2169
2170
2171

        # 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(
2172
2173
            num_sampled_tokens, cumsum_dtype=np.int32
        )
2174
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
2175
        logits_indices = np.repeat(
2176
2177
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
2178
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
2179
2180
2181
2182
2183
2184
        logits_indices += arange

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

        # Compute the draft logits indices.
2185
2186
2187
        # 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(
2188
2189
            num_draft_tokens, cumsum_dtype=np.int32
        )
2190
2191
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
2192
2193
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
2194
2195
2196
2197
2198
        # [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(
2199
2200
            self.device, non_blocking=True
        )
2201
2202
2203
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
2204
2205
2206
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
2207
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
2208
2209
            self.device, non_blocking=True
        )
2210
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
2211
2212
            self.device, non_blocking=True
        )
2213

2214
2215
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
2216
        draft_token_ids = self.input_ids.gpu[logits_indices]
2217
2218
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

2219
        return SpecDecodeMetadata(
2220
2221
2222
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
2223
            cu_num_sampled_tokens=cu_num_sampled_tokens,
2224
2225
2226
2227
2228
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

2229
2230
2231
2232
2233
2234
2235
    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
2236
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
2237
2238
2239
2240
2241
        # 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_(
2242
2243
            logits_indices[-1].item()
        )
2244
2245
2246
2247
2248
        # Dispatch for the decoder portion of the model.
        _, batch_desc = self.cudagraph_dispatcher.dispatch(
            num_logits, disable_full=True
        )
        num_logits_padded = batch_desc.num_tokens
2249
2250
2251
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
2252
2253
        return logits_indices_padded

2254
    def _batch_mm_inputs_from_scheduler(
2255
2256
        self,
        scheduler_output: "SchedulerOutput",
2257
2258
    ) -> tuple[
        list[str],
2259
        list[tuple[str, MultiModalKwargsItem]],
2260
2261
        list[tuple[str, PlaceholderRange]],
    ]:
2262
        """Batch multimodal inputs from scheduled encoder inputs.
2263
2264
2265

        Args:
            scheduler_output: The scheduler output containing scheduled encoder
2266
                inputs.
2267
2268

        Returns:
2269
            A tuple of (mm_hashes, mm_kwargs, mm_lora_refs) where:
2270
2271
            - mm_hashes: List of multimodal hashes for each item
            - mm_kwargs: List of multimodal kwargs for each item
2272
            - mm_lora_refs: List of (req_id, placeholder_range) for each item
2273
        """
2274
2275
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
2276
            return [], [], []
2277
2278

        mm_hashes = list[str]()
2279
        mm_kwargs = list[tuple[str, MultiModalKwargsItem]]()
2280
2281
2282
        # Multimodal LoRA reference info to map each multimodal item
        # back to its request & position
        mm_lora_refs = list[tuple[str, PlaceholderRange]]()
2283
2284
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
2285
2286

            for mm_input_id in encoder_input_ids:
2287
                mm_feature = req_state.mm_features[mm_input_id]
2288
2289
                if mm_feature.data is None:
                    continue
2290
2291

                mm_hashes.append(mm_feature.identifier)
2292
                mm_kwargs.append((mm_feature.modality, mm_feature.data))
2293
                mm_lora_refs.append((req_id, mm_feature.mm_position))
2294

2295
        return mm_hashes, mm_kwargs, mm_lora_refs
2296

2297
2298
2299
    def _execute_mm_encoder(
        self, scheduler_output: "SchedulerOutput"
    ) -> list[torch.Tensor]:
2300
2301
2302
        mm_hashes, mm_kwargs, mm_lora_refs = self._batch_mm_inputs_from_scheduler(
            scheduler_output
        )
2303
2304

        if not mm_kwargs:
2305
            return []
2306

2307
2308
2309
2310
2311
2312
        should_time = bool(
            self.observability_config
            and self.observability_config.enable_mm_processor_stats
            and scheduler_output.scheduled_encoder_inputs
        )

2313
2314
2315
2316
2317
2318
2319
        # 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.
2320
        model = cast(SupportsMultiModal, self.model)
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335

        if self.lora_config and self.lora_manager.supports_tower_connector_lora():
            # Build LoRA mappings independently for encoder inputs
            # (encoder batch structure is different from main batch)
            prompt_lora_mapping = []
            token_lora_mapping = []
            lora_requests = set()
            encoder_token_counts = []

            for req_id, pos_info in mm_lora_refs:
                req_idx = self.input_batch.req_id_to_index[req_id]
                lora_id = int(self.input_batch.request_lora_mapping[req_idx])

                # Prefer pos_info.get_num_embeds to count precise MM embedding tokens.
                num_tokens = self.model.get_num_mm_encoder_tokens(  # type: ignore[attr-defined]
2336
                    pos_info.get_num_embeds()
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
                )
                prompt_lora_mapping.append(lora_id)
                token_lora_mapping.extend([lora_id] * num_tokens)
                encoder_token_counts.append(num_tokens)

                if lora_id > 0:
                    lora_request = self.input_batch.lora_id_to_lora_request.get(lora_id)
                    if lora_request is not None:
                        lora_requests.add(lora_request)

            # Set tower adapter mapping
            tower_mapping = LoRAMapping(
                tuple(token_lora_mapping),
                tuple(prompt_lora_mapping),
                is_prefill=True,
                type=LoRAMappingType.TOWER,
            )
            self.lora_manager.set_active_adapters(lora_requests, tower_mapping)

            if hasattr(self.model, "get_num_mm_connector_tokens"):
                post_op_counts = [
                    self.model.get_num_mm_connector_tokens(num_tokens)  # type: ignore[attr-defined]
                    for num_tokens in encoder_token_counts
                ]

                connector_token_mapping = np.repeat(
                    np.array(prompt_lora_mapping, dtype=np.int32),
                    np.array(post_op_counts, dtype=np.int32),
                )
                connector_mapping = LoRAMapping(
                    index_mapping=tuple(connector_token_mapping.tolist()),
                    prompt_mapping=tuple(prompt_lora_mapping),
                    is_prefill=True,
                    type=LoRAMappingType.CONNECTOR,
                )

                self.lora_manager.set_active_adapters(
                    lora_requests,
                    connector_mapping,
                )

2378
        encoder_outputs: list[torch.Tensor] = []
2379
2380
        # Track the current index in mm_kwargs/mm_lora_refs to map groups to request IDs
        current_item_idx = 0
2381
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
2382
2383
2384
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
2385
        ):
2386
            curr_group_outputs: MultiModalEmbeddings
2387
2388

            # EVS-related change.
2389
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
2390
            # processing multimodal data. This solves the issue with scheduler
2391
2392
2393
2394
            # 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)
2395
2396
2397
2398
2399
2400
2401
            # 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
            ):
2402
                curr_group_outputs_lst = list[torch.Tensor]()
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
                for video_idx in range(num_items):
                    video_mm_kwargs_item = mm_kwargs[current_item_idx + video_idx]
                    with self.timed_encoder_operation(
                        should_time, mm_lora_refs, current_item_idx + video_idx, 1
                    ):
                        _, _, micro_batch_mm_inputs = next(
                            group_mm_kwargs_by_modality(
                                [video_mm_kwargs_item],
                                device=self.device,
                                pin_memory=self.pin_memory,
                            )
2414
                        )
2415

2416
2417
2418
                        micro_batch_outputs = model.embed_multimodal(
                            **micro_batch_mm_inputs
                        )
2419

2420
                        curr_group_outputs_lst.extend(micro_batch_outputs)
2421
2422

                curr_group_outputs = curr_group_outputs_lst
2423
2424
2425
2426
2427
2428
2429
2430
            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.
2431
2432
2433
2434
2435

                with self.timed_encoder_operation(
                    should_time, mm_lora_refs, current_item_idx, num_items
                ):
                    curr_group_outputs = model.embed_multimodal(**mm_kwargs_group)
2436

2437
2438
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
2439
                expected_num_items=num_items,
2440
            )
2441
            encoder_outputs.extend(curr_group_outputs)
2442

2443
2444
            current_item_idx += num_items

2445
        # Cache the encoder outputs by mm_hash
2446
        for mm_hash, output in zip(mm_hashes, encoder_outputs):
2447
            self.encoder_cache[mm_hash] = output
2448
2449
            logger.debug("Finish execute for mm hash %s", mm_hash)
            self.maybe_save_ec_to_connector(self.encoder_cache, mm_hash)
2450

2451
2452
        return encoder_outputs

2453
    def _gather_mm_embeddings(
2454
2455
        self,
        scheduler_output: "SchedulerOutput",
2456
        shift_computed_tokens: int = 0,
2457
2458
2459
    ) -> tuple[list[torch.Tensor], torch.Tensor]:
        total_num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens

2460
2461
2462
2463
2464
        # Swap to the other buffer to avoid race condition with previous
        # iteration's async copy that may still be reading from CPU.
        self.is_mm_embed_idx = 1 - self.is_mm_embed_idx
        is_mm_embed_buf = self.is_mm_embed_buffers[self.is_mm_embed_idx]

2465
        mm_embeds = list[torch.Tensor]()
2466
        is_mm_embed = is_mm_embed_buf.cpu
2467
2468
2469
        is_mm_embed[:total_num_scheduled_tokens] = False

        req_start_idx = 0
2470
        should_sync_mrope_positions = False
2471
        should_sync_xdrope_positions = False
2472

2473
        for req_id in self.input_batch.req_ids:
2474
2475
            mm_embeds_req: list[torch.Tensor] = []

2476
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
2477
            req_state = self.requests[req_id]
2478
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
2479

2480
2481
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
2482
2483
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499

                # 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,
2500
2501
                    num_encoder_tokens,
                )
2502
                assert start_idx < end_idx
2503
2504
2505
2506
2507
2508
2509
                curr_embeds_start, curr_embeds_end = (
                    pos_info.get_embeds_indices_in_range(start_idx, end_idx)
                )
                # If there are no embeddings in the current range, we skip
                # gathering the embeddings.
                if curr_embeds_start == curr_embeds_end:
                    continue
2510

2511
                mm_hash = mm_feature.identifier
2512
                encoder_output = self.encoder_cache.get(mm_hash, None)
2513
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
2514
2515
2516

                if (is_embed := pos_info.is_embed) is not None:
                    is_embed = is_embed[start_idx:end_idx]
2517
2518
2519
                    mm_embeds_item = encoder_output[curr_embeds_start:curr_embeds_end]
                else:
                    mm_embeds_item = encoder_output[start_idx:end_idx]
2520

2521
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
2522
2523
2524
2525
2526
2527
2528
2529
2530
                # OR mask for overlapping mm_features (use_audio_in_video)
                if is_embed is None:
                    is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                        True
                    )
                else:
                    is_mm_embed[
                        req_start_pos + start_idx : req_start_pos + end_idx
                    ] |= is_embed
2531
2532
2533
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
2534
                assert req_state.mrope_positions is not None
2535
2536
2537
2538
2539
2540
2541
                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,
2542
2543
                    )
                )
2544
2545
2546
2547
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
2548
2549
            req_start_idx += num_scheduled_tokens

2550
        is_mm_embed = is_mm_embed_buf.copy_to_gpu(total_num_scheduled_tokens)
2551
2552
2553

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
2554
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
2555

2556
2557
2558
2559
        if should_sync_xdrope_positions:
            self._calc_xdrope_positions(scheduler_output)
            self.xdrope_positions.copy_to_gpu(total_num_scheduled_tokens)

2560
        return mm_embeds, is_mm_embed
2561

2562
    def get_model(self) -> nn.Module:
2563
2564
        if not hasattr(self, "model"):
            raise ValueError("Cannot get model before model has been initialized")
2565
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
2566
            # get raw model out of the cudagraph wrapper.
2567
            return self.model.unwrap()
2568
2569
        return self.model

2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
    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")

2583
2584
2585
        if supports_realtime(model):
            supported_tasks.append("realtime")

2586
2587
        return supported_tasks

2588
2589
2590
2591
2592
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

2593
2594
        supported_tasks = list(model.pooler.get_supported_tasks())

2595
2596
2597
2598
        if "score" in supported_tasks:
            num_labels = getattr(self.model_config.hf_config, "num_labels", 0)
            if num_labels != 1:
                supported_tasks.remove("score")
2599
                logger.debug_once("Score API is only enabled for num_labels == 1.")
2600
2601

        return supported_tasks
2602

2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
    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)

2613
    def sync_and_slice_intermediate_tensors(
2614
2615
        self,
        num_tokens: int,
2616
        intermediate_tensors: IntermediateTensors | None,
2617
2618
        sync_self: bool,
    ) -> IntermediateTensors:
2619
2620
2621
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
2622
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
2623
2624
2625
2626
2627
2628

        # 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():
2629
                is_scattered = k == "residual" and is_rs
2630
                copy_len = num_tokens // tp if is_scattered else num_tokens
2631
                self.intermediate_tensors[k][:copy_len].copy_(
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
                    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:
2645
2646
2647
2648
2649
2650
2651
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2652
2653
        model = self.get_model()
        assert is_mixture_of_experts(model)
2654
2655
2656
        self.eplb_state.step(
            is_dummy,
            is_profile,
2657
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2658
2659
        )

2660
2661
2662
2663
2664
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
2665
2666
2667
2668
        kv_connector_output: KVConnectorOutput | None,
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput:
        num_reqs = self.input_batch.num_reqs
        assert num_reqs == len(self.input_batch.pooling_params), (
2669
2670
            "Either all or none of the requests in a batch must be pooling request"
        )
2671

2672
        hidden_states = hidden_states[:num_scheduled_tokens]
2673
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs]
2674

2675
        pooling_metadata = self.input_batch.get_pooling_metadata()
2676
        pooling_metadata.build_pooling_cursor(
2677
            num_scheduled_tokens_np, seq_lens_cpu, device=hidden_states.device
2678
        )
2679

2680
2681
        model = cast(VllmModelForPooling, self.model)
        raw_pooler_output: PoolerOutput = model.pooler(
2682
            hidden_states=hidden_states, pooling_metadata=pooling_metadata
2683
        )
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707

        finished_mask = [
            seq_len == prompt_len
            for seq_len, prompt_len in zip(seq_lens_cpu, pooling_metadata.prompt_lens)
        ]

        model_runner_output = ModelRunnerOutput(
            req_ids=self.input_batch.req_ids.copy(),
            req_id_to_index=self.input_batch.req_id_to_index.copy(),
            kv_connector_output=kv_connector_output,
        )

        if raw_pooler_output is None or not any(finished_mask):
            model_runner_output.pooler_output = [None] * num_reqs
            return model_runner_output

        if self.use_async_scheduling:
            return AsyncGPUPoolingModelRunnerOutput(
                model_runner_output=model_runner_output,
                raw_pooler_output=raw_pooler_output,
                finished_mask=finished_mask,
                async_output_copy_stream=self.async_output_copy_stream,
            )

2708
        raw_pooler_output = json_map_leaves(
2709
            lambda x: None if x is None else x.to("cpu", non_blocking=True),
2710
2711
            raw_pooler_output,
        )
2712
2713
2714
2715
        model_runner_output.pooler_output = [
            out if include else None
            for out, include in zip(raw_pooler_output, finished_mask)
        ]
2716
2717
        self._sync_device()

2718
        return model_runner_output
2719

2720
    def _pad_for_sequence_parallelism(self, num_scheduled_tokens: int) -> int:
2721
2722
2723
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
2724
        if self.compilation_config.pass_config.enable_sp and tp_size > 1:
2725
2726
2727
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

Patrick von Platen's avatar
Patrick von Platen committed
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
    def _prepare_mm_inputs(
        self, num_tokens: int
    ) -> tuple[torch.Tensor | None, torch.Tensor]:
        if self.model.requires_raw_input_tokens:
            input_ids = self.input_ids.gpu[:num_tokens]
        else:
            input_ids = None

        inputs_embeds = self.inputs_embeds.gpu[:num_tokens]
        return input_ids, inputs_embeds

2739
    def _preprocess(
2740
2741
        self,
        scheduler_output: "SchedulerOutput",
2742
        num_input_tokens: int,  # Padded
2743
        intermediate_tensors: IntermediateTensors | None = None,
2744
    ) -> tuple[
2745
2746
        torch.Tensor | None,
        torch.Tensor | None,
2747
        torch.Tensor,
2748
        IntermediateTensors | None,
2749
        dict[str, Any],
2750
        ECConnectorOutput | None,
2751
    ]:
2752
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2753
        is_first_rank = get_pp_group().is_first_rank
2754
        is_encoder_decoder = self.model_config.is_encoder_decoder
2755

2756
2757
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
2758
2759
        ec_connector_output = None

2760
        if self.supports_mm_inputs and is_first_rank and not is_encoder_decoder:
2761
            # Run the multimodal encoder if any.
2762
2763
2764
2765
2766
2767
            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)
2768

2769
2770
2771
            # 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.
2772
            inputs_embeds_scheduled = self.model.embed_input_ids(
2773
2774
2775
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2776
            )
2777

2778
            # TODO(woosuk): Avoid the copy. Optimize.
2779
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2780

Patrick von Platen's avatar
Patrick von Platen committed
2781
            input_ids, inputs_embeds = self._prepare_mm_inputs(num_input_tokens)
2782
            model_kwargs = {
2783
                **self._init_model_kwargs(),
2784
2785
                **self._extract_mm_kwargs(scheduler_output),
            }
2786
        elif self.enable_prompt_embeds and is_first_rank:
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
            # 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).
2799
2800
2801
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
2802
                .squeeze(1)
2803
            )
2804
2805
2806
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
2807
                tokens_to_embeds = self.model.embed_input_ids(input_ids=token_ids)
2808
2809
2810
                self.inputs_embeds.gpu[token_ids_idx] = tokens_to_embeds

            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
2811
            model_kwargs = self._init_model_kwargs()
2812
            input_ids = None
2813
        else:
2814
2815
2816
2817
            # 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.
2818
            input_ids = self.input_ids.gpu[:num_input_tokens]
2819
            inputs_embeds = None
2820
            model_kwargs = self._init_model_kwargs()
2821

2822
        if self.uses_mrope:
2823
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2824
2825
        elif self.uses_xdrope_dim > 0:
            positions = self.xdrope_positions.gpu[:, :num_input_tokens]
2826
        else:
2827
            positions = self.positions.gpu[:num_input_tokens]
2828

2829
        if is_first_rank:
2830
2831
            intermediate_tensors = None
        else:
2832
            assert intermediate_tensors is not None
2833
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2834
2835
                num_input_tokens, intermediate_tensors, True
            )
2836

2837
        if is_encoder_decoder and scheduler_output.scheduled_encoder_inputs:
2838
2839
2840
2841
2842
2843
2844
            # Run the encoder, just like we do with other multimodal inputs.
            # For an encoder-decoder model, our processing here is a bit
            # simpler, because the outputs are just passed to the decoder.
            # We are not doing any prompt replacement. We also will only
            # ever have a single encoder input.
            encoder_outputs = self._execute_mm_encoder(scheduler_output)
            model_kwargs.update({"encoder_outputs": encoder_outputs})
2845

2846
2847
2848
2849
2850
2851
        return (
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
2852
            ec_connector_output,
2853
        )
2854

2855
    def _sample(
2856
        self,
2857
2858
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2859
    ) -> SamplerOutput:
2860
        # Sample the next token and get logprobs if needed.
2861
        sampling_metadata = self.input_batch.sampling_metadata
2862
2863
2864
        # 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()
2865
        if spec_decode_metadata is None:
2866
            return self.sampler(
2867
2868
2869
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
2870

2871
2872
2873
2874
2875
2876
        # Update spec_token_ids with real draft tokens from pre step only when
        # output_token_ids is needed (penalties or bad_words are in use).
        if self.use_async_scheduling and self._draft_token_req_ids is not None:
            draft_token_ids_cpu, _ = self._get_draft_token_ids_cpu()
            self.input_batch.update_async_spec_token_ids(draft_token_ids_cpu)

2877
        sampler_output = self.rejection_sampler(
2878
2879
            spec_decode_metadata,
            None,  # draft_probs
2880
            logits,
2881
2882
            sampling_metadata,
        )
2883
2884
2885
        return sampler_output

    def _bookkeeping_sync(
2886
2887
2888
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
2889
        logits: torch.Tensor | None,
2890
2891
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
2892
        spec_decode_metadata: SpecDecodeMetadata | None,
2893
    ) -> tuple[
2894
        dict[str, int],
2895
        LogprobsLists | None,
2896
        list[list[int]],
2897
        dict[str, LogprobsTensors | None],
2898
2899
2900
        list[str],
        dict[str, int],
        list[int],
2901
    ]:
2902
2903
2904
2905
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

2906
2907
2908
2909
        num_reqs = self.input_batch.num_reqs
        discard_sampled_tokens_req_indices = np.nonzero(
            self.discard_request_mask.np[:num_reqs]
        )[0]
2910
2911
2912
2913
        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)
2914

2915
2916
2917
        # 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()
2918
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2919
2920

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2921
        sampled_token_ids = sampler_output.sampled_token_ids
2922
        logprobs_tensors = sampler_output.logprobs_tensors
2923
        invalid_req_indices = []
2924
        logprobs_lists = None
2925
2926
2927
2928
2929
2930
        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)
2931
2932
2933
                # Mask out the sampled tokens that should not be sampled.
                for i in discard_sampled_tokens_req_indices:
                    valid_sampled_token_ids[int(i)].clear()
2934
2935
2936

                if logprobs_tensors is not None:
                    logprobs_lists = logprobs_tensors.tolists()
2937
2938
            else:
                # Includes spec decode tokens.
2939
                valid_sampled_token_ids, logprobs_lists = RejectionSampler.parse_output(
2940
2941
                    sampled_token_ids,
                    self.input_batch.vocab_size,
2942
                    discard_sampled_tokens_req_indices,
2943
                    logprobs_tensors=logprobs_tensors,
2944
                )
2945
        else:
2946
            valid_sampled_token_ids = []
2947
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2948
2949
2950
2951
2952
            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.
2953
2954
2955
2956
            # 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
2957
2958
2959
2960
2961
            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
            }
2962

2963
2964
2965
2966
2967
        # 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.
2968
        req_ids = self.input_batch.req_ids
2969
2970
        for req_idx in range(num_sampled_tokens):
            if self.use_async_scheduling:
2971
                sampled_ids = [-1] if req_idx not in invalid_req_indices_set else None
2972
2973
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
2974

2975
            num_sampled_ids: int = len(sampled_ids) if sampled_ids else 0
2976

2977
            if not sampled_ids:
2978
2979
2980
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
2981
            end_idx = start_idx + num_sampled_ids
2982
2983
2984
2985
            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}"
2986
            )
2987

2988
2989
            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
2990
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
2991

2992
            req_id = req_ids[req_idx]
2993
2994
2995
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

2996
2997
2998
2999
3000
3001
        # Compute prompt logprobs if needed.
        prompt_logprobs_dict = self._get_prompt_logprobs_dict(
            hidden_states[:num_scheduled_tokens],
            scheduler_output.num_scheduled_tokens,
        )

3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
        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,
        )

3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
    @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()

3027
3028
    def _model_forward(
        self,
3029
3030
3031
3032
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
3033
3034
3035
3036
3037
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
3038
        Motivation: We can inspect only this method versus
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
        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,
        )

3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
    @staticmethod
    def _is_uniform_decode(
        max_num_scheduled_tokens: int,
        uniform_decode_query_len: int,
        num_tokens: int,
        num_reqs: int,
        force_uniform_decode: bool | None = None,
    ) -> bool:
        """
        Checks if it's a decode batch with same amount scheduled tokens
        across all requests.
        """
        return (
            (
                (max_num_scheduled_tokens == uniform_decode_query_len)
                and (num_tokens == max_num_scheduled_tokens * num_reqs)
            )
            if force_uniform_decode is None
            else force_uniform_decode
        )

3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
    def _determine_batch_execution_and_padding(
        self,
        num_tokens: int,
        num_reqs: int,
        num_scheduled_tokens_np: np.ndarray,
        max_num_scheduled_tokens: int,
        use_cascade_attn: bool,
        allow_microbatching: bool = True,
        force_eager: bool = False,
        # For cudagraph capture TODO(lucas): Refactor how we capture cudagraphs (will
        # be improved in model runner v2)
        force_uniform_decode: bool | None = None,
        force_has_lora: bool | None = None,
3093
        force_num_active_loras: int | None = None,
3094
        num_encoder_reqs: int = 0,
3095
    ) -> tuple[
3096
3097
        CUDAGraphMode,
        BatchDescriptor,
3098
        bool,
3099
3100
        torch.Tensor | None,
        CUDAGraphStat | None,
3101
    ]:
3102
3103
3104
3105
3106
3107
        uniform_decode = self._is_uniform_decode(
            max_num_scheduled_tokens=max_num_scheduled_tokens,
            uniform_decode_query_len=self.uniform_decode_query_len,
            num_tokens=num_tokens,
            num_reqs=num_reqs,
            force_uniform_decode=force_uniform_decode,
3108
        )
3109
3110
3111
3112
3113
        # Encoder-decoder models only support CG for decoder_step > 0 (no enc_output
        # is present). Also, chunked-prefill is disabled, so batch are uniform.
        has_encoder_output = (
            self.model_config.is_encoder_decoder and num_encoder_reqs > 0
        )
3114

3115
3116
3117
3118
3119
        # Compute LoRA state for cudagraph dispatch
        num_active_loras = (
            force_num_active_loras
            if force_num_active_loras is not None
            else len(self.input_batch.lora_id_to_lora_request)
3120
        )
3121
        has_lora = num_active_loras > 0 if force_has_lora is None else force_has_lora
3122

3123
        num_tokens_padded = self._pad_for_sequence_parallelism(num_tokens)
3124
        dispatch_cudagraph = (
3125
            lambda num_tokens, disable_full: self.cudagraph_dispatcher.dispatch(
3126
3127
3128
                num_tokens=num_tokens,
                has_lora=has_lora,
                uniform_decode=uniform_decode,
3129
                disable_full=disable_full,
3130
                num_active_loras=num_active_loras,
3131
3132
3133
3134
3135
            )
            if not force_eager
            else (CUDAGraphMode.NONE, BatchDescriptor(num_tokens_padded))
        )

3136
        cudagraph_mode, batch_descriptor = dispatch_cudagraph(
3137
            num_tokens_padded, use_cascade_attn or has_encoder_output
3138
        )
3139
        num_tokens_padded = batch_descriptor.num_tokens
3140
3141
3142
3143
3144
3145
3146
3147
3148
        if self.compilation_config.pass_config.enable_sp:
            assert (
                batch_descriptor.num_tokens
                % self.vllm_config.parallel_config.tensor_parallel_size
                == 0
            ), (
                "Sequence parallelism requires num_tokens to be "
                "a multiple of tensor parallel size"
            )
3149
3150
3151

        # Extra coordination when running data-parallel since we need to coordinate
        # across ranks
3152
        should_ubatch, num_tokens_across_dp = False, None
3153
3154
3155
3156
3157
3158
3159
3160
3161
        if self.vllm_config.parallel_config.data_parallel_size > 1:
            # Disable DP padding when running eager to avoid excessive padding when
            # running prefills. This lets us set cudagraph_mode="NONE" on the prefiller
            # in a P/D setup and still use CUDA graphs (enabled by this padding) on the
            # decoder.
            allow_dp_padding = (
                self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            )

3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
            should_ubatch, num_tokens_across_dp, synced_cudagraph_mode = (
                coordinate_batch_across_dp(
                    num_tokens_unpadded=num_tokens,
                    parallel_config=self.parallel_config,
                    allow_microbatching=allow_microbatching,
                    allow_dp_padding=allow_dp_padding,
                    num_tokens_padded=num_tokens_padded,
                    uniform_decode=uniform_decode,
                    num_scheduled_tokens_per_request=num_scheduled_tokens_np,
                    cudagraph_mode=cudagraph_mode.value,
                )
3173
3174
            )

3175
            # Extract DP-synced values
3176
3177
3178
            if num_tokens_across_dp is not None:
                dp_rank = self.parallel_config.data_parallel_rank
                num_tokens_padded = int(num_tokens_across_dp[dp_rank].item())
3179
3180
3181
3182
3183
                # Re-dispatch with DP padding so we have the correct batch_descriptor
                cudagraph_mode, batch_descriptor = dispatch_cudagraph(
                    num_tokens_padded,
                    disable_full=synced_cudagraph_mode <= CUDAGraphMode.PIECEWISE.value,
                )
3184
3185
3186
3187
                # Assert to make sure the agreed upon token count is correct otherwise
                # num_tokens_across_dp will no-longer be valid
                assert batch_descriptor.num_tokens == num_tokens_padded

3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
        cudagraph_stats = None
        if self.vllm_config.observability_config.cudagraph_metrics:
            cudagraph_stats = CUDAGraphStat(
                num_unpadded_tokens=num_tokens,
                num_padded_tokens=batch_descriptor.num_tokens,
                num_paddings=batch_descriptor.num_tokens - num_tokens,
                runtime_mode=str(cudagraph_mode),
            )

        return (
            cudagraph_mode,
            batch_descriptor,
3200
            should_ubatch,
3201
3202
3203
            num_tokens_across_dp,
            cudagraph_stats,
        )
3204

3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
    def _register_layerwise_nvtx_hooks(self) -> None:
        """
        Register layerwise NVTX hooks if --enable-layerwise-nvtx-tracing is enabled
        to trace detailed information of each layer or module in the model.
        """

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

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

3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
    def _get_slot_mappings(
        self,
        num_tokens_padded: int,
        num_reqs_padded: int,
        num_tokens_unpadded: int,
        ubatch_slices: "UBatchSlices | None" = None,
    ) -> tuple[
        dict[int, torch.Tensor] | None,
        dict[str, torch.Tensor] | list[dict[str, torch.Tensor]] | None,
    ]:
        """
        Build slot mappings in both formats needed by the system.

        Args:
            num_tokens_padded: Total number of tokens (padded)
            num_reqs_padded: Total number of requests (padded)
            num_tokens_unpadded: Actual number of tokens (unpadded)
            ubatch_slices: Optional ubatch slicing info for DBO

        Returns:
            A tuple of:
            - slot_mappings_by_gid: dict[int, torch.Tensor] for attention metadata
            - slot_mappings_by_layer: dict[str, torch.Tensor] or list for ForwardContext
        """
        if not (
            hasattr(self, "kv_cache_config")
            and self.kv_cache_config is not None
            and len(self.kv_cache_config.kv_cache_groups) > 0
        ):
            return None, None

        def _get_slot_mapping(kv_cache_gid: int):
            assert num_reqs_padded is not None and num_tokens_padded is not None
            kv_cache_spec = self.kv_cache_config.kv_cache_groups[
                kv_cache_gid
            ].kv_cache_spec
            if isinstance(kv_cache_spec, EncoderOnlyAttentionSpec):
                slot_mapping = torch.zeros(
                    (num_tokens_padded,),
                    dtype=torch.int64,
                    device=self.device,
                )
            else:
                blk_table = self.input_batch.block_table[kv_cache_gid]
                slot_mapping = blk_table.slot_mapping.gpu[:num_tokens_padded]

            # Fill unused with -1. Needed for reshape_and_cache in full cuda
            # graph mode. `blk_table_tensor` -1 to match mamba PAD_SLOT_ID
            slot_mapping[num_tokens_unpadded:num_tokens_padded].fill_(-1)

            return slot_mapping

        slot_mappings_by_gid = {
            gid: _get_slot_mapping(gid)
            for gid, _ in enumerate(self.kv_cache_config.kv_cache_groups)
        }

        slot_mappings_by_layer: dict[str, torch.Tensor] = {}
        for gid, kv_cache_group in enumerate(self.kv_cache_config.kv_cache_groups):
            slot_mapping = slot_mappings_by_gid[gid]
            for layer_name in kv_cache_group.layer_names:
                slot_mappings_by_layer[layer_name] = slot_mapping

        if ubatch_slices is not None:
            result: list[dict[str, torch.Tensor]] = []
            for ubatch in ubatch_slices:
                sliced_mappings: dict[str, torch.Tensor] = {}
                for layer_name, slot_mapping in slot_mappings_by_layer.items():
                    sliced_mappings[layer_name] = slot_mapping[ubatch.token_slice]
                result.append(sliced_mappings)
            return slot_mappings_by_gid, result

        return slot_mappings_by_gid, slot_mappings_by_layer

3315
3316
3317
3318
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
3319
        intermediate_tensors: IntermediateTensors | None = None,
3320
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors | None:
3321
3322
3323
3324
3325
        if self.execute_model_state is not None:
            raise RuntimeError(
                "State error: sample_tokens() must be called "
                "after execute_model() returns None."
            )
3326

3327
3328
3329
3330
3331
3332
3333
        if self.vllm_config.model_config.enable_return_routed_experts:
            capturer = RoutedExpertsCapturer.get_instance()
            if capturer is not None:
                capturer.clear_buffer()  # noqa
            else:
                logger.error("RoutedExpertsCapturer not initialized.")

3334
3335
3336
3337
3338
        if scheduler_output.preempted_req_ids and has_kv_transfer_group():
            get_kv_transfer_group().handle_preemptions(
                scheduler_output.preempted_req_ids
            )

3339
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3340
3341
3342
3343
3344
3345
        with (
            record_function_or_nullcontext("gpu_model_runner: preprocess"),
            self.synchronize_input_prep(),
        ):
            # Update persistent batch states.
            self._update_states(scheduler_output)
3346

3347
3348
            if has_ec_transfer() and get_ec_transfer().is_producer:
                with self.maybe_get_ec_connector_output(
3349
                    scheduler_output,
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
                    encoder_cache=self.encoder_cache,
                ) as ec_connector_output:
                    self._execute_mm_encoder(scheduler_output)
                    return make_empty_encoder_model_runner_output(scheduler_output)

            if not num_scheduled_tokens:
                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)
                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(scheduler_output, self.vllm_config)

            if self.cache_config.kv_sharing_fast_prefill:
                assert not self.num_prompt_logprobs, (
                    "--kv-sharing-fast-prefill produces incorrect "
                    "logprobs for prompt tokens, tokens, please disable "
                    "it when the requests need prompt logprobs"
3378
3379
                )

3380
3381
3382
3383
3384
3385
            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())
            num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
3386

3387
3388
3389
3390
            logits_indices, spec_decode_metadata = self._prepare_inputs(
                scheduler_output,
                num_scheduled_tokens_np,
            )
3391

3392
3393
3394
3395
3396
            cascade_attn_prefix_lens = None
            # Disable cascade attention when using microbatching (DBO)
            if self.cascade_attn_enabled and not self.parallel_config.use_ubatching:
                # Pre-compute cascade attention prefix lengths
                cascade_attn_prefix_lens = self._compute_cascade_attn_prefix_lens(
3397
                    num_scheduled_tokens_np,
3398
3399
                    self.input_batch.num_computed_tokens_cpu[:num_reqs],
                    scheduler_output.num_common_prefix_blocks,
3400
3401
                )

3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
            (
                cudagraph_mode,
                batch_desc,
                should_ubatch,
                num_tokens_across_dp,
                cudagraph_stats,
            ) = self._determine_batch_execution_and_padding(
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs,
                num_scheduled_tokens_np=num_scheduled_tokens_np,
                max_num_scheduled_tokens=max_num_scheduled_tokens,
                use_cascade_attn=cascade_attn_prefix_lens is not None,
                num_encoder_reqs=len(scheduler_output.scheduled_encoder_inputs),
            )
3416

3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
            logger.debug(
                "Running batch with cudagraph_mode: %s, batch_descriptor: %s, "
                "should_ubatch: %s, num_tokens_across_dp: %s",
                cudagraph_mode,
                batch_desc,
                should_ubatch,
                num_tokens_across_dp,
            )

            num_tokens_padded = batch_desc.num_tokens
            num_reqs_padded = (
                batch_desc.num_reqs if batch_desc.num_reqs is not None else num_reqs
            )
            ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
                should_ubatch,
                num_scheduled_tokens_np,
                num_tokens_padded,
                num_reqs_padded,
                self.parallel_config.num_ubatches,
            )

            logger.debug(
                "ubatch_slices: %s, ubatch_slices_padded: %s",
                ubatch_slices,
                ubatch_slices_padded,
            )

3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
            # True if any attention backend handles KV cache update separately
            # from forward() (i.e., forward_includes_kv_cache_update=False). When true,
            # slot_mappings must use padded dimensions to match the key/value tensors.
            has_separate_kv_update = not all(
                all(
                    g.backend.forward_includes_kv_cache_update
                    for g in self.attn_groups[id]
                )
                for id, spec in enumerate(self.kv_cache_config.kv_cache_groups)
                if not isinstance(spec.kv_cache_spec, EncoderOnlyAttentionSpec)
            )
3455
3456
            pad_attn = cudagraph_mode == CUDAGraphMode.FULL

3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
            if self.cache_config.mamba_cache_mode == "align":
                mamba_utils.preprocess_mamba(
                    scheduler_output,
                    self.kv_cache_config,
                    self.cache_config,
                    self.mamba_state_idx,
                    self.input_batch,
                    self.requests,
                    self.compilation_config.static_forward_context,
                    self.model.get_mamba_state_copy_func(),
                )

3469
3470
3471
            use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
            ubatch_slices_attn = ubatch_slices_padded if pad_attn else ubatch_slices

3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
            slot_mappings_by_group, slot_mappings = self._get_slot_mappings(
                num_tokens_padded=num_tokens_padded
                if pad_attn or has_separate_kv_update
                else num_tokens_unpadded,
                num_reqs_padded=(
                    num_reqs_padded if pad_attn or has_separate_kv_update else num_reqs
                ),
                num_tokens_unpadded=num_tokens_unpadded,
                ubatch_slices=ubatch_slices_padded,
            )

3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
            attn_metadata, spec_decode_common_attn_metadata = (
                self._build_attention_metadata(
                    num_tokens=num_tokens_unpadded,
                    num_tokens_padded=num_tokens_padded if pad_attn else None,
                    num_reqs=num_reqs,
                    num_reqs_padded=num_reqs_padded if pad_attn else None,
                    max_query_len=max_num_scheduled_tokens,
                    ubatch_slices=ubatch_slices_attn,
                    logits_indices=logits_indices,
                    use_spec_decode=use_spec_decode,
                    num_scheduled_tokens=scheduler_output.num_scheduled_tokens,
                    cascade_attn_prefix_lens=cascade_attn_prefix_lens,
3495
                    slot_mappings=slot_mappings_by_group,
3496
                )
3497
            )
3498

3499
3500
3501
3502
3503
3504
3505
3506
3507
            (
                input_ids,
                inputs_embeds,
                positions,
                intermediate_tensors,
                model_kwargs,
                ec_connector_output,
            ) = self._preprocess(
                scheduler_output, num_tokens_padded, intermediate_tensors
3508
            )
3509

3510
        # Set cudagraph mode to none if calc_kv_scales is true.
3511
3512
3513
        # KV scales calculation involves dynamic operations that are incompatible
        # with CUDA graph capture.
        if self.calculate_kv_scales:
3514
            cudagraph_mode = CUDAGraphMode.NONE
3515
3516
            # Mark KV scales as calculated after the first forward pass
            self.calculate_kv_scales = False
3517

3518
3519
3520
3521
3522
3523
3524
        # Encoder-decoder models can only compile the pure decode steps where no
        # encoder inputs are present. Use eager for the first pass.
        num_encoder_reqs = len(scheduler_output.scheduled_encoder_inputs)
        has_encoder_input = (
            self.model_config.is_encoder_decoder and num_encoder_reqs > 0
        )

3525
3526
        # Run the model.
        # Use persistent buffers for CUDA graphs.
3527
3528
        with (
            set_forward_context(
3529
3530
                attn_metadata,
                self.vllm_config,
3531
                num_tokens=num_tokens_padded,
3532
                num_tokens_across_dp=num_tokens_across_dp,
3533
3534
                cudagraph_runtime_mode=cudagraph_mode,
                batch_descriptor=batch_desc,
3535
                ubatch_slices=ubatch_slices_padded,
3536
                slot_mapping=slot_mappings,
3537
                skip_compiled=has_encoder_input,
3538
            ),
3539
            record_function_or_nullcontext("gpu_model_runner: forward"),
3540
3541
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
3542
            model_output = self._model_forward(
3543
3544
3545
3546
3547
3548
3549
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

3550
        with record_function_or_nullcontext("gpu_model_runner: postprocess"):
3551
            if self.use_aux_hidden_state_outputs:
3552
                # True when EAGLE 3 is used.
3553
3554
                hidden_states, aux_hidden_states = model_output
            else:
3555
                # Common case.
3556
3557
3558
                hidden_states = model_output
                aux_hidden_states = None

3559
3560
3561
3562
3563
            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)
3564
                    hidden_states.kv_connector_output = kv_connector_output
3565
                    self.kv_connector_output = kv_connector_output
3566
                    return hidden_states
3567

3568
                if self.is_pooling_model:
3569
                    # Return the pooling output.
3570
3571
3572
3573
3574
                    return self._pool(
                        hidden_states,
                        num_scheduled_tokens,
                        num_scheduled_tokens_np,
                        kv_connector_output,
3575
                    )
3576
3577

                sample_hidden_states = hidden_states[logits_indices]
3578
                logits = self.model.compute_logits(sample_hidden_states)
3579
3580
3581
3582
            else:
                # Rare case.
                assert not self.is_pooling_model

3583
                sample_hidden_states = hidden_states[logits_indices]
3584
                if not get_pp_group().is_last_rank:
3585
                    all_gather_tensors = {
3586
                        "residual": not is_residual_scattered_for_sp(
3587
                            self.vllm_config, num_tokens_padded
3588
                        )
3589
                    }
3590
                    get_pp_group().send_tensor_dict(
3591
3592
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
3593
3594
                        all_gather_tensors=all_gather_tensors,
                    )
3595
3596
                    logits = None
                else:
3597
                    logits = self.model.compute_logits(sample_hidden_states)
3598

3599
                model_output_broadcast_data: dict[str, Any] = {}
3600
3601
3602
                if logits is not None:
                    model_output_broadcast_data["logits"] = logits.contiguous()

3603
                broadcasted = get_pp_group().broadcast_tensor_dict(
3604
3605
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
3606
3607
                assert broadcasted is not None
                logits = broadcasted["logits"]
3608

3609
3610
3611
3612
3613
3614
3615
3616
        self.execute_model_state = ExecuteModelState(
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3617
            ec_connector_output,
3618
            cudagraph_stats,
3619
            slot_mappings,
3620
        )
3621
        self.kv_connector_output = kv_connector_output
3622
3623
3624
3625
3626
3627
        return None

    @torch.inference_mode
    def sample_tokens(
        self, grammar_output: "GrammarOutput | None"
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
3628
3629
3630
        kv_connector_output = self.kv_connector_output
        self.kv_connector_output = None

3631
        if self.execute_model_state is None:
3632
3633
3634
            # receive sampled token ids from the last PP rank.
            if self.use_async_scheduling and get_pp_group().world_size > 1:
                self._pp_receive_prev_sampled_token_ids_to_input_batch()
3635
            if not kv_connector_output:
3636
                return None  # type: ignore[return-value]
3637
3638
3639
3640
3641
3642
3643
3644
3645

            # 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
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655

        # Unpack ephemeral state.
        (
            scheduler_output,
            logits,
            spec_decode_metadata,
            spec_decode_common_attn_metadata,
            hidden_states,
            sample_hidden_states,
            aux_hidden_states,
3656
            ec_connector_output,
3657
            cudagraph_stats,
3658
            slot_mappings,
3659
3660
3661
3662
3663
3664
3665
3666
3667
        ) = 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
            )
3668

3669
        with record_function_or_nullcontext("gpu_model_runner: sample"):
3670
3671
            sampler_output = self._sample(logits, spec_decode_metadata)

3672
3673
3674
        self._update_states_after_model_execute(
            sampler_output.sampled_token_ids, scheduler_output
        )
3675
3676
        if self.use_async_scheduling:
            pp = get_pp_group()
3677
3678
3679
3680
            # For torchrun external_launcher PP mode with broadcast_pp_output=True,
            # PP outputs have been broadcasted to all ranks at logits computation.
            # Therefore, here is no need to send sampled token ids again in this case.
            if not self.broadcast_pp_output and pp.world_size > 1 and pp.is_last_rank:
3681
3682
3683
                self._pp_broadcast_prev_sampled_token_ids(
                    sampler_output.sampled_token_ids
                )
3684

3685
3686
        self._draft_token_ids = None
        self._draft_token_req_ids = None
3687
3688
        self.input_batch.prev_sampled_token_ids = None

3689
        def propose_draft_token_ids(sampled_token_ids):
3690
            assert spec_decode_common_attn_metadata is not None
3691
            with record_function_or_nullcontext("gpu_model_runner: draft"):
3692
3693
3694
3695
3696
3697
3698
3699
3700
                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,
3701
                    slot_mappings,
3702
                )
3703
                self._copy_draft_token_ids_to_cpu(scheduler_output)
3704

3705
        spec_config = self.speculative_config
3706
3707
3708
3709
3710
        propose_drafts_after_bookkeeping = False
        if spec_config is not None:
            input_fits_in_drafter = spec_decode_common_attn_metadata is not None and (
                spec_decode_common_attn_metadata.max_seq_len + self.num_spec_tokens
                <= self.effective_drafter_max_model_len
3711
            )
3712
3713
3714
3715
3716
            use_gpu_toks = (
                spec_config.use_eagle() or spec_config.uses_draft_model()
            ) and not spec_config.disable_padded_drafter_batch
            if use_gpu_toks:
                # EAGLE/DraftModel speculative decoding can use the GPU sampled tokens
3717
                # as inputs, and does not need to wait for bookkeeping to finish.
3718
                assert isinstance(self.drafter, EagleProposer | DraftModelProposer)
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
                sampled_token_ids = sampler_output.sampled_token_ids
                if input_fits_in_drafter:
                    propose_draft_token_ids(sampled_token_ids)
                elif self.valid_sampled_token_count_event is not None:
                    assert spec_decode_common_attn_metadata 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_mask.gpu,
                        )
3732
                    )
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
                    self._copy_valid_sampled_token_count(
                        next_token_ids, valid_sampled_tokens_count
                    )
                    # Since we couldn't run the drafter,
                    # just use zeros for the draft tokens.
                    self._draft_token_ids = torch.zeros(
                        1, device=self.device, dtype=torch.int32
                    ).expand(len(self.input_batch.req_ids), self.num_spec_tokens)
                    self._copy_draft_token_ids_to_cpu(scheduler_output, zeros_only=True)
            else:
                propose_drafts_after_bookkeeping = input_fits_in_drafter
3744

3745
        with record_function_or_nullcontext("gpu_model_runner: bookkeep"):
3746
3747
3748
3749
3750
3751
3752
3753
            (
                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,
3754
3755
3756
3757
3758
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
3759
                scheduler_output.total_num_scheduled_tokens,
3760
                spec_decode_metadata,
3761
            )
3762

3763
        if propose_drafts_after_bookkeeping:
3764
3765
3766
            # 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)
3767

3768
        with record_function_or_nullcontext("gpu_model_runner: eplb"):
3769
            self.eplb_step()
3770

3771
        with record_function_or_nullcontext("gpu_model_runner: ModelRunnerOutput"):
3772
3773
3774
3775
3776
3777
3778
            if self.model_config.enable_return_routed_experts:
                capturer = RoutedExpertsCapturer.get_instance()
                if capturer is not None:
                    capturer.save_captured_experts(indices=self.slot_mapping)  # noqa
                else:
                    logger.error("RoutedExpertsCapturer not initialized.")

3779
3780
3781
3782
3783
3784
3785
            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,
                kv_connector_output=kv_connector_output,
3786
3787
3788
                ec_connector_output=ec_connector_output
                if self.supports_mm_inputs
                else None,
3789
                num_nans_in_logits=num_nans_in_logits,
3790
                cudagraph_stats=cudagraph_stats,
3791
            )
3792

3793
3794
        if not self.use_async_scheduling:
            return output
3795

3796
3797
3798
3799
3800
3801
3802
3803
3804
        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,
3805
                vocab_size=self.input_batch.vocab_size,
3806
3807
3808
3809
3810
            )
        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
3811
            # any requests with sampling params that require output ids.
3812
3813
3814
3815
            self.input_batch.set_async_sampled_token_ids(
                async_output.sampled_token_ids_cpu,
                async_output.async_copy_ready_event,
            )
3816
3817
3818

        return async_output

3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
    def _pp_broadcast_prev_sampled_token_ids(
        self, sampled_token_ids: torch.Tensor
    ) -> None:
        """Broadcast sampled token ids (GPU) from last PP stage"""
        pp = get_pp_group()
        assert pp.is_last_rank
        # `prev_sampled_token_ids` is expected to have shape [num_reqs, 1].
        assert sampled_token_ids.dim() == 2 and sampled_token_ids.shape[-1] == 1, (
            "PP+async expects sampled_token_ids to have shape [num_reqs, 1]"
        )
        torch.distributed.broadcast(
            sampled_token_ids, src=pp.rank, group=pp.device_group
        )

    def _pp_receive_prev_sampled_token_ids_to_input_batch(self) -> None:
        """Receive sampled token ids broadcast from last PP stage"""
        pp = get_pp_group()
        assert not pp.is_last_rank
        num_reqs = self.input_batch.num_reqs
        # `prev_sampled_token_ids` is expected to have shape [num_reqs, 1].
        recv = torch.empty((num_reqs, 1), dtype=torch.int32, device=self.device)
        torch.distributed.broadcast(recv, src=pp.last_rank, group=pp.device_group)
        self.input_batch.prev_sampled_token_ids = recv

        # construct `prev_req_id_to_index` here so `_prepare_input_ids`
        # can map req_id -> previous batch row
        discard_req_indices = np.nonzero(self.discard_request_mask.np[:num_reqs])[0]
        discard_req_indices_set = set(discard_req_indices)
        prev_req_id_to_index: dict[str, int] = {}
        for i, req_id in enumerate(self.input_batch.req_ids):
            if i in discard_req_indices_set:
                continue
            prev_req_id_to_index[req_id] = i
            # PP+async scheduling: advance per-request local cached output length by
            # appending a placeholder (-1) token id.
            if (req_state := self.requests.get(req_id)) is not None:
                req_state.output_token_ids.append(-1)
        self.input_batch.prev_req_id_to_index = prev_req_id_to_index

3858
    def take_draft_token_ids(self) -> DraftTokenIds | None:
3859
        if not self.num_spec_tokens or not self._draft_token_req_ids:
3860
            return None
3861
        draft_token_ids, req_ids = self._get_draft_token_ids_cpu()
3862
        return DraftTokenIds(req_ids, draft_token_ids)
3863

3864
3865
3866
    def _copy_draft_token_ids_to_cpu(
        self, scheduler_output: "SchedulerOutput", zeros_only: bool = False
    ) -> None:
3867
3868
3869
3870
3871
3872
        # Check if we need to copy draft tokens to CPU. In async scheduling,
        # we only copy when needed for structured output, penalties or bad_words.
        if self.use_async_scheduling and not (
            scheduler_output.has_structured_output_requests
            or self.input_batch.sampling_metadata.output_token_ids
        ):
3873
3874
3875
            return
        # We must also set the corresponding request ids.
        self._draft_token_req_ids = self.input_batch.req_ids.copy()
3876

3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
        draft_token_ids: torch.Tensor = self._draft_token_ids
        if not torch.is_tensor(draft_token_ids):
            return
        assert self.draft_token_ids_event is not None
        assert self.draft_token_ids_copy_stream is not None
        assert self.draft_token_ids_cpu is not None
        default_stream = torch.cuda.current_stream()
        num_reqs = draft_token_ids.shape[0]
        with torch.cuda.stream(self.draft_token_ids_copy_stream):
            if not zeros_only:
                # Trigger async copy of draft token ids to cpu.
                self.draft_token_ids_copy_stream.wait_stream(default_stream)
                self.draft_token_ids_cpu[:num_reqs].copy_(
                    draft_token_ids, non_blocking=True
                )
            else:
                # No copy needed, just zero-out cpu tensor.
                self.draft_token_ids_cpu[:num_reqs] = 0
            self.draft_token_ids_event.record()

3897
    def _get_draft_token_ids_cpu(self) -> tuple[list[list[int]], list[str]]:
3898
        if isinstance(self._draft_token_ids, list):
3899
3900
3901
3902
            return self._draft_token_ids, self.input_batch.req_ids
        req_ids = self._draft_token_req_ids
        if req_ids is None:
            return [], []
3903
3904
3905
        assert self.draft_token_ids_event is not None
        assert self.draft_token_ids_cpu is not None
        self.draft_token_ids_event.synchronize()
3906
        return self.draft_token_ids_cpu[: len(req_ids)].tolist(), req_ids
3907

3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
    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
3921
            assert counts_cpu is not None
3922
3923
3924
3925
3926
3927
3928
3929
            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
3930
3931
        sampled_count_event = self.valid_sampled_token_count_event
        if sampled_count_event is None or prev_sampled_token_ids is None:
3932
3933
3934
            return []

        counts_cpu = self.valid_sampled_token_count_cpu
3935
3936
        assert counts_cpu is not None
        sampled_count_event.synchronize()
3937
3938
        return counts_cpu[: prev_sampled_token_ids.shape[0]].tolist()

3939
3940
3941
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
3942
        sampled_token_ids: torch.Tensor | list[list[int]],
3943
3944
3945
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
3946
3947
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
3948
        common_attn_metadata: CommonAttentionMetadata,
3949
        slot_mappings: dict[str, torch.Tensor] | list[dict[str, torch.Tensor]] | None,
3950
    ) -> list[list[int]] | torch.Tensor:
3951
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
3952
3953
3954
        spec_config = self.speculative_config
        assert spec_config is not None
        if spec_config.method == "ngram":
3955
3956
            from vllm.v1.spec_decode.ngram_proposer import NgramProposer

3957
            assert isinstance(sampled_token_ids, list)
3958
            assert isinstance(self.drafter, NgramProposer)
3959
            draft_token_ids = self.drafter.propose(
3960
                sampled_token_ids,
3961
3962
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
3963
                slot_mappings=slot_mappings,
3964
            )
3965
        elif spec_config.method == "suffix":
3966
3967
            assert isinstance(sampled_token_ids, list)
            assert isinstance(self.drafter, SuffixDecodingProposer)
3968
3969
3970
            draft_token_ids = self.drafter.propose(
                self.input_batch, sampled_token_ids, slot_mappings=slot_mappings
            )
3971
        elif spec_config.method == "medusa":
3972
            assert isinstance(sampled_token_ids, list)
3973
            assert isinstance(self.drafter, MedusaProposer)
3974

3975
3976
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
3977
3978
3979
3980
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
3981
3982
3983
                assert spec_decode_metadata is not None, (
                    "No spec decode metadata for medusa"
                )
3984
                for num_draft, tokens in zip(
3985
3986
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
3987
                    indices.append(offset + len(tokens) - 1)
3988
                    offset += num_draft + 1
3989
                indices = torch.tensor(indices, device=self.device)
3990
3991
                hidden_states = sample_hidden_states[indices]

3992
            draft_token_ids = self.drafter.propose(
3993
3994
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
3995
                slot_mappings=slot_mappings,
3996
            )
3997
3998
        elif spec_config.use_eagle() or spec_config.uses_draft_model():
            assert isinstance(self.drafter, EagleProposer | DraftModelProposer)
3999

4000
            if spec_config.disable_padded_drafter_batch:
4001
4002
4003
                # 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.
4004
4005
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
4006
                    "padded-batch is disabled."
4007
                )
4008
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
4009
4010
4011
4012
4013
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
4014
4015
4016
4017
4018
            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.
4019
4020
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
4021
                    "padded-batch is enabled."
4022
4023
                )
                next_token_ids, valid_sampled_tokens_count = (
4024
4025
4026
4027
4028
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
4029
                        self.discard_request_mask.gpu,
4030
                    )
4031
                )
4032
4033
4034
                self._copy_valid_sampled_token_count(
                    next_token_ids, valid_sampled_tokens_count
                )
Jiayi Yao's avatar
Jiayi Yao committed
4035

4036
            num_rejected_tokens_gpu = None
4037
            if spec_decode_metadata is None:
4038
                token_indices_to_sample = None
4039
                # input_ids can be None for multimodal models.
4040
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
4041
                target_positions = self._get_positions(num_scheduled_tokens)
4042
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
4043
                    assert aux_hidden_states is not None
4044
                    target_hidden_states = torch.cat(
4045
4046
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
4047
4048
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
4049
            else:
4050
                if spec_config.disable_padded_drafter_batch:
4051
                    token_indices_to_sample = None
4052
4053
4054
4055
4056
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
4057
4058
4059
4060
4061
4062
4063
4064
4065
                    target_token_ids = self.input_ids.gpu[token_indices]
                    target_positions = self._get_positions(token_indices)
                    if self.use_aux_hidden_state_outputs:
                        assert aux_hidden_states is not None
                        target_hidden_states = torch.cat(
                            [h[token_indices] for h in aux_hidden_states], dim=-1
                        )
                    else:
                        target_hidden_states = hidden_states[token_indices]
4066
                else:
4067
4068
4069
4070
4071
4072
4073
4074
                    (
                        common_attn_metadata,
                        token_indices_to_sample,
                        num_rejected_tokens_gpu,
                    ) = self.drafter.prepare_inputs_padded(
                        common_attn_metadata,
                        spec_decode_metadata,
                        valid_sampled_tokens_count,
4075
                    )
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
                    total_num_tokens = common_attn_metadata.num_actual_tokens
                    # When padding the batch, token_indices is just a range
                    target_token_ids = self.input_ids.gpu[:total_num_tokens]
                    target_positions = self._get_positions(total_num_tokens)
                    if self.use_aux_hidden_state_outputs:
                        assert aux_hidden_states is not None
                        target_hidden_states = torch.cat(
                            [h[:total_num_tokens] for h in aux_hidden_states], dim=-1
                        )
                    else:
                        target_hidden_states = hidden_states[:total_num_tokens]
4087

4088
            if self.supports_mm_inputs and self.drafter.supports_mm_inputs:
4089
4090
4091
4092
4093
4094
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
4095

4096
            draft_token_ids = self.drafter.propose(
4097
4098
4099
4100
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
4101
                token_indices_to_sample=token_indices_to_sample,
4102
                sampling_metadata=sampling_metadata,
4103
                common_attn_metadata=common_attn_metadata,
4104
                mm_embed_inputs=mm_embed_inputs,
4105
                num_rejected_tokens_gpu=num_rejected_tokens_gpu,
4106
                slot_mappings=slot_mappings,
4107
            )
4108

4109
        return draft_token_ids
4110

4111
4112
4113
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
4114
4115
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
4116
                f"Allowed configs: {allowed_config_names}"
4117
            )
4118
4119
4120
4121
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

4122
    @instrument(span_name="Loading (GPU)")
4123
4124
4125
4126
4127
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
4128
4129
4130
4131
4132
        logger.info_once(
            "Starting to load model %s...",
            self.model_config.model,
            scope="global",
        )
4133
4134
4135
4136
4137
        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)
        )
4138

4139
4140
4141
4142
        if self.parallel_config.enable_eplb:
            self.eplb_state = EplbState(self.parallel_config, self.device)
            eplb_models = 0

4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
        try:
            with DeviceMemoryProfiler() as m:
                time_before_load = time.perf_counter()
                model_loader = get_model_loader(self.load_config)
                self.model = model_loader.load_model(
                    vllm_config=self.vllm_config, model_config=self.model_config
                )
                if self.lora_config:
                    self.model = self.load_lora_model(
                        self.model, self.vllm_config, self.device
4153
                    )
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
                if hasattr(self, "drafter"):
                    logger.info_once("Loading drafter model...")
                    self.drafter.load_model(self.model)
                    if (
                        hasattr(self.drafter, "model")
                        and is_mixture_of_experts(self.drafter.model)
                        and self.parallel_config.enable_eplb
                    ):
                        spec_config = self.vllm_config.speculative_config
                        assert spec_config is not None
                        assert spec_config.draft_model_config is not None
                        logger.info_once(
                            "EPLB is enabled for drafter model %s.",
                            spec_config.draft_model_config.model,
                        )
4169

4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
                        global_expert_load = (
                            global_expert_loads[eplb_models]
                            if global_expert_loads
                            else None
                        )
                        old_global_expert_indices = (
                            old_global_expert_indices_per_model[eplb_models]
                            if old_global_expert_indices_per_model
                            else None
                        )
                        if self.eplb_state is None:
                            self.eplb_state = EplbState(
                                self.parallel_config, self.device
                            )
                        self.eplb_state.add_model(
                            self.drafter.model,
                            spec_config.draft_model_config,
                            global_expert_load,
                            old_global_expert_indices,
                            rank_mapping,
                        )
                        eplb_models += 1
4192

4193
4194
4195
4196
4197
4198
                if self.use_aux_hidden_state_outputs:
                    if not supports_eagle3(self.get_model()):
                        raise RuntimeError(
                            "Model does not support EAGLE3 interface but "
                            "aux_hidden_state_outputs was requested"
                        )
4199

4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
                    # Try to get auxiliary layers from speculative config,
                    # otherwise use model's default layers
                    aux_layers = self._get_eagle3_aux_layers_from_config()
                    if aux_layers:
                        logger.info(
                            "Using auxiliary layers from speculative config: %s",
                            aux_layers,
                        )
                    else:
                        aux_layers = self.model.get_eagle3_aux_hidden_state_layers()

                    self.model.set_aux_hidden_state_layers(aux_layers)
                time_after_load = time.perf_counter()
            self.model_memory_usage = m.consumed_memory
        except torch.cuda.OutOfMemoryError as e:
            msg = (
                "Failed to load model - not enough GPU memory. "
                "Try lowering --gpu-memory-utilization to free memory for weights, "
                "increasing --tensor-parallel-size, or using --quantization. "
                "See https://docs.vllm.ai/en/latest/configuration/conserving_memory/ "
                "for more tips."
            )
            combined_msg = f"{msg} (original error: {e})"
            logger.error(combined_msg)
            raise e
4225
        logger.info_once(
4226
4227
            "Model loading took %s GiB memory and %.6f seconds",
            format_gib(self.model_memory_usage),
4228
            time_after_load - time_before_load,
4229
            scope="local",
4230
        )
4231
        prepare_communication_buffer_for_model(self.model)
4232
4233
4234
4235
        if (drafter := getattr(self, "drafter", None)) and (
            drafter_model := getattr(drafter, "model", None)
        ):
            prepare_communication_buffer_for_model(drafter_model)
4236
        mm_config = self.model_config.multimodal_config
4237
        self.is_multimodal_pruning_enabled = (
4238
            supports_multimodal_pruning(self.get_model())
4239
4240
            and mm_config is not None
            and mm_config.is_multimodal_pruning_enabled()
4241
        )
4242

4243
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
            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(
4255
                self.model,
4256
                self.model_config,
4257
4258
4259
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
4260
            )
4261
4262
            if self.eplb_state.is_async:
                self.eplb_state.start_async_loop(rank_mapping=rank_mapping)
4263

4264
        if (
4265
4266
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
4267
        ):
4268
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
4269
            compilation_counter.stock_torch_compile_count += 1
4270
            self.model.compile(fullgraph=True, backend=backend)
4271
            return
4272
        # for other compilation modes, cudagraph behavior is controlled by
4273
4274
4275
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
4276
4277
        cudagraph_mode = self.compilation_config.cudagraph_mode
        assert cudagraph_mode is not None
4278
4279
4280
4281
        if (
            cudagraph_mode.has_full_cudagraphs()
            and not self.parallel_config.use_ubatching
        ):
4282
4283
4284
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
4285
        elif self.parallel_config.use_ubatching:
4286
            if cudagraph_mode.has_full_cudagraphs():
4287
4288
4289
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
4290
            else:
4291
4292
4293
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
4294

4295
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
        """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

4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
    def reload_weights(
        self,
        weights_iterator: Iterable[tuple[str, torch.Tensor]] | None = None,
        weights_path: str | None = None,
        is_checkpoint_format: bool = True,
    ) -> None:
        """
        Reload weights from a weights iterator or from disk

        :param weights_iterator: weights to load into model
        :param weights_path: path to load weights from if weights_iterator is not
            provided. Use path of original model if neither is provided.
        :param is_checkpoint_format: set to False if weights have already been processed
            into kernel format (repacking, renaming, ect.)
        """
        # TODO(@kylesayrs): generalize to all runners and loaders
        # argument validation
        if weights_iterator is None and not is_checkpoint_format:
            logger.warning(
                "Reloading from disk means that weights will be in checkpoint format. "
                "Please use `is_checkpoint_format=True` "
                "to avoid weight reloading errors"
            )

        model = self.get_model()
        weights_to_load = {name for name, _ in model.named_parameters()}
        counter_before_reloading = time.perf_counter()

        # load weights from disk if none are provided
        if weights_iterator is None:
            model_loader = get_model_loader(self.load_config)
            if not hasattr(model_loader, "get_all_weights"):
                raise NotImplementedError(
                    f"Model reloading with `{self.load_config.load_format}` format"
                )

            if weights_path is not None:
                self.model_config.model = weights_path
            weights_iterator = model_loader.get_all_weights(self.model_config, model)
            weights_iterator = cast(
                Iterable[tuple[str, torch.Tensor]], weights_iterator
            )

        # begin loading weights
        logger.info_once("Reloading weights inplace...", scope="local")
        load_device = (
            self.vllm_config.load_config.device or self.vllm_config.device_config.device
        )
        with torch.device(load_device):
            if is_checkpoint_format:
                # load weights from checkpoint/ original model format
                initialize_layerwise_reload(model)
                loaded_weights = model.load_weights(weights_iterator)
                finalize_layerwise_reload(model, self.model_config)

            else:
                # load weights from kernel format
                logger.warning_once(
                    "Reloading with `is_checkpoint_format=True` requires that "
                    "weights be in kernel format and already sharded",
                    scope="local",
                )
                loaded_weights = set()
                for name, loaded_weight in weights_iterator:
                    param = model.get_parameter(name)  # TODO: buffers?
                    param.copy_(loaded_weight)
                    loaded_weights.add(name)

        # logging and validation
        counter_after_reloading = time.perf_counter()
        diff_seconds = counter_after_reloading - counter_before_reloading
        logger.info_once(
            "Reloading and processing weights took %.2f seconds",
            diff_seconds,
            scope="local",
4394
        )
4395
4396
4397
4398
4399
4400
4401
        if self.model_config.quantization is None and loaded_weights is not None:
            weights_not_loaded = weights_to_load - loaded_weights
            if weights_not_loaded:
                logger.warning(
                    "Following weights were not loaded from checkpoint: %s",
                    weights_not_loaded,
                )
4402

4403
4404
4405
4406
4407
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
4408
            self.get_model(),
4409
            tensorizer_config=tensorizer_config,
4410
            model_config=self.model_config,
4411
4412
        )

4413
4414
4415
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
4416
        num_scheduled_tokens: dict[str, int],
4417
    ) -> dict[str, LogprobsTensors | None]:
4418
        num_prompt_logprobs_dict = self.num_prompt_logprobs
4419
4420
4421
        if not num_prompt_logprobs_dict:
            return {}

4422
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
4423
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
4424
4425
4426
4427
4428

        # 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():
4429
4430
4431
4432
            num_tokens = num_scheduled_tokens.get(req_id)
            if num_tokens is None:
                # This can happen if the request was preempted in prefill stage.
                continue
4433
4434
4435

            # Get metadata for this request.
            request = self.requests[req_id]
4436
4437
4438
4439
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

4440
4441
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
4442
4443
                self.device, non_blocking=True
            )
4444

4445
4446
4447
4448
4449
4450
            # 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(
4451
4452
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
4453
4454
                in_progress_dict[req_id] = logprobs_tensors

4455
            # Determine number of logits to retrieve.
4456
4457
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
4458
            num_remaining_tokens = num_prompt_tokens - start_tok
4459
            if num_tokens <= num_remaining_tokens:
4460
                # This is a chunk, more tokens remain.
4461
4462
4463
                # 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.
4464
4465
4466
4467
4468
                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)
4469
4470
4471
4472
4473
4474
4475
                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
4476
4477
4478
4479
4480

            # 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]
4481
            offset = self.query_start_loc.np[req_idx].item()
4482
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
4483
            logits = self.model.compute_logits(prompt_hidden_states)
4484
4485
4486
4487

            # 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.
4488
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
4489
4490

            # Compute prompt logprobs.
4491
            logprobs = self.sampler.compute_logprobs(logits)
4492
            token_ids, logprobs, ranks, _ = self.sampler.gather_logprobs(
4493
4494
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
4495
4496

            # Transfer GPU->CPU async.
4497
4498
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
4499
4500
4501
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
4502
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
4503
4504
                ranks, non_blocking=True
            )
4505
4506
4507
4508
4509

        # 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]
4510
            del in_progress_dict[req_id]
4511
4512

        # Must synchronize the non-blocking GPU->CPU transfers.
4513
        if prompt_logprobs_dict:
4514
            self._sync_device()
4515
4516
4517

        return prompt_logprobs_dict

4518
4519
    def _get_nans_in_logits(
        self,
4520
        logits: torch.Tensor | None,
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
    ) -> 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])
4532
4533
4534
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
4535
4536
4537
4538
            return num_nans_in_logits
        except IndexError:
            return {}

4539
    @contextmanager
4540
4541
4542
    def maybe_randomize_inputs(
        self, input_ids: torch.Tensor | None, inputs_embeds: torch.Tensor | None
    ):
4543
4544
4545
4546
        """
        Randomize input_ids if VLLM_RANDOMIZE_DP_DUMMY_INPUTS is set.
        This is to help balance expert-selection
         - during profile_run
4547
         - during DP rank dummy run
4548
        """
4549

4550
4551
4552
4553
        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
4554
        elif input_ids is not None:
4555
4556
4557
4558

            @functools.cache
            def rand_input_ids() -> torch.Tensor:
                return torch.randint_like(
4559
                    self.input_ids.gpu,
4560
4561
                    low=0,
                    high=self.model_config.get_vocab_size(),
4562
                )
4563

4564
            logger.debug_once("Randomizing dummy input_ids for DP Rank")
4565
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
4566
4567
            yield
            input_ids.fill_(0)
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
        else:

            @functools.cache
            def rand_inputs_embeds() -> torch.Tensor:
                return torch.randn_like(
                    self.inputs_embeds.gpu,
                )

            assert inputs_embeds is not None
            logger.debug_once("Randomizing dummy inputs_embeds for DP Rank")
            inputs_embeds.copy_(
                rand_inputs_embeds()[: inputs_embeds.size(0)], non_blocking=True
            )
            yield
            inputs_embeds.fill_(0)
4583

4584
4585
4586
4587
4588
4589
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
4590
4591
        assert self.mm_budget is not None

4592
4593
4594
        # Don't use `max_items_per_batch` here to avoid redundant computation
        dummy_mm_inputs = self.mm_registry.get_dummy_mm_inputs(
            self.model_config,
4595
            mm_counts={modality: 1},
4596
            cache=self.mm_budget.cache,
4597
        )
4598
4599
4600
4601
4602
        dummy_mm_item = dummy_mm_inputs["mm_kwargs"][modality][0]

        # We use the cache so that the item is saved to the cache,
        # but not read from the cache
        assert dummy_mm_item is not None, "Item should not already be cached"
4603

4604
4605
4606
        return next(
            mm_kwargs_group
            for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
4607
                [(modality, dummy_mm_item)] * max_items_per_batch,
4608
4609
4610
4611
                device=self.device,
                pin_memory=self.pin_memory,
            )
        )
4612

4613
4614
4615
4616
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
4617
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
4618
4619
        force_attention: bool = False,
        uniform_decode: bool = False,
4620
        allow_microbatching: bool = True,
4621
4622
        skip_eplb: bool = False,
        is_profile: bool = False,
4623
        create_mixed_batch: bool = False,
4624
        remove_lora: bool = True,
Rémi Delacourt's avatar
Rémi Delacourt committed
4625
        is_graph_capturing: bool = False,
4626
        num_active_loras: int = 0,
4627
    ) -> tuple[torch.Tensor, torch.Tensor]:
4628
4629
4630
4631
4632
4633
4634
        """
        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.
4635
                - if not set will determine the cudagraph mode based on using
4636
                    the self.cudagraph_dispatcher.
4637
4638
4639
4640
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
4641
            force_attention: If True, always create attention metadata. Used to
4642
4643
4644
4645
                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.
4646
4647
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
4648
            remove_lora: If False, dummy LoRAs are not destroyed after the run
4649
4650
            num_active_loras: Number of distinct active LoRAs to capture for.
                LoRA is activated when num_active_loras > 0.
4651
        """
4652
4653
        mm_config = self.vllm_config.model_config.multimodal_config
        if mm_config and mm_config.mm_encoder_only:
4654
4655
4656
4657
            # The current dummy run only covers LM execution, so we can skip it.
            # mm encoder dummy run may need to add in the future.
            return torch.tensor([]), torch.tensor([])

4658
4659
4660
4661
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
4662

4663
        # If cudagraph_mode.decode_mode() == FULL and
4664
        # cudagraph_mode.separate_routine(). This means that we are using
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
        # 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.
4676
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
4677

4678
4679
4680
4681
4682
        # 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
4683
4684
4685
4686
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
4687
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
4688
4689
4690
4691
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
4692
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
4693
4694
4695
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
4696
            assert not create_mixed_batch
4697
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
4698
4699
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
4700
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
4701
4702
4703
4704
4705
4706
        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

4707
4708
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
4709
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
4710
4711
        num_tokens_unpadded = int(num_scheduled_tokens.sum())

4712
        num_sampled_tokens = np.ones(num_reqs, dtype=np.int32)
4713

4714
        _cudagraph_mode, batch_desc, should_ubatch, num_tokens_across_dp, _ = (
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
            self._determine_batch_execution_and_padding(
                num_tokens=num_tokens_unpadded,
                num_reqs=num_reqs,
                num_scheduled_tokens_np=num_scheduled_tokens,
                max_num_scheduled_tokens=max_query_len,
                use_cascade_attn=False,
                allow_microbatching=allow_microbatching,
                force_eager=is_profile
                or (cudagraph_runtime_mode == CUDAGraphMode.NONE),
                # `force_uniform_decode` is used for cudagraph capture; because for
                # capturing mixed prefill-decode batches, we sometimes use
                # num_tokens == num_reqs which looks like a uniform decode batch to the
                # dispatcher; but we actually want to capture a piecewise cudagraph
                force_uniform_decode=uniform_decode,
                # `force_has_lora` is used for cudagraph capture; because LoRA is
                # activated later in the context manager, but we need to know the
                # LoRA state when determining the batch descriptor for capture
4732
4733
4734
4735
                force_has_lora=num_active_loras > 0,
                # `force_num_active_loras` is used for cudagraph capture; because we
                # need to capture graphs for specific num_active_loras counts
                force_num_active_loras=num_active_loras,
4736
4737
            )
        )
4738
4739
4740

        if cudagraph_runtime_mode is None:
            cudagraph_runtime_mode = _cudagraph_mode
4741
        else:
4742
4743
4744
4745
4746
4747
4748
4749
4750
            assert cudagraph_runtime_mode == _cudagraph_mode, (
                f"Cudagraph runtime mode mismatch in dummy_run. "
                f"Expected {_cudagraph_mode}, but got {cudagraph_runtime_mode}."
            )

        num_tokens_padded = batch_desc.num_tokens
        num_reqs_padded = (
            batch_desc.num_reqs if batch_desc.num_reqs is not None else num_reqs
        )
4751
        ubatch_slices, ubatch_slices_padded = maybe_create_ubatch_slices(
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
            should_ubatch,
            num_scheduled_tokens,
            num_tokens_padded,
            num_reqs_padded,
            self.vllm_config.parallel_config.num_ubatches,
        )
        logger.debug(
            "ubatch_slices: %s, ubatch_slices_padded: %s",
            ubatch_slices,
            ubatch_slices_padded,
4762
        )
4763

4764
        attn_metadata: PerLayerAttnMetadata | None = None
4765

4766
4767
4768
4769
4770
4771
4772
        slot_mappings_by_group, slot_mappings = self._get_slot_mappings(
            num_tokens_padded=num_tokens,
            num_reqs_padded=num_reqs_padded,
            num_tokens_unpadded=num_tokens_unpadded,
            ubatch_slices=ubatch_slices_padded,
        )

4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
        # _dummy_run shares pinned CPU buffers (seq_lens, query_start_loc,
        # etc.) with execute_model.  It must participate in the same event
        # protocol so that back-to-back dummy/real steps don't overwrite
        # pinned memory while a prior non_blocking H2D DMA is still reading.
        with self.synchronize_input_prep():
            # If force_attention is True, we always capture attention.
            # Otherwise, it only happens for cudagraph_runtime_mode=FULL.
            if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
                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:
                    seq_lens = max_query_len  # type: ignore[assignment]
                self.seq_lens.np[:num_reqs] = seq_lens
                self.seq_lens.np[num_reqs:] = 0
                self.seq_lens.copy_to_gpu()
4791

4792
4793
4794
                cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
                self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
                self.query_start_loc.copy_to_gpu()
4795

4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
                pad_attn = cudagraph_runtime_mode == CUDAGraphMode.FULL
                attn_metadata, _ = self._build_attention_metadata(
                    num_tokens=num_tokens_unpadded,
                    num_tokens_padded=num_tokens_padded if pad_attn else None,
                    num_reqs=num_reqs_padded,
                    max_query_len=max_query_len,
                    ubatch_slices=(ubatch_slices_padded if pad_attn else ubatch_slices),
                    for_cudagraph_capture=is_graph_capturing,
                    slot_mappings=slot_mappings_by_group,
                )
4806

4807
        with self.maybe_dummy_run_with_lora(
4808
4809
4810
4811
            self.lora_config,
            num_scheduled_tokens,
            num_sampled_tokens,
            remove_lora,
4812
            num_active_loras,
4813
        ):
4814
            # Make sure padding doesn't exceed max_num_tokens
4815
            assert num_tokens_padded <= self.max_num_tokens
4816
            model_kwargs = self._init_model_kwargs()
4817
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
Patrick von Platen's avatar
Patrick von Platen committed
4818
4819
                input_ids, inputs_embeds = self._prepare_mm_inputs(num_tokens_padded)

4820
                model_kwargs = {
4821
                    **model_kwargs,
4822
4823
                    **self._dummy_mm_kwargs(num_reqs),
                }
4824
4825
            elif self.enable_prompt_embeds:
                input_ids = None
4826
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_padded]
4827
                model_kwargs = self._init_model_kwargs()
4828
            else:
4829
                input_ids = self.input_ids.gpu[:num_tokens_padded]
4830
                inputs_embeds = None
4831

4832
            if self.uses_mrope:
4833
                positions = self.mrope_positions.gpu[:, :num_tokens_padded]
4834
            elif self.uses_xdrope_dim > 0:
4835
                positions = self.xdrope_positions.gpu[:, :num_tokens_padded]
4836
            else:
4837
                positions = self.positions.gpu[:num_tokens_padded]
4838
4839
4840
4841
4842
4843
4844
4845
4846

            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,
4847
4848
4849
                            device=self.device,
                        )
                    )
4850
4851

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
4852
                    num_tokens_padded, None, False
4853
                )
4854

4855
            if ubatch_slices_padded is not None:
4856
4857
4858
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
4859
                num_tokens_padded = ubatch_slices_padded[0].num_tokens
4860
                if num_tokens_across_dp is not None:
4861
                    num_tokens_across_dp[:] = num_tokens_padded
4862

4863
            with (
4864
                self.maybe_randomize_inputs(input_ids, inputs_embeds),
4865
                set_forward_context(
4866
4867
                    attn_metadata,
                    self.vllm_config,
4868
                    num_tokens=num_tokens_padded,
4869
4870
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
4871
                    batch_descriptor=batch_desc,
4872
                    ubatch_slices=ubatch_slices_padded,
4873
                    slot_mapping=slot_mappings,
4874
4875
                ),
            ):
4876
                outputs = self.model(
4877
4878
4879
4880
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
4881
                    **model_kwargs,
4882
                )
4883

4884
4885
4886
4887
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
4888

4889
4890
4891
4892
4893
4894
            if self.speculative_config and (
                self.speculative_config.use_eagle()
                or self.speculative_config.uses_draft_model()
            ):
                assert isinstance(self.drafter, EagleProposer | DraftModelProposer)
                assert self.speculative_config is not None
4895
4896
4897
                # Eagle currently only supports PIECEWISE cudagraphs.
                # Therefore only use cudagraphs if the main model uses PIECEWISE
                # NOTE(lucas): this is a hack, need to clean up.
4898
                use_cudagraphs = (
4899
4900
4901
4902
4903
4904
4905
4906
4907
                    (
                        is_graph_capturing
                        and cudagraph_runtime_mode == CUDAGraphMode.PIECEWISE
                    )
                    or (
                        not is_graph_capturing
                        and cudagraph_runtime_mode != CUDAGraphMode.NONE
                    )
                ) and not self.speculative_config.enforce_eager
4908
4909
4910
4911
4912

                # 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
4913
4914
4915
4916
                if (
                    self.compilation_config.cudagraph_specialize_lora
                    and num_active_loras > 0
                ):
4917
4918
4919
4920
4921
                    use_cudagraphs = False

                self.drafter.dummy_run(
                    num_tokens,
                    use_cudagraphs=use_cudagraphs,
Rémi Delacourt's avatar
Rémi Delacourt committed
4922
                    is_graph_capturing=is_graph_capturing,
4923
                    slot_mappings=slot_mappings,
4924
                )
4925

4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
        # We register layerwise NVTX hooks here after the first dynamo tracing is
        # done to avoid nvtx operations in hook functions being traced by
        # torch dynamo and causing graph breaks.
        # Note that for DYNAMO_ONCE and VLLM_COMPILE mode,
        # compiled model's dynamo tracing is only done once and the compiled model's
        # __call__ function is replaced by calling the compiled function.
        # So it's safe to register hooks here. Hooks will be registered to
        # both compiled and uncompiled models but they will never
        # be called on the compiled model execution path.
        self._register_layerwise_nvtx_hooks()

4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
        # 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)

4947
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
4948
4949
4950
4951
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
4952
4953
4954
4955
4956
4957

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
4958
4959
4960
        # The dummy hidden states may contain special values,
        # like `inf` or `nan`.
        # To avoid breaking the sampler, we use a random tensor here instead.
4961

4962
4963
        mm_config = self.vllm_config.model_config.multimodal_config
        if mm_config and mm_config.mm_encoder_only:
4964
4965
4966
            # MM Encoder only model no need to run sampler.
            return torch.tensor([])

4967
        hidden_states = torch.rand_like(hidden_states)
4968

4969
        logits = self.model.compute_logits(hidden_states)
4970
4971
        num_reqs = logits.size(0)

4972
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987

        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)],
4988
            spec_token_ids=[[] for _ in range(num_reqs)],
4989
4990
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
4991
            logitsprocs=LogitsProcessors(),
4992
        )
4993
        try:
4994
4995
4996
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
4997
        except RuntimeError as e:
4998
            if "out of memory" in str(e):
4999
5000
5001
5002
                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 "
5003
5004
                    "initializing the engine."
                ) from e
5005
5006
            else:
                raise e
5007
        if self.speculative_config:
5008
5009
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
5010
5011
                draft_token_ids, self.device
            )
5012
5013
5014
5015
5016
5017

            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
5018
5019
5020
5021
5022
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
5023
            )
5024
5025
5026
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
5027
                logits,
5028
5029
                dummy_metadata,
            )
5030
        return sampler_output
5031

5032
    def _dummy_pooler_run_task(
5033
5034
        self,
        hidden_states: torch.Tensor,
5035
5036
        task: PoolingTask,
    ) -> PoolerOutput:
5037
5038
5039
5040
        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
5041
5042
5043
5044
        num_scheduled_tokens_np = np.full(num_reqs, min_tokens_per_req)
        num_scheduled_tokens_np[-1] += num_tokens % num_reqs
        assert np.sum(num_scheduled_tokens_np) == num_tokens
        assert len(num_scheduled_tokens_np) == num_reqs
5045
5046
5047

        req_num_tokens = num_tokens // num_reqs

5048
        dummy_prompt_lens = torch.from_numpy(num_scheduled_tokens_np)
5049
5050
5051
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
5052

5053
        model = cast(VllmModelForPooling, self.get_model())
5054
        dummy_pooling_params = PoolingParams(task=task)
5055
        dummy_pooling_params.verify(self.model_config)
5056
        to_update = model.pooler.get_pooling_updates(task)
5057
5058
        to_update.apply(dummy_pooling_params)

5059
        dummy_metadata = PoolingMetadata(
5060
5061
5062
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
5063
            pooling_states=[PoolingStates() for i in range(num_reqs)],
5064
        )
5065

5066
        dummy_metadata.build_pooling_cursor(
5067
            num_scheduled_tokens_np,
5068
5069
            seq_lens_cpu=dummy_prompt_lens,
            device=hidden_states.device,
5070
        )
5071

5072
        try:
5073
5074
5075
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
5076
        except RuntimeError as e:
5077
            if "out of memory" in str(e):
5078
                raise RuntimeError(
5079
5080
5081
                    "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 "
5082
5083
                    "initializing the engine."
                ) from e
5084
5085
            else:
                raise e
5086
5087
5088
5089
5090
5091

    @torch.inference_mode()
    def _dummy_pooler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> PoolerOutput:
5092
5093
        mm_config = self.vllm_config.model_config.multimodal_config
        if mm_config and mm_config.mm_encoder_only:
5094
5095
5096
            # MM Encoder only model not need to run pooler.
            return torch.tensor([])

5097
        # Find the task that has the largest output for subsequent steps
5098
5099
5100
        supported_pooling_tasks = self.get_supported_pooling_tasks()

        if not supported_pooling_tasks:
5101
5102
5103
5104
5105
5106
            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."
            )
5107

5108
        output_size = dict[PoolingTask, float]()
5109
        for task in supported_pooling_tasks:
5110
5111
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
5112
            output_size[task] = sum(o.nbytes for o in output if o is not None)
5113
5114
5115
5116
            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)
5117

5118
    def profile_run(self) -> None:
5119
        # Profile with multimodal encoder & encoder cache.
5120
        if self.supports_mm_inputs:
5121
5122
            mm_config = self.model_config.multimodal_config
            if mm_config is not None and mm_config.skip_mm_profiling:
5123
                logger.info(
5124
                    "Skipping memory profiling for multimodal encoder and "
5125
5126
                    "encoder cache."
                )
5127
5128
5129
5130
5131
            else:
                mm_budget = self.mm_budget
                assert mm_budget is not None

                if (encoder_budget := mm_budget.get_encoder_budget()) > 0:
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
                    if not mm_budget.mm_max_toks_per_item:
                        # All modality limits are 0 — embedding-only mode.
                        # Budget is non-zero for embedding storage, but
                        # there's no encoder to profile.
                        logger.info(
                            "Skipping encoder profiling for embedding-only "
                            "mode (all modality limits=0 with "
                            "enable_mm_embeds=True).",
                        )
                    else:
                        # NOTE: Currently model is profiled with a single
                        # non-text modality with the max possible input
                        # tokens even when it supports multiple.
                        dummy_modality = mm_budget.get_modality_with_max_tokens()
                        max_mm_items_per_batch = mm_budget.mm_max_items_per_batch[
                            dummy_modality
                        ]
5149

5150
5151
5152
5153
5154
5155
5156
5157
                        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,
                        )
5158

5159
5160
5161
5162
5163
                        # Create dummy batch of multimodal inputs.
                        batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                            dummy_modality,
                            max_mm_items_per_batch,
                        )
5164

5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
                        # Run multimodal encoder.
                        dummy_encoder_outputs = self.model.embed_multimodal(
                            **batched_dummy_mm_inputs
                        )

                        sanity_check_mm_encoder_outputs(
                            dummy_encoder_outputs,
                            expected_num_items=max_mm_items_per_batch,
                        )
                        for i, output in enumerate(dummy_encoder_outputs):
                            self.encoder_cache[f"tmp_{i}"] = output
5176

5177
        # Add `is_profile` here to pre-allocate communication buffers
5178
5179
5180
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
5181
        if get_pp_group().is_last_rank:
5182
5183
5184
5185
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
5186
        else:
5187
            output = None
5188
        self._sync_device()
5189
        del hidden_states, output
5190
        self.encoder_cache.clear()
5191
        gc.collect()
5192

5193
    @instrument(span_name="Capture model")
5194
    def capture_model(self) -> int:
5195
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
5196
            logger.warning(
5197
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
5198
5199
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
5200
            return 0
5201

5202
5203
        compilation_counter.num_gpu_runner_capture_triggers += 1

5204
5205
        start_time = time.perf_counter()

5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
        @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()
5220
                    gc.collect()
5221

5222
5223
5224
        # 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.
5225
        set_cudagraph_capturing_enabled(True)
5226
        with freeze_gc(), graph_capture(device=self.device):
5227
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
5228

5229
5230
5231
5232
            for (
                runtime_mode,
                batch_descs,
            ) in self.cudagraph_dispatcher.get_capture_descs():
5233
                self._capture_cudagraphs(
5234
5235
                    batch_descriptors=batch_descs,
                    cudagraph_runtime_mode=runtime_mode,
5236
                )
5237

5238
5239
5240
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

5241
5242
5243
        # 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
5244
        # we may do lazy capturing in future that still allows capturing
5245
5246
        # after here.
        set_cudagraph_capturing_enabled(False)
5247

5248
5249
5250
5251
        # Lock workspace to prevent resizing during execution.
        # Max workspace sizes should have been captured during warmup/profiling.
        lock_workspace()

5252
5253
5254
5255
        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.
5256
        logger.info_once(
5257
5258
5259
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
5260
            scope="local",
5261
        )
5262
        return cuda_graph_size
5263

5264
5265
    def _capture_cudagraphs(
        self,
5266
        batch_descriptors: list[BatchDescriptor],
5267
5268
5269
5270
5271
5272
        cudagraph_runtime_mode: CUDAGraphMode,
    ):
        assert (
            cudagraph_runtime_mode != CUDAGraphMode.NONE
            and cudagraph_runtime_mode.valid_runtime_modes()
        ), f"Invalid cudagraph runtime mode: {cudagraph_runtime_mode}"
5273

5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
        if not batch_descriptors:
            return

        uniform_decode = batch_descriptors[0].uniform
        force_attention = cudagraph_runtime_mode == CUDAGraphMode.FULL

        dummy_run = functools.partial(
            self._dummy_run,
            uniform_decode=uniform_decode,
            skip_eplb=True,
            remove_lora=False,
            force_attention=force_attention,
        )

5288
5289
        # Only rank 0 should print progress bar during capture
        if is_global_first_rank():
5290
5291
            batch_descriptors = tqdm(
                batch_descriptors,
5292
5293
5294
                disable=not self.load_config.use_tqdm_on_load,
                desc="Capturing CUDA graphs ({}, {})".format(
                    "decode" if uniform_decode else "mixed prefill-decode",
5295
5296
5297
                    cudagraph_runtime_mode.name,
                ),
            )
5298

5299
        # We skip EPLB here since we don't want to record dummy metrics
5300
5301
        for batch_desc in batch_descriptors:
            num_tokens = batch_desc.num_tokens
5302
            num_active_loras = batch_desc.num_active_loras
5303

5304
            # We currently only capture ubatched graphs when its a FULL
5305
5306
5307
            # 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
5308
            allow_microbatching = (
5309
                self.parallel_config.use_ubatching
5310
5311
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
5312
5313
5314
5315
5316
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
5317
            )
5318

5319
5320
            for _ in range(self.compilation_config.cudagraph_num_of_warmups):
                # Use CUDAGraphRuntimeStyle.NONE (default) for warmup.
5321
                # But be careful, warm up with `NONE` is orthogonal to
5322
5323
5324
                # 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.
5325
                dummy_run(
5326
5327
5328
                    num_tokens,
                    cudagraph_runtime_mode=CUDAGraphMode.NONE,
                    allow_microbatching=allow_microbatching,
5329
                    num_active_loras=num_active_loras,
5330
                )
5331
5332
5333

            # Capture run
            dummy_run(
5334
5335
5336
                num_tokens,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                allow_microbatching=allow_microbatching,
5337
                num_active_loras=num_active_loras,
Rémi Delacourt's avatar
Rémi Delacourt committed
5338
                is_graph_capturing=True,
5339
            )
5340
        self.maybe_remove_all_loras(self.lora_config)
5341

5342
5343
5344
5345
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
5346
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
5347

5348
5349
5350
5351
5352
5353
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
5354
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
5355
            layer_type = cast(type[Any], AttentionLayerBase)
5356
            layers = get_layers_from_vllm_config(
5357
                self.vllm_config, layer_type, kv_cache_group_spec.layer_names
5358
            )
5359
5360
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
5361
            # Dedupe based on full class name; this is a bit safer than
5362
5363
5364
5365
            # 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.
5366
            for layer_name in kv_cache_group_spec.layer_names:
5367
                attn_backend = layers[layer_name].get_attn_backend()
5368
5369
5370
5371

                if layer_name in self.kv_sharing_fast_prefill_eligible_layers:
                    attn_backend = create_fast_prefill_custom_backend(
                        "FastPrefill",
5372
                        attn_backend,  # type: ignore[arg-type]
5373
5374
                    )

5375
5376
5377
                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):
5378
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
5379
                key = (full_cls_name, layer_kv_cache_spec)
5380
5381
5382
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
5383
                attn_backend_layers[key].append(layer_name)
5384
5385
5386
5387
            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()),
            )
5388
5389

        def create_attn_groups(
5390
            attn_backends_map: dict[AttentionGroupKey, list[str]],
5391
            kv_cache_group_id: int,
5392
5393
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
5394
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
5395
                attn_group = AttentionGroup(
5396
                    attn_backend,
5397
                    layer_names,
5398
                    kv_cache_spec,
5399
                    kv_cache_group_id,
5400
5401
                )

5402
5403
5404
                attn_groups.append(attn_group)
            return attn_groups

5405
        attention_backend_maps = []
5406
        attention_backend_list = []
5407
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
5408
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
5409
            attention_backend_maps.append(attn_backends[0])
5410
            attention_backend_list.append(attn_backends[1])
5411
5412

        # Resolve cudagraph_mode before actually initialize metadata_builders
5413
5414
5415
        self._check_and_update_cudagraph_mode(
            attention_backend_list, kv_cache_config.kv_cache_groups
        )
5416

5417
5418
5419
        # Check if attention backend supports PCP&DCP and related features.
        check_attention_cp_compatibility(self.vllm_config)

5420
5421
        for i, attn_backend_map in enumerate(attention_backend_maps):
            self.attn_groups.append(create_attn_groups(attn_backend_map, i))
5422

5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
    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
5438
5439
                    if not self.parallel_config.use_ubatching
                    else self.parallel_config.num_ubatches,
5440
                )
co63oc's avatar
co63oc committed
5441
        # Calculate reorder batch threshold (if needed)
5442
5443
        # Note (tdoublep): do this *after* constructing builders,
        # because some of them change the threshold at init time.
5444
5445
        self.calculate_reorder_batch_threshold()

5446
    def _check_and_update_cudagraph_mode(
5447
5448
5449
        self,
        attention_backends: list[set[type[AttentionBackend]]],
        kv_cache_groups: list[KVCacheGroupSpec],
5450
    ) -> None:
5451
        """
5452
        Resolve the cudagraph_mode when there are multiple attention
5453
        groups with potential conflicting CUDA graph support.
5454
5455
5456
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
5457
        min_cg_support = AttentionCGSupport.ALWAYS
5458
        min_cg_backend_name = None
5459

5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
        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__
5472
5473
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
5474
        assert cudagraph_mode is not None
5475
        # check cudagraph for mixed batch is supported
5476
5477
5478
5479
5480
5481
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
5482
                f"with {min_cg_backend_name} backend (support: "
5483
5484
                f"{min_cg_support})"
            )
5485
5486
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
5487
5488
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
5489
                    "make sure compilation mode is VLLM_COMPILE"
5490
                )
5491
5492
5493
5494
5495
                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"
5496
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
5497
                    CUDAGraphMode.FULL_AND_PIECEWISE
5498
                )
5499
5500
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
5501
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
5502
                    CUDAGraphMode.FULL_DECODE_ONLY
5503
                )
5504
5505
            logger.warning(msg)

5506
        # check that if we are doing decode full-cudagraphs it is supported
5507
5508
5509
5510
5511
5512
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
5513
                f"with {min_cg_backend_name} backend (support: "
5514
5515
                f"{min_cg_support})"
            )
5516
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
5517
5518
5519
5520
5521
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
5522
                    "attention is compiled piecewise"
5523
5524
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
5525
                    CUDAGraphMode.PIECEWISE
5526
                )
5527
            else:
5528
5529
                msg += (
                    "; setting cudagraph_mode=NONE because "
5530
                    "attention is not compiled piecewise"
5531
5532
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
5533
                    CUDAGraphMode.NONE
5534
                )
5535
5536
            logger.warning(msg)

5537
5538
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
5539
5540
5541
5542
5543
5544
5545
5546
        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 "
5547
                f"{min_cg_backend_name} (support: {min_cg_support})"
5548
            )
5549
5550
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
5551
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
5552
                    CUDAGraphMode.PIECEWISE
5553
                )
5554
5555
            else:
                msg += "; setting cudagraph_mode=NONE"
5556
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
5557
                    CUDAGraphMode.NONE
5558
                )
5559
5560
5561
5562
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
5563
5564
5565
5566
5567
5568
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
5569
                f"supported with {min_cg_backend_name} backend ("
5570
5571
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
5572
                "and make sure compilation mode is VLLM_COMPILE"
5573
            )
5574

5575
5576
5577
5578
        # 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
5579
        # Will be removed in the near future when we have separate cudagraph capture
5580
5581
5582
5583
5584
5585
5586
5587
5588
        # 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
            )
5589
5590
5591
5592
            capture_sizes = self.compilation_config.cudagraph_capture_sizes
            self.cudagraph_batch_sizes = (
                capture_sizes if capture_sizes is not None else []
            )
5593

5594
5595
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
5596
        self.compilation_config.cudagraph_mode = cudagraph_mode
5597
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
5598
            cudagraph_mode, self.uniform_decode_query_len
5599
        )
5600

5601
5602
5603
5604
5605
        # Initialize eagle's cudagraph dispatcher if using eagle spec decode.
        if self.speculative_config and self.speculative_config.use_eagle():
            assert isinstance(self.drafter, EagleProposer)
            self.drafter.initialize_cudagraph_keys(cudagraph_mode)

5606
5607
    def calculate_reorder_batch_threshold(self) -> None:
        """
5608
5609
5610
5611
        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.
5612
        """
5613
5614
        min_none_high = lambda a, b: a if b is None else b if a is None else min(a, b)

5615
        reorder_batch_thresholds: list[int | None] = [
5616
5617
5618
            group.get_metadata_builder().reorder_batch_threshold
            for group in self._attn_group_iterator()
        ]
5619
5620
5621
5622
5623
        # 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
5624
        self.reorder_batch_threshold = reduce(min_none_high, reorder_batch_thresholds)  # type: ignore[assignment]
5625

5626
5627
5628
    @staticmethod
    def select_common_block_size(
        kv_manager_block_size: int, attn_groups: list[AttentionGroup]
5629
5630
    ) -> int:
        """
5631
5632
5633
5634
5635
        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.
5636
5637
5638
5639
5640
5641

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

        Returns:
5642
            The selected block size
5643
5644

        Raises:
5645
            ValueError: If no valid block size found
5646
5647
        """

5648
5649
5650
5651
5652
5653
5654
5655
        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
5656
                for supported_size in backend.get_supported_kernel_block_sizes():
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
                    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
5687
            for supported_size in backend.get_supported_kernel_block_sizes()
5688
5689
            if isinstance(supported_size, int)
        )
5690

5691
5692
5693
5694
5695
5696
        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}. ")
5697

5698
5699
5700
    def may_reinitialize_input_batch(
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
    ) -> None:
5701
5702
5703
5704
5705
5706
5707
        """
        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.
5708
            kernel_block_sizes: The kernel block sizes for each KV cache group.
5709
        """
5710
        block_sizes = []
5711
5712
        max_num_blocks = []
        max_model_len = max(self.max_model_len, self.max_encoder_len)
5713
        for kv_cache_group in kv_cache_config.kv_cache_groups:
5714
5715
            if isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec):
                continue
5716
5717
            block_size = kv_cache_group.kv_cache_spec.block_size
            block_sizes.append(block_size)
5718
            max_num_blocks_per_req = cdiv(
5719
                max_model_len, block_size * get_total_cp_world_size()
5720
5721
            )
            if isinstance(kv_cache_group.kv_cache_spec, MambaSpec):
5722
                max_num_blocks_per_req = (
5723
5724
5725
5726
5727
                    max_num_blocks_per_req
                    if self.cache_config.enable_prefix_caching
                    else 1
                ) + kv_cache_group.kv_cache_spec.num_speculative_blocks
            max_num_blocks.append(max_num_blocks_per_req)
5728
5729
5730
5731

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
5732
5733
5734
            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
5735
5736
                "for more details."
            )
5737
5738
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
5739
                max_model_len=max_model_len,
5740
5741
5742
5743
5744
                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,
5745
                kernel_block_sizes=kernel_block_sizes,
5746
                max_num_blocks_per_req=max_num_blocks,
5747
                is_spec_decode=bool(self.vllm_config.speculative_config),
5748
                logitsprocs=self.input_batch.logitsprocs,
5749
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
5750
                is_pooling_model=self.is_pooling_model,
5751
5752
            )

5753
    def _allocate_kv_cache_tensors(
5754
5755
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
5756
        """
5757
5758
5759
        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.

5760
        Args:
5761
            kv_cache_config: The KV cache config
5762
        Returns:
5763
            dict[str, torch.Tensor]: A map between layer names to their
5764
            corresponding memory buffer for KV cache.
5765
        """
5766
5767
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
5768
5769
5770
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
5771
5772
5773
5774
5775
            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:
5776
5777
5778
5779
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
5780
5781
5782
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
5783
5784
        return kv_cache_raw_tensors

5785
5786
5787
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

5788
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
5789
5790
        if not self.kv_cache_config.kv_cache_groups:
            return
5791
5792
        for attn_groups in self.attn_groups:
            yield from attn_groups
5793

5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
    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 = []
5809
        for kv_cache_gid, kv_cache_group in enumerate(kv_cache_config.kv_cache_groups):
5810
5811
5812
5813
5814
5815
            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):
5816
                continue
5817
            elif isinstance(kv_cache_spec, AttentionSpec):
5818
5819
5820
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
5821
                attn_groups = self.attn_groups[kv_cache_gid]
5822
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
5823
                selected_kernel_size = self.select_common_block_size(
5824
5825
5826
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
5827
            elif isinstance(kv_cache_spec, MambaSpec):
5828
5829
                # This is likely Mamba or other non-attention cache,
                # no splitting.
5830
                kernel_block_sizes.append(kv_cache_spec.block_size)
5831
5832
5833
5834
5835
5836
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

5837
5838
5839
5840
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
5841
        kernel_block_sizes: list[int],
5842
    ) -> dict[str, torch.Tensor]:
5843
        """
5844
        Reshape the KV cache tensors to the desired shape and dtype.
5845

5846
        Args:
5847
5848
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
5849
                correct size but uninitialized shape.
5850
            kernel_block_sizes: The kernel block sizes for each KV cache group.
5851
        Returns:
5852
            Dict[str, torch.Tensor]: A map between layer names to their
5853
5854
            corresponding memory buffer for KV cache.
        """
5855
        kv_caches: dict[str, torch.Tensor] = {}
5856
        has_attn, has_mamba = False, False
5857
5858
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5859
            attn_backend = group.backend
5860
5861
5862
5863
            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]
5864
            for layer_name in group.layer_names:
5865
5866
                if layer_name in self.runner_only_attn_layers:
                    continue
5867
5868
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
5869
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
5870
                if isinstance(kv_cache_spec, AttentionSpec):
5871
                    has_attn = True
5872
5873
                    num_blocks_per_kv_block = (
                        kv_cache_spec.block_size // kernel_block_size
5874
5875
5876
                    )
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

5877
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
5878
                        kernel_num_blocks,
5879
                        kernel_block_size,
5880
5881
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
5882
5883
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
5884
                    dtype = kv_cache_spec.dtype
5885
                    try:
5886
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()
5887
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
5888
                    except (AttributeError, NotImplementedError):
5889
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
5890
5891
5892
5893
5894
                    # 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.
5895
5896
5897
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
5898
5899
5900
5901
5902
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
5903
5904
5905
5906
5907
5908
                    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
5909
                elif isinstance(kv_cache_spec, MambaSpec):
5910
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
5911
5912
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
5913
                    storage_offset_bytes = 0
5914
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
5915
5916
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
5917
5918
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
5919
                        target_shape = (num_blocks, *shape)
5920
5921
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
5922
                        assert storage_offset_bytes % dtype_size == 0
5923
5924
5925
5926
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
5927
                            storage_offset=storage_offset_bytes // dtype_size,
5928
                        )
Chen Zhang's avatar
Chen Zhang committed
5929
                        state_tensors.append(tensor)
5930
                        storage_offset_bytes += stride[0] * dtype_size
5931
5932

                    kv_caches[layer_name] = state_tensors
5933
                else:
5934
                    raise NotImplementedError
5935
5936

        if has_attn and has_mamba:
5937
            self._update_hybrid_attention_mamba_layout(kv_caches)
5938

5939
5940
        return kv_caches

5941
    def _update_hybrid_attention_mamba_layout(
5942
5943
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
5944
        """
5945
5946
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
5947
5948

        Args:
5949
            kv_caches: The KV cache buffer of each layer.
5950
5951
        """

5952
5953
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
5954
            for layer_name in group.layer_names:
5955
                kv_cache = kv_caches[layer_name]
5956
5957
5958
5959
                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 "
5960
                        f"a tensor of shape {kv_cache.shape}"
5961
                    )
5962
                    hidden_size = kv_cache.shape[2:].numel()
5963
5964
5965
5966
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
5967

5968
    def initialize_kv_cache_tensors(
5969
        self, kv_cache_config: KVCacheConfig, kernel_block_sizes: list[int]
5970
    ) -> dict[str, torch.Tensor]:
5971
5972
5973
5974
5975
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
5976
5977
            kernel_block_sizes: The kernel block sizes for each KV cache group.

5978
        Returns:
5979
            Dict[str, torch.Tensor]: A map between layer names to their
5980
5981
            corresponding memory buffer for KV cache.
        """
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005

        # Try creating KV caches optimized for kv-connector transfers
        cache_dtype = self.cache_config.cache_dtype
        if self.use_uniform_kv_cache(self.attn_groups, cache_dtype):
            kv_caches, cross_layers_kv_cache, attn_backend = (
                self.allocate_uniform_kv_caches(
                    kv_cache_config,
                    self.attn_groups,
                    cache_dtype,
                    self.device,
                    kernel_block_sizes,
                )
            )
            self.cross_layers_kv_cache = cross_layers_kv_cache
            self.cross_layers_attn_backend = attn_backend
        else:
            # Fallback to the general case
            # Initialize the memory buffer for KV cache
            kv_cache_raw_tensors = self._allocate_kv_cache_tensors(kv_cache_config)

            # Change the memory buffer to the desired shape
            kv_caches = self._reshape_kv_cache_tensors(
                kv_cache_config, kv_cache_raw_tensors, kernel_block_sizes
            )
6006

6007
        # Set up cross-layer KV cache sharing
6008
6009
        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)
6010
6011
            kv_caches[layer_name] = kv_caches[target_layer_name]

6012
6013
6014
6015
6016
6017
6018
6019
6020
        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,
        )
6021
6022
6023
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
6024
6025
        self, kv_cache_config: KVCacheConfig
    ) -> None:
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
        """
        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.
6044
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
6045
6046
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
6047
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
6048
6049
                else:
                    break
6050

6051
6052
6053
6054
6055
6056
6057
    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
        """
6058
        kv_cache_config = deepcopy(kv_cache_config)
6059
        self.kv_cache_config = kv_cache_config
6060
        self.may_add_encoder_only_layers_to_kv_cache_config()
6061
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
6062
        self.initialize_attn_backend(kv_cache_config)
6063
6064
6065
6066
6067
6068
        # 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)
6069
6070
6071
6072

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

6073
        # Reinitialize need to after initialize_attn_backend
6074
6075
6076
6077
        self.may_reinitialize_input_batch(kv_cache_config, kernel_block_sizes)
        kv_caches = self.initialize_kv_cache_tensors(
            kv_cache_config, kernel_block_sizes
        )
6078

6079
6080
6081
6082
6083
        if self.speculative_config and (
            self.speculative_config.use_eagle()
            or self.speculative_config.uses_draft_model()
        ):
            assert isinstance(self.drafter, EagleProposer | DraftModelProposer)
6084
6085
6086
6087
            # 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
6088
        if has_kv_transfer_group():
6089
            kv_transfer_group = get_kv_transfer_group()
6090
6091
6092
6093
6094
6095
6096
            if self.cross_layers_kv_cache is not None:
                assert self.cross_layers_attn_backend is not None
                kv_transfer_group.register_cross_layers_kv_cache(
                    self.cross_layers_kv_cache, self.cross_layers_attn_backend
                )
            else:
                kv_transfer_group.register_kv_caches(kv_caches)
6097
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
6098

6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
        if self.model_config.enable_return_routed_experts:
            self.init_routed_experts_capturer()

    def init_routed_experts_capturer(self):
        logger.info(
            "Initializing routed experts capturer, enable_return_routed_experts: %s",
            self.model_config.enable_return_routed_experts,
        )
        routed_experts_capturer = RoutedExpertsCapturer.create()
        block_size = self.cache_config.block_size
        self.max_num_kv_tokens = (
            self.kv_cache_config.num_blocks // len(self.kv_cache_config.kv_cache_groups)
            + 1
        ) * block_size
        routed_experts_capturer.init_buffer(
            max_num_batched_tokens=self.scheduler_config.max_num_batched_tokens,
            max_num_kv_tokens=self.max_num_kv_tokens,
6116
            vllm_config=self.vllm_config,
6117
        )
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
        self._bind_routed_experts_capturer(routed_experts_capturer)

    def _bind_routed_experts_capturer(self, capturer: RoutedExpertsCapturer) -> None:
        from vllm.model_executor.layers.fused_moe.layer import FusedMoE
        from vllm.model_executor.layers.fused_moe.router.base_router import (
            BaseRouter,
        )

        for module in self.compilation_config.static_forward_context.values():
            if isinstance(module, FusedMoE) and isinstance(module.router, BaseRouter):
                layer_id = module.layer_id

                def _capture_fn(topk_ids, _layer_id=layer_id, _capturer=capturer):
                    _capturer.capture(_layer_id, topk_ids)

                module.router.set_capture_fn(_capture_fn)
6134

6135
6136
6137
6138
6139
    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
6140
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
6141
6142
6143
        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:
6144
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
6145
6146
6147
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
6148
6149
                    dtype=self.kv_cache_dtype,
                )
6150
6151
6152
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
6153
6154
6155
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
6156
6157
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
6158
6159
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
6160

6161
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
6162
        """
6163
        Generates the KVCacheSpec by parsing the kv cache format from each
6164
6165
        Attention module in the static forward context.
        Returns:
6166
            KVCacheSpec: A dictionary mapping layer names to their KV cache
6167
6168
            format. Layers that do not need KV cache are not included.
        """
6169
6170
        if has_ec_transfer() and get_ec_transfer().is_producer:
            return {}
6171
        kv_cache_spec: dict[str, KVCacheSpec] = {}
6172
6173
        layer_type = cast(type[Any], AttentionLayerBase)
        attn_layers = get_layers_from_vllm_config(self.vllm_config, layer_type)
Chen Zhang's avatar
Chen Zhang committed
6174
        for layer_name, attn_module in attn_layers.items():
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
            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
6190

6191
        return kv_cache_spec
6192

6193
    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
6194
6195
6196
6197
6198
6199
6200
6201
        # 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.
6202
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
6203
6204
6205
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
6206
        return pinned.tolist()
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282

    def get_encoder_timing_stats(self) -> dict[str, dict[str, float | int]]:
        """
        Get encoder timing stats for all requests and clear the registry.

        Returns:
            Dictionary mapping request_id to stats dict.
        """
        with self._encoder_timing_lock:
            stats = {
                req_id: stats_obj.to_dict()
                for req_id, stats_obj in self.encoder_timing_registry.items()
            }
            self.encoder_timing_registry.clear()
            return stats

    @contextmanager
    def timed_encoder_operation(
        self,
        should_time: bool,
        group_lora_refs: list[tuple[str, Any]],
        current_item_idx: int,
        num_items: int,
    ):
        """
        Context manager to time encoder forward operations.

        Args:
            should_time: Whether timing is enabled
            group_lora_refs: Full list of (request_id, pos_info) tuples
            current_item_idx: Starting index for this group
            num_items: Number of items in this group
        """
        if not should_time:
            yield
            return

        group_refs = group_lora_refs[current_item_idx : current_item_idx + num_items]
        group_request_ids = {req_id for req_id, _ in group_refs}

        torch.cuda.synchronize()
        start_time = time.perf_counter()

        try:
            yield
        finally:
            torch.cuda.synchronize()
            elapsed = time.perf_counter() - start_time

            per_request_time = elapsed / max(len(group_request_ids), 1)

            with self._encoder_timing_lock:
                for req_id in group_request_ids:
                    if req_id not in self.encoder_timing_registry:
                        self.encoder_timing_registry[req_id] = EncoderTimingStats()

                    stats = self.encoder_timing_registry[req_id]
                    stats.encoder_forward_time += per_request_time
                    stats.num_encoder_calls += 1


@dataclass
class EncoderTimingStats:
    """Per-request timing statistics for encoder forward pass."""

    encoder_forward_time: float = 0.0
    """Time spent in vision encoder forward pass (seconds)."""

    num_encoder_calls: int = 0
    """Number of times encoder was called for this request."""

    def to_dict(self) -> dict[str, float | int]:
        return {
            "encoder_forward_time": self.encoder_forward_time,
            "num_encoder_calls": self.num_encoder_calls,
        }