"tests/vscode:/vscode.git/clone" did not exist on "6b2b9fd934af2bf59f749aa04ac739fd9c7d29f7"
gpu_model_runner.py 198 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3

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

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

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

144
145
146
147
148
149
150
151
152
from .utils import (
    AttentionGroup,
    MultiModalBudget,
    add_kv_sharing_layers_to_kv_cache_groups,
    bind_kv_cache,
    gather_mm_placeholders,
    sanity_check_mm_encoder_outputs,
    scatter_mm_placeholders,
)
153

154
if TYPE_CHECKING:
155
    from vllm.model_executor.model_loader.tensorizer import TensorizerConfig
156
    from vllm.v1.core.sched.output import SchedulerOutput
157
158
159

logger = init_logger(__name__)

160
161
AttnMetadataDict: TypeAlias = dict[str, AttentionMetadata]
# list when ubatching is enabled
162
PerLayerAttnMetadata: TypeAlias = list[AttnMetadataDict] | AttnMetadataDict
163

164

165
166
167
168
169
170
171
172
173
174
175
176
177
# Wrapper for ModelRunnerOutput to support overlapped execution.
class AsyncGPUModelRunnerOutput(AsyncModelRunnerOutput):
    def __init__(
        self,
        model_runner_output: ModelRunnerOutput,
        sampled_token_ids: torch.Tensor,
        invalid_req_indices: list[int],
        async_output_copy_stream: torch.cuda.Stream,
    ):
        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.
178
        self.async_copy_ready_event = torch.cuda.Event()
179
180
181
182
183
184
185
186
187

        # 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

        # 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)
188
            self.sampled_token_ids_cpu = self._sampled_token_ids.to(
189
190
                "cpu", non_blocking=True
            )
191
            self.async_copy_ready_event.record()
192
193
194

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

196
197
        This function blocks until the copy is finished.
        """
198
        self.async_copy_ready_event.synchronize()
199
200
201
202

        # Release the device tensor once the copy has completed
        del self._sampled_token_ids

203
        valid_sampled_token_ids = self.sampled_token_ids_cpu.tolist()
204
205
206
207
208
209
210
211
        for i in self._invalid_req_indices:
            valid_sampled_token_ids[i].clear()

        output = self._model_runner_output
        output.sampled_token_ids = valid_sampled_token_ids
        return output


212
class GPUModelRunner(LoRAModelRunnerMixin, KVConnectorModelRunnerMixin):
213
214
    def __init__(
        self,
215
        vllm_config: VllmConfig,
216
        device: torch.device,
217
    ):
218
219
220
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
221
        self.compilation_config = vllm_config.compilation_config
222
223
224
225
226
227
        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
228

229
        from vllm.model_executor.models.utils import set_cpu_offload_max_bytes
230
231

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

233
234
235
236
        model_config = self.model_config
        cache_config = self.cache_config
        scheduler_config = self.scheduler_config
        parallel_config = self.parallel_config
237
        self.device = device
238
239
        self.pin_memory = is_pin_memory_available()
        self.dtype = self.model_config.dtype
240
241
242
        self.kv_cache_dtype = kv_cache_dtype_str_to_dtype(
            cache_config.cache_dtype, self.model_config
        )
243

244
        self.is_pooling_model = model_config.runner_type == "pooling"
245
        self.enable_prompt_embeds = model_config.enable_prompt_embeds
246
        self.is_multimodal_raw_input_only_model = (
247
248
            model_config.is_multimodal_raw_input_only_model
        )
249
250
        # This will be overridden in load_model()
        self.is_multimodal_pruning_enabled = False
251
        self.max_model_len = model_config.max_model_len
252
        self.dcp_world_size = self.parallel_config.decode_context_parallel_size
253
        self.max_num_tokens = scheduler_config.max_num_batched_tokens
254
        self.max_num_reqs = scheduler_config.max_num_seqs
255

256
257
258
259
260
        # 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 = (
261
262
263
            self.parallel_config.distributed_executor_backend == "external_launcher"
            and len(get_pp_group().ranks) > 0
        )
264

265
        # Model-related.
266
        self.num_query_heads = model_config.get_num_attention_heads(parallel_config)
267
        self.hidden_size = model_config.get_hidden_size()
268
        self.attention_chunk_size = model_config.attention_chunk_size
269
270
        # Only relevant for models using ALiBi (e.g, MPT)
        self.use_alibi = check_use_alibi(model_config)
271

272
        self.cascade_attn_enabled = not self.model_config.disable_cascade_attn
273

274
        # Multi-modal data support
275
        self.mm_registry = MULTIMODAL_REGISTRY
276
        self.uses_mrope = model_config.uses_mrope
277
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
278
279
            model_config
        )
280

281
282
283
        if self.model_config.is_encoder_decoder:
            # Maximum length of the encoder input, only for encoder-decoder
            # models.
284
            self.max_encoder_len = scheduler_config.max_num_encoder_input_tokens
285
286
287
        else:
            self.max_encoder_len = 0

288
        # Sampler
289
        self.sampler = Sampler(logprobs_mode=self.model_config.logprobs_mode)
290

291
        self.eplb_state: EplbState | None = None
292
293
294
295
296
297
        """
        State of the expert parallelism load balancer.

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

298
        # Lazy initializations
299
        # self.model: nn.Module  # Set after load_model
300
        # Initialize in initialize_kv_cache
301
        self.kv_caches: list[torch.Tensor] = []
302
303
        # indexes: [kv_cache_group_id][attn_group]
        self.attn_groups: list[list[AttentionGroup]] = []
304
305
        # self.kv_cache_config: KVCacheConfig

306
307
        # mm_hash ->  encoder_output
        self.encoder_cache: dict[str, torch.Tensor] = {}
308

309
        self.use_aux_hidden_state_outputs = False
310
311
312
313
314
315
316
317
        # 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:
            if self.speculative_config.method == "ngram":
                self.drafter = NgramProposer(self.vllm_config)
            elif self.speculative_config.use_eagle():
318
                self.drafter = EagleProposer(self.vllm_config, self.device, self)  # type: ignore
319
320
321
322
                if self.speculative_config.method == "eagle3":
                    self.use_aux_hidden_state_outputs = True
            elif self.speculative_config.method == "medusa":
                self.drafter = MedusaProposer(
323
324
                    vllm_config=self.vllm_config, device=self.device
                )  # type: ignore
325
            else:
326
327
328
329
                raise ValueError(
                    "Unknown speculative decoding method: "
                    f"{self.speculative_config.method}"
                )
330
            self.rejection_sampler = RejectionSampler(self.sampler)
331

332
        # Request states.
333
        self.requests: dict[str, CachedRequestState] = {}
334
        self.comm_stream = torch.cuda.Stream()
335

336
337
338
339
340
341
342
343
344
        # 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.
345
        custom_logitsprocs = model_config.logits_processors
346
347
        self.input_batch = InputBatch(
            max_num_reqs=self.max_num_reqs,
348
349
350
            # 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),
351
352
353
            max_num_batched_tokens=self.max_num_tokens,
            device=self.device,
            pin_memory=self.pin_memory,
354
            vocab_size=self.model_config.get_vocab_size(),
355
            block_sizes=[self.cache_config.block_size],
356
            kernel_block_sizes=[self.cache_config.block_size],
357
            is_spec_decode=bool(self.vllm_config.speculative_config),
358
            logitsprocs=build_logitsprocs(
359
360
361
                self.vllm_config,
                self.device,
                self.pin_memory,
362
                self.is_pooling_model,
363
                custom_logitsprocs,
364
            ),
365
366
367
            # 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),
368
            is_pooling_model=self.is_pooling_model,
369
        )
370

371
        self.use_async_scheduling = self.scheduler_config.async_scheduling
372
373
374
375
376
377
378
379
380
        # 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.
        self.prepare_inputs_event: torch.cuda.Event | None = None
        if self.use_async_scheduling:
            self.async_output_copy_stream = torch.cuda.Stream()
            self.prepare_inputs_event = torch.cuda.Event()
381

382
        # self.cudagraph_batch_sizes sorts in ascending order.
383
384
385
386
        if (
            self.compilation_config.cudagraph_capture_sizes
            and self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
        ):
387
388
            self.cudagraph_batch_sizes = sorted(
                self.compilation_config.cudagraph_capture_sizes
389
            )
390

391
        # Cache the device properties.
392
        self._init_device_properties()
393

394
        # Persistent buffers for CUDA graphs.
395
396
397
398
399
        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
        )
400
        self.seq_lens = self._make_buffer(self.max_num_reqs, dtype=torch.int32)
401
402
403
404
        if self.dcp_world_size > 1:
            self.dcp_local_seq_lens = self._make_buffer(
                self.max_num_reqs, dtype=torch.int32
            )
405
406
407
        # 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.
408
409
410
411
412
413
414
        self.inputs_embeds = self._make_buffer(
            self.max_num_tokens, self.hidden_size, dtype=self.dtype, numpy=False
        )
        self.is_token_ids = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
        self.discard_request_indices = self._make_buffer(
            self.max_num_reqs, dtype=torch.int64
        )
415
416
        self.num_discarded_requests = 0

417
418
419
420
421
422
        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
        )
423

424
425
        # Only relevant for multimodal models
        if self.supports_mm_inputs:
426
            self.is_mm_embed = self._make_buffer(self.max_num_tokens, dtype=torch.bool)
427

428
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
429
        if self.uses_mrope:
Roger Wang's avatar
Roger Wang committed
430
431
432
433
            # 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
434
435
436
437
438
439

            # 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
440
            self.mrope_positions = self._make_buffer(
441
442
                (3, self.max_num_tokens + 1), dtype=torch.int64
            )
443

444
        # None in the first PP rank. The rest are set after load_model.
445
        self.intermediate_tensors: IntermediateTensors | None = None
446

447
        # OPTIMIZATION: Cache the tensors rather than creating them every step.
448
        # Keep in int64 to avoid overflow with long context
449
450
451
452
        self.arange_np = np.arange(
            max(self.max_num_reqs + 1, self.max_model_len, self.max_num_tokens),
            dtype=np.int64,
        )
453

454
455
456
457
458
        # 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] = {}
459
460
461
462
463
        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(
464
465
                self.max_num_tokens, dtype=torch.int32, device=self.device
            )
466

467
468
469
470
471
        self.uniform_decode_query_len = (
            1
            if not self.speculative_config
            else 1 + self.speculative_config.num_speculative_tokens
        )
472
473
474
475

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

476
477
478
479
480
481
482
483
484
        self.mm_budget = (
            MultiModalBudget(
                self.model_config,
                self.scheduler_config,
                self.mm_registry,
            )
            if self.supports_mm_inputs
            else None
        )
485

486
        self.reorder_batch_threshold: int | None = None
487

488
489
490
491
492
        # 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()

493
        # Cached outputs.
494
        self._draft_token_ids: list[list[int]] | torch.Tensor | None = None
495
496
497
498
499
        self.transfer_event = torch.cuda.Event()
        self.sampled_token_ids_pinned_cpu = torch.empty(
            (self.max_model_len, 1),
            dtype=torch.int64,
            device="cpu",
500
501
            pin_memory=self.pin_memory,
        )
502

503
504
505
506
    def reset_mm_cache(self) -> None:
        if self.mm_budget:
            self.mm_budget.reset_cache()

507
508
509
510
511
512
513
514
515
516
    def _get_positions(self, num_tokens: Any):
        if isinstance(num_tokens, int):
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, :num_tokens]
            return self.positions.gpu[:num_tokens]
        else:
            if self.uses_mrope:
                return self.mrope_positions.gpu[:, num_tokens]
            return self.positions.gpu[num_tokens]

517
    def _make_buffer(
518
        self, *size: int | torch.SymInt, dtype: torch.dtype, numpy: bool = True
519
520
521
522
523
524
525
526
    ) -> CpuGpuBuffer:
        return CpuGpuBuffer(
            *size,
            dtype=dtype,
            device=self.device,
            pin_memory=self.pin_memory,
            with_numpy=numpy,
        )
527

528
529
530
    def _init_model_kwargs(self, num_tokens: int):
        model_kwargs = dict[str, Any]()

531
        if not self.is_pooling_model:
532
533
            return model_kwargs

534
535
        num_reqs = self.input_batch.num_reqs
        pooling_params = self.input_batch.get_pooling_params()
536
537
538

        token_type_id_requests = dict[int, Any]()
        for i, param in enumerate(pooling_params):
539
540
541
542
543
            if (
                param.extra_kwargs is not None
                and (token_types := param.extra_kwargs.get("compressed_token_type_ids"))
                is not None
            ):
544
545
546
547
548
                token_type_id_requests[i] = token_types

        if len(token_type_id_requests) == 0:
            return model_kwargs

549
        seq_lens = self.seq_lens.gpu[:num_reqs]
550
551
552
553
554
555
556
557
        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(
558
559
            device=self.device
        )
560
561
        return model_kwargs

562
    def _may_reorder_batch(self, scheduler_output: "SchedulerOutput") -> None:
563
564
        """
        Update the order of requests in the batch based on the attention
565
        backend's needs. For example, some attention backends (namely MLA) may
566
567
568
569
570
571
        want to separate requests based on if the attention computation will be
        compute-bound or memory-bound.

        Args:
            scheduler_output: The scheduler output.
        """
572
573
574
575
576
577
578
579
        # 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

580
        if self.reorder_batch_threshold is not None:
581
582
583
            # NOTE(lucas): currently no backend supports the custom masking
            #  required for DCP with q_len > 1, so we assert here. Remove this
            #  assert once the custom mask is support is added to FA3.
584
585
586
587
            if (
                self.dcp_world_size > 1
                and envs.VLLM_ATTENTION_BACKEND != "FLASH_ATTN_MLA"
            ):
588
                assert self.reorder_batch_threshold == 1, (
589
                    "DCP not support reorder_batch_threshold > 1 now."
590
                )
591
592
593
            reorder_batch_to_split_decodes_and_prefills(
                self.input_batch,
                scheduler_output,
594
595
                decode_threshold=self.reorder_batch_threshold,
            )
596

597
598
    # Note: used for model runner override.
    def _init_device_properties(self) -> None:
599
        """Initialize attributes from torch.cuda.get_device_properties"""
600
601
602
603
604
605
606
        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()

607
    def _update_states(self, scheduler_output: "SchedulerOutput") -> None:
608
609
610
611
612
613
        """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.

614
615
        The SamplingMetadata is updated and copied to the GPU if there is a
        new/resumed/paused/finished request in the batch.
616
617
        """
        # Remove finished requests from the cached states.
618
619
        for req_id in scheduler_output.finished_req_ids:
            self.requests.pop(req_id, None)
620
621
622
623
624
625
626
        # 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:
627
            self.input_batch.remove_request(req_id)
628
629

        # Free the cached encoder outputs.
630
631
        for mm_hash in scheduler_output.free_encoder_mm_hashes:
            self.encoder_cache.pop(mm_hash, None)
632

633
634
635
636
637
638
639
640
641
642
643
644
645
        # Remove the unscheduled requests from the persistent batch.
        # NOTE(woosuk): The unscheduled requests are either preempted requests
        # or running requests that are not scheduled in this step. We remove
        # them from the persistent batch but keep their cached states since
        # they will be scheduled again sometime in the future.
        scheduled_req_ids = scheduler_output.num_scheduled_tokens.keys()
        cached_req_ids = self.input_batch.req_id_to_index.keys()
        unscheduled_req_ids = cached_req_ids - scheduled_req_ids
        # NOTE(woosuk): The persistent batch optimization assumes that
        # consecutive batches contain mostly the same requests. If batches
        # have low request overlap (e.g., alternating between two distinct
        # sets of requests), this optimization becomes very inefficient.
        for req_id in unscheduled_req_ids:
646
            self.input_batch.remove_request(req_id)
647

648
        reqs_to_add: list[CachedRequestState] = []
649
        # Add new requests to the cached states.
650
651
652
        for new_req_data in scheduler_output.scheduled_new_reqs:
            req_id = new_req_data.req_id
            sampling_params = new_req_data.sampling_params
653
            pooling_params = new_req_data.pooling_params
654

655
656
657
658
            if (
                sampling_params
                and sampling_params.sampling_type == SamplingType.RANDOM_SEED
            ):
659
660
661
662
663
                generator = torch.Generator(device=self.device)
                generator.manual_seed(sampling_params.seed)
            else:
                generator = None

664
665
            if self.is_pooling_model:
                assert pooling_params is not None
666
667
                task = pooling_params.task
                assert task is not None, "You did not set `task` in the API"
668

669
                model = cast(VllmModelForPooling, self.get_model())
670
                to_update = model.pooler.get_pooling_updates(task)
671
672
                to_update.apply(pooling_params)

673
            req_state = CachedRequestState(
674
                req_id=req_id,
675
                prompt_token_ids=new_req_data.prompt_token_ids,
676
                prompt_embeds=new_req_data.prompt_embeds,
677
                mm_features=new_req_data.mm_features,
678
                sampling_params=sampling_params,
679
                pooling_params=pooling_params,
680
                generator=generator,
681
682
                block_ids=new_req_data.block_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
683
                output_token_ids=[],
684
                lora_request=new_req_data.lora_request,
685
            )
686
687
            self.requests[req_id] = req_state

688
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
689
            if self.uses_mrope:
690
                self._init_mrope_positions(req_state)
691

692
            reqs_to_add.append(req_state)
693

694
        # Update the states of the running/resumed requests.
695
        is_last_rank = get_pp_group().is_last_rank
696
697
        req_data = scheduler_output.scheduled_cached_reqs
        for i, req_id in enumerate(req_data.req_ids):
698
            req_state = self.requests[req_id]
699
700
701
            num_computed_tokens = req_data.num_computed_tokens[i]
            new_block_ids = req_data.new_block_ids[i]
            resumed_from_preemption = req_data.resumed_from_preemption[i]
702
            num_output_tokens = req_data.num_output_tokens[i]
703

704
            # Update the cached states.
705

706
            req_state.num_computed_tokens = num_computed_tokens
707
            req_index = self.input_batch.req_id_to_index.get(req_id)
708
709
710
711
712
713
714
715

            if not is_last_rank:
                # When using PP, the scheduler sends the sampled tokens back,
                # because there's no direct communication between the first-
                # stage worker and the last-stage worker.
                new_token_ids = req_data.new_token_ids[i]
                # Add the sampled token(s) from the previous step (if any).
                # This doesn't include "unverified" tokens like spec tokens.
716
717
718
                num_new_tokens = (
                    num_computed_tokens + len(new_token_ids) - req_state.num_tokens
                )
719
720
721
722
                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:
723
                    req_state.output_token_ids.extend(new_token_ids[-num_new_tokens:])
724
725
726
727
728
            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:
729
730
731
732
                    end_idx = (
                        self.input_batch.num_prompt_tokens[req_index]
                        + num_output_tokens
                    )
733
734
                    self.input_batch.num_tokens[req_index] = end_idx
                    self.input_batch.num_tokens_no_spec[req_index] = end_idx
735

736
            # Update the block IDs.
737
            if not resumed_from_preemption:
738
739
                if new_block_ids is not None:
                    # Append the new blocks to the existing block IDs.
740
                    for block_ids, new_ids in zip(req_state.block_ids, new_block_ids):
741
                        block_ids.extend(new_ids)
742
            else:
743
                assert req_index is None
744
                assert new_block_ids is not None
745
746
                # The request is resumed from preemption.
                # Replace the existing block IDs with the new ones.
747
                req_state.block_ids = new_block_ids
748

749
750
751
752
753
754
                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.resumed_req_token_ids[i]
                    assert resumed_token_ids is not None
                    req_state.output_token_ids = resumed_token_ids[-num_output_tokens:]
755
756
757
758
            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.
759
                reqs_to_add.append(req_state)
760
761
762
                continue

            # Update the persistent batch.
763
            self.input_batch.num_computed_tokens_cpu[req_index] = num_computed_tokens
764
            if new_block_ids is not None:
765
                self.input_batch.block_table.append_row(new_block_ids, req_index)
766
767
768
769
770
771
772

            # 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)
773
                self.input_batch.token_ids_cpu[
774
775
776
                    req_index, start_token_index:end_token_index
                ] = new_token_ids
                self.input_batch.num_tokens_no_spec[req_index] = end_token_index
777
                self.input_batch.num_tokens[req_index] = end_token_index
778

779
            # Add spec_token_ids to token_ids_cpu.
780
            spec_token_ids = scheduler_output.scheduled_spec_decode_tokens.get(
781
                req_id, []
782
            )
783
784
785
786
787
            if spec_token_ids:
                num_spec_tokens = len(spec_token_ids)
                start_index = self.input_batch.num_tokens_no_spec[req_index]
                end_token_index = start_index + num_spec_tokens
                self.input_batch.token_ids_cpu[
788
789
                    req_index, start_index:end_token_index
                ] = spec_token_ids
790
791
                # NOTE(woosuk): `num_tokens` here may include spec tokens.
                self.input_batch.num_tokens[req_index] += num_spec_tokens
792
793
794
795
796
797
798

            # When speculative decoding is used with structured output,
            # the scheduler can drop draft tokens that do not
            # conform to the schema. This can result in
            # scheduler_output.scheduled_spec_decode_tokens being empty,
            # even when speculative decoding is enabled.
            self.input_batch.spec_token_ids[req_index] = spec_token_ids
799

800
801
        # Add the new or resumed requests to the persistent batch.
        # The smaller empty indices are filled first.
802
803
        for request in reqs_to_add:
            self.input_batch.add_request(request)
804

805
806
807
808
809
810
        # 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()
811

812
    def _update_states_after_model_execute(
813
814
        self, output_token_ids: torch.Tensor
    ) -> None:
815
816
817
818
819
820
821
822
823
824
825
826
        """Update the cached states after model execution.

        This is used for MTP/EAGLE for hybrid models, as in linear attention,
        only the last token's state is kept. In MTP/EAGLE, for draft tokens
        the state are kept util we decide how many tokens are accepted for
        each sequence, and a shifting is done during the next iteration
        based on the number of accepted tokens.
        """
        if not self.model_config.is_hybrid or not self.speculative_config:
            return

        # Find the number of accepted tokens for each sequence.
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
        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()
        )
847
848
849
        for i, num_tokens in enumerate(num_accepted_tokens):
            self.input_batch.num_accepted_tokens_cpu[i] = num_tokens

850
851
852
853
854
855
    def _init_mrope_positions(self, req_state: CachedRequestState):
        image_grid_thw = []
        video_grid_thw = []
        second_per_grid_ts = []
        audio_feature_lengths = []
        use_audio_in_video = False
856
857
858
859
        for mm_feature in req_state.mm_features:
            mm_item = mm_feature.data
            if mm_item is None:
                continue
860
861
862
863
864
865
866
867
868
869
870
871
            mm_input = mm_item.get_data()
            if (t := mm_input.get("image_grid_thw")) is not None:
                image_grid_thw.append(t.tolist())
            if (t := mm_input.get("video_grid_thw")) is not None:
                video_grid_thw.append(t.tolist())
            if (t := mm_input.get("second_per_grid_ts")) is not None:
                second_per_grid_ts.append(t)
            if (t := mm_input.get("audio_feature_lengths")) is not None:
                audio_feature_lengths.append(t)
            if mm_input.get("use_audio_in_video") is True:
                use_audio_in_video = True

872
873
874
875
876
877
878
879
880
881
882
        assert supports_mrope(self.get_model()), "M-RoPE support is not implemented."

        req_state.mrope_positions, req_state.mrope_position_delta = (
            self.model.get_mrope_input_positions(
                req_state.prompt_token_ids,
                hf_config=self.model_config.hf_config,
                image_grid_thw=image_grid_thw,
                video_grid_thw=video_grid_thw,
                second_per_grid_ts=second_per_grid_ts,
                audio_feature_lengths=audio_feature_lengths,
                use_audio_in_video=use_audio_in_video,
883
            )
884
        )
885

886
    def _extract_mm_kwargs(
887
        self,
888
889
        scheduler_output: "SchedulerOutput",
    ) -> BatchedTensorInputs:
890
        if not scheduler_output or not self.is_multimodal_raw_input_only_model:
891
            return {}
892

893
894
        mm_kwargs = list[MultiModalKwargsItem]()
        for req in scheduler_output.scheduled_new_reqs:
895
896
897
            for feature in req.mm_features:
                if feature.data is not None:
                    mm_kwargs.append(feature.data)
898

899
        # Input all modalities at once
900
        model = cast(SupportsMultiModal, self.model)
901
902
        mm_kwargs_combined: BatchedTensorInputs = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
903
904
905
906
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
907
908
        ):
            mm_kwargs_combined.update(mm_kwargs_group)
909

910
        return mm_kwargs_combined
911

912
    def _dummy_mm_kwargs(self, num_seqs: int) -> BatchedTensorInputs:
913
        if not self.is_multimodal_raw_input_only_model:
914
            return {}
915

916
917
918
919
920
        mm_budget = self.mm_budget
        assert mm_budget is not None

        dummy_modality = mm_budget.get_modality_with_max_tokens()
        return self._get_mm_dummy_batch(dummy_modality, num_seqs)
921

922
923
924
    def _get_cumsum_and_arange(
        self,
        num_tokens: np.ndarray,
925
        cumsum_dtype: np.dtype | None = None,
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
    ) -> 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

942
943
944
    def _prepare_input_ids(
        self, total_num_scheduled_tokens: int, cu_num_tokens: np.ndarray
    ) -> None:
945
        """Prepare the input IDs for the current batch.
946

947
948
949
950
951
952
953
        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)
954
955
956
            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)
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
            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
        flattened_indices = []
        prev_common_req_indices = []
        indices_match = True
        max_flattened_index = -1
        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.
                flattened_index = cu_num_tokens[cur_index].item() - 1
                flattened_indices.append(flattened_index)
975
                indices_match &= prev_index == flattened_index
976
977
978
979
980
981
                max_flattened_index = max(max_flattened_index, flattened_index)
        num_commmon_tokens = len(flattened_indices)
        if num_commmon_tokens < total_num_scheduled_tokens:
            # 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)
982
983
984
            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)
985
986
        if num_commmon_tokens == 0:
            # No requests in common with the previous iteration
987
            # So input_ids.cpu will have all the input ids.
988
989
990
991
992
993
994
            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_(
995
996
997
                self.input_batch.prev_sampled_token_ids[:num_commmon_tokens, 0],
                non_blocking=True,
            )
998
999
            if self.enable_prompt_embeds:
                self.is_token_ids.gpu[:num_commmon_tokens] = True
1000
            return
1001
        # Upload the index tensors asynchronously so the scatter can be non-blocking.
1002
1003
1004
        input_ids_index_tensor = torch.tensor(
            flattened_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1005
        prev_common_req_indices_tensor = torch.tensor(
1006
1007
            prev_common_req_indices, dtype=torch.int64, pin_memory=self.pin_memory
        ).to(self.device, non_blocking=True)
1008
1009
1010
1011
        self.input_ids.gpu.scatter_(
            dim=0,
            index=input_ids_index_tensor,
            src=self.input_batch.prev_sampled_token_ids[
1012
1013
1014
                prev_common_req_indices_tensor, 0
            ],
        )
1015

1016
1017
1018
1019
1020
    def _get_encoder_seq_lens(
        self,
        scheduler_output: "SchedulerOutput",
        kv_cache_spec: KVCacheSpec,
        num_reqs: int,
1021
    ) -> np.ndarray | None:
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
        if not isinstance(kv_cache_spec, CrossAttentionSpec):
            return None

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

        return encoder_seq_lens

1034
    def _prepare_inputs(
1035
        self, scheduler_output: "SchedulerOutput"
1036
1037
1038
    ) -> tuple[
        PerLayerAttnMetadata,
        torch.Tensor,
1039
        SpecDecodeMetadata | None,
1040
        np.ndarray,
1041
        CommonAttentionMetadata | None,
1042
        int,
1043
1044
        UBatchSlices | None,
        torch.Tensor | None,
1045
1046
        bool,
    ]:
1047
1048
1049
        """
        :return: tuple[
            attn_metadata: layer-to-attention_metadata mapping,
1050
1051
1052
            logits_indices, spec_decode_metadata,
            num_scheduled_tokens, spec_decode_common_attn_metadata,
            max_num_scheduled_tokens, use_cascade_attn
1053
1054
        ]
        """
1055
1056
1057
1058
1059
1060
1061
        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.
1062
        self.input_batch.block_table.commit_block_table(num_reqs)
1063
1064

        # Get the number of scheduled tokens for each request.
1065
1066
1067
1068
        req_ids = self.input_batch.req_ids
        tokens = [scheduler_output.num_scheduled_tokens[i] for i in req_ids]
        num_scheduled_tokens = np.array(tokens, dtype=np.int32)
        max_num_scheduled_tokens = max(tokens)
1069
1070
1071

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

1074
1075
        # cu_num_tokens: [2, 5, 3] -> [2, 7, 10]
        # arange: [0, 1, 0, 1, 2, 3, 4, 0, 1, 2]
1076
        cu_num_tokens, arange = self._get_cumsum_and_arange(num_scheduled_tokens)
1077
1078

        # Get positions.
1079
        positions_np = self.positions.np[:total_num_scheduled_tokens]
1080
1081
1082
1083
1084
        np.add(
            self.input_batch.num_computed_tokens_cpu[req_indices],
            arange,
            out=positions_np,
        )
1085

1086
1087
        # Calculate M-RoPE positions.
        # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1088
        if self.uses_mrope:
1089
1090
            self._calc_mrope_positions(scheduler_output)

1091
1092
1093
1094
        # 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.
1095
1096
1097
        token_indices = (
            positions_np + req_indices * self.input_batch.token_ids_cpu.shape[1]
        )
1098
        token_indices_tensor = torch.from_numpy(token_indices)
1099

1100
1101
1102
        # 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.
1103
1104
1105
1106
1107
1108
        torch.index_select(
            self.input_batch.token_ids_cpu_tensor.flatten(),
            0,
            token_indices_tensor,
            out=self.input_ids.cpu[:total_num_scheduled_tokens],
        )
1109
1110
1111
1112
1113
1114
        if self.enable_prompt_embeds:
            is_token_ids = self.input_batch.is_token_ids.flatten()
            torch.index_select(
                is_token_ids,
                0,
                token_indices_tensor,
1115
1116
                out=self.is_token_ids.cpu[:total_num_scheduled_tokens],
            )
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149

        # 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:
1150
1151
1152
                    self.inputs_embeds.cpu[
                        output_idx : output_idx + actual_num_sched
                    ].copy_(req_embeds[start_pos:actual_end])
1153
1154

                output_idx += num_sched
1155

1156
1157
        self.input_batch.block_table.compute_slot_mapping(req_indices, positions_np)
        self.input_batch.block_table.commit_slot_mapping(total_num_scheduled_tokens)
1158
1159

        # Prepare the attention metadata.
1160
        self.query_start_loc.np[0] = 0
1161
        self.query_start_loc.np[1 : num_reqs + 1] = cu_num_tokens
1162
1163
        # Note: pad query_start_loc to be non-decreasing, as kernels
        # like FlashAttention requires that
1164
        self.query_start_loc.np[num_reqs + 1 :].fill(cu_num_tokens[-1])
1165
        self.query_start_loc.copy_to_gpu()
1166
        query_start_loc = self.query_start_loc.gpu[: num_reqs + 1]
1167

1168
        num_tokens_unpadded = scheduler_output.total_num_scheduled_tokens
1169
        num_tokens_padded = self._get_num_input_tokens(num_tokens_unpadded)
1170
1171
1172
        uniform_decode = (
            max_num_scheduled_tokens == self.uniform_decode_query_len
        ) and (total_num_scheduled_tokens == num_reqs * max_num_scheduled_tokens)
1173
1174
1175
1176
1177
1178
1179

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

1180
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
1181
1182
1183
1184
1185
1186
1187
            num_tokens_unpadded=num_tokens_unpadded,
            parallel_config=self.parallel_config,
            allow_microbatching=True,
            allow_dp_padding=allow_dp_padding,
            num_tokens_padded=num_tokens_padded,
            uniform_decode=uniform_decode,
            num_scheduled_tokens_per_request=num_scheduled_tokens,
1188
        )
1189

1190
        self.seq_lens.np[:num_reqs] = (
1191
1192
            self.input_batch.num_computed_tokens_cpu[:num_reqs] + num_scheduled_tokens
        )
1193
        # Fill unused with 0 for full cuda graph mode.
1194
1195
1196
1197
        self.seq_lens.np[num_reqs:].fill(0)
        self.seq_lens.copy_to_gpu()
        seq_lens = self.seq_lens.gpu[:num_reqs]
        max_seq_len = self.seq_lens.np[:num_reqs].max().item()
1198

1199
        num_tokens = [self.requests[r].num_tokens for r in self.input_batch.req_ids]
1200
1201
1202
1203
1204
1205
1206
        num_tokens_np = np.array(num_tokens, dtype=np.int32)

        # Record the index of requests that should not be sampled,
        # so that we could clear the sampled tokens before returning
        discard_requests_mask = self.seq_lens.np[:num_reqs] < num_tokens_np
        discard_request_indices = np.nonzero(discard_requests_mask)[0]
        self.num_discarded_requests = len(discard_request_indices)
1207
1208
1209
        self.discard_request_indices.np[: self.num_discarded_requests] = (
            discard_request_indices
        )
1210
1211
1212

        self.discard_request_indices.copy_to_gpu(self.num_discarded_requests)

1213
        # Copy the tensors to the GPU.
1214
1215
        self._prepare_input_ids(total_num_scheduled_tokens, cu_num_tokens)

1216
        if self.uses_mrope:
1217
            # Only relevant for models using M-RoPE (e.g, Qwen2-VL)
1218
1219
            self.mrope_positions.gpu[:, :total_num_scheduled_tokens].copy_(
                self.mrope_positions.cpu[:, :total_num_scheduled_tokens],
1220
1221
                non_blocking=True,
            )
1222
1223
        else:
            # Common case (1D positions)
1224
            self.positions.copy_to_gpu(total_num_scheduled_tokens)
1225

1226
        use_spec_decode = len(scheduler_output.scheduled_spec_decode_tokens) > 0
1227
1228
1229
1230
1231
1232
1233
        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
1234
            num_draft_tokens = None
1235
1236
1237
1238
1239
1240
            spec_decode_metadata = None
        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)
1241
1242
1243
            # 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)
1244
1245
1246
1247
            for (
                req_id,
                draft_token_ids,
            ) in scheduler_output.scheduled_spec_decode_tokens.items():
1248
1249
                req_idx = self.input_batch.req_id_to_index[req_id]
                num_draft_tokens[req_idx] = len(draft_token_ids)
1250
1251
1252
1253
1254
1255
1256
1257
                num_decode_draft_tokens[req_idx] = (
                    len(draft_token_ids)
                    if (
                        self.input_batch.num_computed_tokens_cpu[req_idx]
                        >= self.input_batch.num_prompt_tokens[req_idx]
                    )
                    else -1
                )
1258
            spec_decode_metadata = self._calc_spec_decode_metadata(
1259
1260
                num_draft_tokens, cu_num_tokens
            )
1261
            logits_indices = spec_decode_metadata.logits_indices
1262
1263

            # For DECODE only cuda graph of some attention backends (e.g., GDN).
1264
            self.num_decode_draft_tokens.np[:num_reqs] = num_decode_draft_tokens
1265
1266
            self.num_decode_draft_tokens.np[num_reqs:].fill(-1)
            self.num_decode_draft_tokens.copy_to_gpu()
1267
1268
1269

        logits_indices_padded = None
        if self.cache_config.kv_sharing_fast_prefill:
1270
            logits_indices_padded = self._prepare_kv_sharing_fast_prefill(
1271
1272
                logits_indices
            )
1273

1274
1275
1276
        attn_metadata: PerLayerAttnMetadata = {}
        if ubatch_slices is not None:
            attn_metadata = [dict() for _ in range(len(ubatch_slices))]
1277
        use_cascade_attn = False
1278

1279
        # Used in the below loop.
1280
        query_start_loc_cpu = self.query_start_loc.cpu[: num_reqs + 1]
1281
        seq_lens_cpu = self.seq_lens.cpu[:num_reqs]
1282
1283
1284
        num_computed_tokens_cpu = self.input_batch.num_computed_tokens_cpu_tensor[
            :num_reqs
        ]
1285
        spec_decode_common_attn_metadata = None
1286
1287
        if use_spec_decode:
            self.num_accepted_tokens.np[:num_reqs] = (
1288
1289
                self.input_batch.num_accepted_tokens_cpu[:num_reqs]
            )
1290
1291
            self.num_accepted_tokens.np[num_reqs:].fill(1)
            self.num_accepted_tokens.copy_to_gpu()
1292

1293
1294
1295
        # Prepare the attention metadata for each KV cache group and make layers
        # in the same group share the same metadata.
        for kv_cache_group_id, kv_cache_group_spec in enumerate(
1296
1297
            self.kv_cache_config.kv_cache_groups
        ):
1298
            encoder_seq_lens = self._get_encoder_seq_lens(
1299
1300
                scheduler_output, kv_cache_group_spec.kv_cache_spec, num_reqs
            )
1301

1302
            if isinstance(kv_cache_group_spec.kv_cache_spec, EncoderOnlyAttentionSpec):
1303
1304
1305
1306
1307
                # Encoder-only layers do not have KV cache, so we need to
                # create a dummy block table and slot mapping for them.
                blk_table_tensor = torch.zeros(
                    (num_reqs, 1),
                    dtype=torch.int32,
1308
1309
1310
                    device=self.device,
                )
                slot_mapping = torch.zeros(
1311
                    (total_num_scheduled_tokens,),
1312
1313
1314
                    dtype=torch.int64,
                    device=self.device,
                )
1315
1316
1317
                num_common_prefix_blocks = 0
            else:
                blk_table = self.input_batch.block_table[kv_cache_group_id]
1318
                blk_table_tensor = blk_table.get_device_tensor(num_reqs)
1319
                slot_mapping = blk_table.slot_mapping.gpu[:total_num_scheduled_tokens]
1320
1321
1322

                # Fill unused with -1. Needed for reshape_and_cache in full cuda
                # graph mode.
1323
1324
1325
1326
                blk_table.slot_mapping.gpu[total_num_scheduled_tokens:].fill_(-1)
                num_common_prefix_blocks = scheduler_output.num_common_prefix_blocks[
                    kv_cache_group_id
                ]
1327

1328
            common_attn_metadata = CommonAttentionMetadata(
1329
1330
1331
1332
1333
                query_start_loc=query_start_loc,
                query_start_loc_cpu=query_start_loc_cpu,
                seq_lens=seq_lens,
                seq_lens_cpu=seq_lens_cpu,
                num_computed_tokens_cpu=num_computed_tokens_cpu,
1334
1335
1336
                num_reqs=num_reqs,
                num_actual_tokens=total_num_scheduled_tokens,
                max_query_len=max_num_scheduled_tokens,
1337
                max_seq_len=max_seq_len,
1338
1339
                block_table_tensor=blk_table_tensor,
                slot_mapping=slot_mapping,
1340
1341
                logits_indices_padded=logits_indices_padded,
                num_logits_indices=logits_indices.size(0),
1342
                causal=True,
1343
                encoder_seq_lens=encoder_seq_lens,
1344
1345
1346
                dcp_local_seq_lens=self.dcp_local_seq_lens.gpu[:num_reqs]
                if self.dcp_world_size > 1
                else None,
1347
1348
            )

1349
            if self.speculative_config and spec_decode_common_attn_metadata is None:
1350
                if isinstance(self.drafter, EagleProposer):
1351
1352
1353
1354
                    if (
                        self.drafter.attn_layer_names[0]
                        in kv_cache_group_spec.layer_names
                    ):
1355
1356
1357
                        spec_decode_common_attn_metadata = common_attn_metadata
                else:
                    spec_decode_common_attn_metadata = common_attn_metadata
1358

1359
1360
1361
            for attn_group in self.attn_groups[kv_cache_group_id]:
                # Prepare for cascade attention if enabled & beneficial.
                common_prefix_len = 0
1362
                builder = attn_group.get_metadata_builder()
1363
1364
1365
                if self.cascade_attn_enabled:
                    common_prefix_len = self._compute_cascade_attn_prefix_len(
                        num_scheduled_tokens,
1366
                        num_common_prefix_blocks,
1367
                        attn_group.kv_cache_spec,
1368
1369
                        builder,
                    )
1370

1371
                extra_attn_metadata_args = {}
1372
                if use_spec_decode and isinstance(builder, GDNAttentionMetadataBuilder):
1373
                    extra_attn_metadata_args = dict(
1374
1375
1376
1377
                        num_accepted_tokens=self.num_accepted_tokens.gpu[:num_reqs],
                        num_decode_draft_tokens_cpu=self.num_decode_draft_tokens.cpu[
                            :num_reqs
                        ],
1378
1379
                    )

1380
1381
                if ubatch_slices is not None:
                    common_attn_metadata_list = split_attn_metadata(
1382
1383
                        ubatch_slices, common_attn_metadata
                    )
1384
                    for ubid, common_attn_metadata in enumerate(
1385
1386
1387
1388
1389
1390
1391
1392
                        common_attn_metadata_list
                    ):
                        attn_metadata_i = attn_group.get_metadata_builder(
                            ubatch_id=ubid
                        ).build(
                            common_prefix_len=common_prefix_len,
                            common_attn_metadata=common_attn_metadata,
                        )
1393
1394
1395
1396
1397
1398
1399
1400
                        for layer_name in kv_cache_group_spec.layer_names:
                            assert type(attn_metadata) is list
                            attn_metadata[ubid][layer_name] = attn_metadata_i
                else:
                    assert isinstance(attn_metadata, dict)
                    attn_metadata_i = builder.build(
                        common_prefix_len=common_prefix_len,
                        common_attn_metadata=common_attn_metadata,
1401
1402
1403
                        **extra_attn_metadata_args,
                    )
                    use_cascade_attn |= getattr(attn_metadata_i, "use_cascade", False)
1404
1405
                    for layer_name in attn_group.layer_names:
                        attn_metadata[layer_name] = attn_metadata_i
1406

1407
1408
1409
1410
        # disable cascade attention when DBO
        if ubatch_slices is not None:
            use_cascade_attn = False

1411
1412
1413
1414
        # Hot-Swap lora model
        if self.lora_config:
            self.set_active_loras(self.input_batch, num_scheduled_tokens)

1415
1416
1417
1418
1419
1420
1421
1422
        return (
            attn_metadata,
            logits_indices,
            spec_decode_metadata,
            num_scheduled_tokens,
            spec_decode_common_attn_metadata,
            max_num_scheduled_tokens,
            ubatch_slices,
1423
            num_tokens_across_dp,
1424
1425
            use_cascade_attn,
        )
1426

1427
1428
1429
1430
    def _compute_cascade_attn_prefix_len(
        self,
        num_scheduled_tokens: np.ndarray,
        num_common_prefix_blocks: int,
1431
1432
        kv_cache_spec: KVCacheSpec,
        attn_metadata_builder: AttentionMetadataBuilder,
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
    ) -> 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.
        """
1451
        common_prefix_len = num_common_prefix_blocks * kv_cache_spec.block_size
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
        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]
1489
        # Request 3's num_computed_tokens: 3 (i.e., [A, B, C])
1490
1491
1492
1493
1494
1495
1496
        # If we use [A, B, C, D] as the common prefix for Request 1-3,
        # then Request 3 will be processed only by the first kernel,
        # and the second kernel will get an empty input. While this is not
        # a fundamental problem, our current implementation does not support
        # this case.
        num_reqs = len(num_scheduled_tokens)
        common_prefix_len = min(
1497
1498
            common_prefix_len, self.input_batch.num_computed_tokens_cpu[:num_reqs].min()
        )
1499
        # common_prefix_len should be a multiple of the block size.
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
        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
        )
1511
1512
        assert isinstance(kv_cache_spec, AttentionSpec)
        use_cascade = attn_metadata_builder.use_cascade_attention(
1513
1514
1515
            common_prefix_len=common_prefix_len,
            query_lens=num_scheduled_tokens,
            num_query_heads=self.num_query_heads,
1516
            num_kv_heads=kv_cache_spec.num_kv_heads,
1517
            use_alibi=self.use_alibi,
1518
            use_sliding_window=use_sliding_window,
1519
            use_local_attention=use_local_attention,
1520
            num_sms=self.num_sms,
1521
            dcp_world_size=self.dcp_world_size,
1522
1523
1524
        )
        return common_prefix_len if use_cascade else 0

1525
1526
    def _calc_mrope_positions(self, scheduler_output: "SchedulerOutput"):
        mrope_pos_ptr = 0
1527
        for index, req_id in enumerate(self.input_batch.req_ids):
1528
1529
1530
            req = self.requests[req_id]
            assert req.mrope_positions is not None

1531
1532
            num_computed_tokens = self.input_batch.num_computed_tokens_cpu[index]
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1533
            num_prompt_tokens = length_from_prompt_token_ids_or_embeds(
1534
1535
                req.prompt_token_ids, req.prompt_embeds
            )
1536
1537

            if num_computed_tokens + num_scheduled_tokens > num_prompt_tokens:
1538
1539
                prompt_part_len = max(0, num_prompt_tokens - num_computed_tokens)
                completion_part_len = max(0, num_scheduled_tokens - prompt_part_len)
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
            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

1553
1554
1555
                self.mrope_positions.cpu[:, dst_start:dst_end] = req.mrope_positions[
                    :, src_start:src_end
                ]
1556
1557
1558
1559
1560
1561
1562
                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

1563
                MRotaryEmbedding.get_next_input_positions_tensor(
1564
                    out=self.mrope_positions.np,
1565
1566
1567
1568
1569
                    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,
                )
1570
1571
1572

                mrope_pos_ptr += completion_part_len

1573
1574
    def _calc_spec_decode_metadata(
        self,
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
        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
1591
1592
1593
1594

        # 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(
1595
1596
            num_sampled_tokens, cumsum_dtype=np.int32
        )
1597
        # Step 2. [0, 0, 0, 0, 103, 104, 104, 104, 206, 207, 207]
1598
        logits_indices = np.repeat(
1599
1600
            cu_num_scheduled_tokens - num_sampled_tokens, num_sampled_tokens
        )
1601
        # Step 3. [0, 1, 2, 3, 103, 104, 105, 106, 206, 207, 208]
1602
1603
1604
1605
1606
1607
        logits_indices += arange

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

        # Compute the draft logits indices.
1608
1609
1610
        # 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(
1611
1612
            num_draft_tokens, cumsum_dtype=np.int32
        )
1613
1614
        # [0, 0, 0, 5, 5, 9]
        target_logits_indices = np.repeat(
1615
1616
            cu_num_sampled_tokens - num_sampled_tokens, num_draft_tokens
        )
1617
1618
1619
1620
1621
        # [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(
1622
1623
            self.device, non_blocking=True
        )
1624
1625
1626
        cu_num_sampled_tokens = torch.from_numpy(cu_num_sampled_tokens).to(
            self.device, non_blocking=True
        )
1627
1628
1629
        logits_indices = torch.from_numpy(logits_indices).to(
            self.device, non_blocking=True
        )
1630
        target_logits_indices = torch.from_numpy(target_logits_indices).to(
1631
1632
            self.device, non_blocking=True
        )
1633
        bonus_logits_indices = torch.from_numpy(bonus_logits_indices).to(
1634
1635
            self.device, non_blocking=True
        )
1636

1637
1638
        # Compute the draft token ids.
        # draft_token_indices:      [  1,   2,   3, 105, 106, 208]
1639
        draft_token_ids = self.input_ids.gpu[logits_indices]
1640
1641
        draft_token_ids = draft_token_ids[target_logits_indices + 1]

1642
        return SpecDecodeMetadata(
1643
1644
1645
            draft_token_ids=draft_token_ids,
            num_draft_tokens=num_draft_tokens.tolist(),
            cu_num_draft_tokens=cu_num_draft_tokens,
1646
            cu_num_sampled_tokens=cu_num_sampled_tokens,
1647
1648
1649
1650
1651
            target_logits_indices=target_logits_indices,
            bonus_logits_indices=bonus_logits_indices,
            logits_indices=logits_indices,
        )

1652
1653
1654
1655
1656
1657
1658
    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
1659
        self.kv_sharing_fast_prefill_logits_indices[:num_logits].copy_(logits_indices)
1660
1661
1662
1663
1664
        # 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_(
1665
1666
1667
1668
1669
1670
            logits_indices[-1].item()
        )
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and num_logits <= self.cudagraph_batch_sizes[-1]
        ):
1671
1672
1673
1674
1675
            # Use piecewise CUDA graphs.
            # Add padding to the batch size.
            num_logits_padded = self.vllm_config.pad_for_cudagraph(num_logits)
        else:
            num_logits_padded = num_logits
1676
1677
1678
        logits_indices_padded = self.kv_sharing_fast_prefill_logits_indices[
            :num_logits_padded
        ]
1679
1680
        return logits_indices_padded

1681
1682
1683
1684
1685
1686
1687
1688
    def _batch_mm_kwargs_from_scheduler(
        self,
        scheduler_output: "SchedulerOutput",
    ) -> tuple[list[MultiModalKwargsItem], list[tuple[str, PlaceholderRange]]]:
        """Batch multimodal kwargs from scheduled encoder inputs.

        Args:
            scheduler_output: The scheduler output containing scheduled encoder
1689
                inputs.
1690
1691
1692
1693
1694
1695

        Returns:
            A tuple of (mm_kwargs, req_ids_pos) where:
            - mm_kwargs: List of multimodal kwargs items to be batched
            - mm_hashes_pos: List of (mm_hash, position_info) tuples
        """
1696
1697
        scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
        if not scheduled_encoder_inputs:
1698
            return [], []
1699
        # Batch the multi-modal inputs.
1700
        mm_kwargs = list[MultiModalKwargsItem]()
1701
1702
        # list of tuple (mm_hash, position_info)
        mm_hashes_pos = list[tuple[str, PlaceholderRange]]()
1703
1704
        for req_id, encoder_input_ids in scheduled_encoder_inputs.items():
            req_state = self.requests[req_id]
1705
1706

            for mm_input_id in encoder_input_ids:
1707
1708
1709
1710
                mm_feature = req_state.mm_features[mm_input_id]
                mm_hash = mm_feature.identifier
                mm_kwargs.append(mm_feature.data)
                mm_hashes_pos.append((mm_hash, mm_feature.mm_position))
1711

1712
1713
1714
1715
1716
        return mm_kwargs, mm_hashes_pos

    def _execute_mm_encoder(self, scheduler_output: "SchedulerOutput"):
        # Batch the multi-modal inputs using the helper method.
        mm_kwargs, mm_hashes_pos = self._batch_mm_kwargs_from_scheduler(
1717
1718
            scheduler_output
        )
1719
1720
1721
1722

        if not mm_kwargs:
            return

1723
1724
1725
1726
1727
1728
1729
        # 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.
1730
        model = cast(SupportsMultiModal, self.model)
1731
        encoder_outputs = []
1732
        for modality, num_items, mm_kwargs_group in group_mm_kwargs_by_modality(
1733
1734
1735
1736
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
1737
        ):
1738
1739
1740
            curr_group_outputs = []

            # EVS-related change.
1741
            # (ekhvedchenia): Temporary hack to limit peak memory usage when
1742
            # processing multimodal data. This solves the issue with scheduler
1743
1744
1745
1746
            # 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)
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
            # TODO(ywang96): Fix memory profiling to take EVS into account and
            # remove this hack.
            if (
                self.is_multimodal_pruning_enabled
                and modality == "video"
                and num_items > 1
            ):
                for video_mm_kwargs_item in filter(
                    lambda item: item.modality == "video", mm_kwargs
                ):
                    _, _, micro_batch_mm_inputs = next(
                        group_mm_kwargs_by_modality(
                            [video_mm_kwargs_item],
                            device=self.device,
                            pin_memory=self.pin_memory,
                            merge_by_field_config=model.merge_by_field_config,
                        )
1764
                    )
1765
1766

                    micro_batch_outputs = model.get_multimodal_embeddings(
1767
1768
                        **micro_batch_mm_inputs
                    )
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778

                    curr_group_outputs.extend(micro_batch_outputs)
            else:
                # Run the encoder.
                # `curr_group_outputs` is either of the following:
                # 1. A tensor of shape (num_items, feature_size, hidden_size)
                # in case feature_size is fixed across all multimodal items.
                # 2. A list or tuple (length: num_items) of tensors,
                # each of shape (feature_size, hidden_size) in case the feature
                # size is dynamic depending on the input multimodal items.
1779
                curr_group_outputs = model.get_multimodal_embeddings(**mm_kwargs_group)
1780

1781
1782
            sanity_check_mm_encoder_outputs(
                curr_group_outputs,
1783
                expected_num_items=num_items,
1784
            )
1785
            encoder_outputs.extend(curr_group_outputs)
1786

1787
1788
1789
        # Cache the encoder outputs by mm_hash
        for (mm_hash, pos_info), output in zip(mm_hashes_pos, encoder_outputs):
            self.encoder_cache[mm_hash] = scatter_mm_placeholders(
1790
1791
1792
1793
1794
                output,
                is_embed=pos_info.is_embed,
            )

    def _gather_mm_embeddings(
1795
1796
        self,
        scheduler_output: "SchedulerOutput",
1797
        shift_computed_tokens: int = 0,
1798
1799
1800
1801
1802
1803
1804
1805
    ) -> tuple[list[torch.Tensor], torch.Tensor]:
        total_num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens

        mm_embeds = list[torch.Tensor]()
        is_mm_embed = self.is_mm_embed.cpu
        is_mm_embed[:total_num_scheduled_tokens] = False

        req_start_idx = 0
1806
        should_sync_mrope_positions = False
1807

1808
        for req_id in self.input_batch.req_ids:
1809
1810
            mm_embeds_req: list[torch.Tensor] = []

1811
            num_scheduled_tokens = scheduler_output.num_scheduled_tokens[req_id]
1812
            req_state = self.requests[req_id]
1813
            num_computed_tokens = req_state.num_computed_tokens + shift_computed_tokens
1814

1815
1816
            for mm_feature in req_state.mm_features:
                pos_info = mm_feature.mm_position
1817
1818
                start_pos = pos_info.offset
                num_encoder_tokens = pos_info.length
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834

                # 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,
1835
1836
                    num_encoder_tokens,
                )
1837
                assert start_idx < end_idx
1838

1839
                mm_hash = mm_feature.identifier
1840
                encoder_output = self.encoder_cache.get(mm_hash, None)
1841
                assert encoder_output is not None, f"Encoder cache miss for {mm_hash}."
1842
1843
1844
1845

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

1846
                req_start_pos = req_start_idx + start_pos - num_computed_tokens
1847
1848
1849
                is_mm_embed[req_start_pos + start_idx : req_start_pos + end_idx] = (
                    True if is_embed is None else is_embed
                )
1850

1851
1852
1853
1854
                mm_embeds_item = gather_mm_placeholders(
                    encoder_output[start_idx:end_idx],
                    is_embed=is_embed,
                )
1855
1856
1857
                mm_embeds_req.append(mm_embeds_item)

            if self.is_multimodal_pruning_enabled and self.uses_mrope:
1858
                assert req_state.mrope_positions is not None
1859
1860
1861
1862
1863
1864
1865
                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,
1866
1867
                    )
                )
1868
1869
1870
1871
                req_state.mrope_positions.copy_(new_mrope_positions)
                req_state.mrope_position_delta = new_delta

            mm_embeds.extend(mm_embeds_req)
1872
1873
1874
            req_start_idx += num_scheduled_tokens

        is_mm_embed = self.is_mm_embed.copy_to_gpu(total_num_scheduled_tokens)
1875
1876
1877

        if should_sync_mrope_positions:
            self._calc_mrope_positions(scheduler_output)
1878
            self.mrope_positions.copy_to_gpu(total_num_scheduled_tokens)
1879

1880
        return mm_embeds, is_mm_embed
1881

1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
    def _extract_encoder_inputs(
        self,
        scheduler_output: "SchedulerOutput",
    ) -> dict[str, torch.Tensor]:
        """Extract encoder inputs for encoder-decoder models.

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

        if not mm_kwargs:
            return {}

        # Group MM kwargs by modality and extract features
1898
        model = cast(SupportsMultiModal, self.model)
1899
1900
        encoder_features = {}
        for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
1901
1902
1903
1904
            mm_kwargs,
            device=self.device,
            pin_memory=self.pin_memory,
            merge_by_field_config=model.merge_by_field_config,
1905
1906
1907
1908
1909
1910
1911
1912
        ):
            # Add the grouped features to encoder_features dict
            # This allows the model to receive them as kwargs (e.g.,
            # input_features=...)
            encoder_features.update(mm_kwargs_group)

        return encoder_features

1913
    def get_model(self) -> nn.Module:
1914
        # get raw model out of the cudagraph wrapper.
1915
        if isinstance(self.model, (CUDAGraphWrapper, UBatchWrapper)):
1916
            return self.model.unwrap()
1917
1918
        return self.model

1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
    def get_supported_generation_tasks(self) -> list[GenerationTask]:
        model = self.get_model()
        supported_tasks = list[GenerationTask]()

        if is_text_generation_model(model):
            supported_tasks.append("generate")

        if supports_transcription(model):
            if model.supports_transcription_only:
                return ["transcription"]

            supported_tasks.append("transcription")

        return supported_tasks

1934
1935
1936
1937
1938
    def get_supported_pooling_tasks(self) -> list[PoolingTask]:
        model = self.get_model()
        if not is_pooling_model(model):
            return []

1939
1940
        supported_tasks = list(model.pooler.get_supported_tasks())

1941
1942
1943
1944
1945
        if self.scheduler_config.chunked_prefill_enabled:
            if "token_embed" in supported_tasks:
                supported_tasks.remove("token_embed")
            if "token_classify" in supported_tasks:
                supported_tasks.remove("token_classify")
1946

1947
1948
            logger.debug_once(
                "Chunked prefill is not supported with "
1949
1950
                "token_embed and token_classify tasks "
                "which using ALL pooling. "
1951
1952
1953
                "Please turn off chunked prefill by "
                "`--no-enable-chunked-prefill` before using it."
            )
1954
1955
1956
1957
1958

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

        return supported_tasks
1962

1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
    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)

1973
    def sync_and_slice_intermediate_tensors(
1974
1975
1976
1977
1978
        self,
        num_tokens: int,
        intermediate_tensors: IntermediateTensors,
        sync_self: bool,
    ) -> IntermediateTensors:
1979
1980
1981
        assert self.intermediate_tensors is not None

        tp = self.vllm_config.parallel_config.tensor_parallel_size
1982
        is_rs = is_residual_scattered_for_sp(self.vllm_config, num_tokens)
1983
1984
1985
1986
1987
1988

        # 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():
1989
                is_scattered = k == "residual" and is_rs
1990
                copy_len = num_tokens // tp if is_scattered else num_tokens
1991
                self.intermediate_tensors[k][:copy_len].copy_(
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
                    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:
2005
2006
2007
2008
2009
2010
2011
        """
        Step for the EPLB (Expert Parallelism Load Balancing) state.
        """
        if not self.parallel_config.enable_eplb:
            return

        assert self.eplb_state is not None
2012
2013
        model = self.get_model()
        assert is_mixture_of_experts(model)
2014
        self.eplb_state.step(
2015
            model,
2016
2017
            is_dummy,
            is_profile,
2018
            log_stats=self.parallel_config.eplb_config.log_balancedness,
2019
2020
        )

2021
2022
2023
2024
    # This is where the second ubatch is adjusted to account for the padding.
    # Should be called after attention metadata creation. This just pads
    # the second ubatch slice out to the total number of tokens
    # (num_tokens + padding)
2025
2026
    @staticmethod
    def pad_out_ubatch_slice(ubatch_slices: UBatchSlices, num_total_tokens: int):
2027
2028
2029
2030
2031
2032
        padded_second_ubatch_slice = slice(
            ubatch_slices[1].token_slice.start, num_total_tokens
        )
        ubatch_slices[1] = UBatchSlice(
            padded_second_ubatch_slice, padded_second_ubatch_slice
        )
2033

2034
2035
2036
2037
2038
2039
    def _pool(
        self,
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
        num_scheduled_tokens_np: np.ndarray,
    ) -> ModelRunnerOutput:
2040
2041
2042
        assert self.input_batch.num_reqs == len(self.input_batch.pooling_params), (
            "Either all or none of the requests in a batch must be pooling request"
        )
2043

2044
        hidden_states = hidden_states[:num_scheduled_tokens]
2045
        pooling_metadata = self.input_batch.get_pooling_metadata()
2046
2047
2048
2049
        pooling_metadata.build_pooling_cursor(
            num_scheduled_tokens_np.tolist(), device=hidden_states.device
        )
        seq_lens_cpu = self.seq_lens.cpu[: self.input_batch.num_reqs]
2050

2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
        model = cast(VllmModelForPooling, self.model)
        raw_pooler_output: PoolerOutput = model.pooler(
            hidden_states=hidden_states,
            pooling_metadata=pooling_metadata,
        )
        raw_pooler_output = json_map_leaves(
            lambda x: x.to("cpu", non_blocking=True),
            raw_pooler_output,
        )
        self._sync_device()
2061

2062
        pooler_output: list[torch.Tensor | None] = []
2063
        for raw_output, seq_len, prompt_len in zip(
2064
2065
            raw_pooler_output, seq_lens_cpu, pooling_metadata.prompt_lens
        ):
2066
            output = raw_output if seq_len == prompt_len else None
2067
            pooler_output.append(output)
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077

        return ModelRunnerOutput(
            req_ids=self.input_batch.req_ids,
            req_id_to_index=self.input_batch.req_id_to_index,
            sampled_token_ids=[],
            logprobs=None,
            prompt_logprobs_dict={},
            pooler_output=pooler_output,
        )

2078
    def _get_num_input_tokens(self, num_scheduled_tokens: int) -> int:
2079
2080
2081
2082
2083
2084
        if (
            self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE
            and hasattr(self, "cudagraph_batch_sizes")
            and self.cudagraph_batch_sizes
            and num_scheduled_tokens <= self.cudagraph_batch_sizes[-1]
        ):
2085
2086
2087
2088
2089
2090
2091
2092
            # Use CUDA graphs.
            # Add padding to the batch size.
            return self.vllm_config.pad_for_cudagraph(num_scheduled_tokens)

        # Eager mode.
        # Pad tokens to multiple of tensor_parallel_size when
        # enabled collective fusion for SP
        tp_size = self.vllm_config.parallel_config.tensor_parallel_size
2093
2094
2095
2096
        if (
            self.compilation_config.pass_config.enable_sequence_parallelism
            and tp_size > 1
        ):
2097
2098
2099
            return round_up(num_scheduled_tokens, tp_size)
        return num_scheduled_tokens

2100
    def _preprocess(
2101
2102
        self,
        scheduler_output: "SchedulerOutput",
2103
        num_input_tokens: int,  # Padded
2104
        intermediate_tensors: IntermediateTensors | None = None,
2105
2106
    ) -> tuple[
        int,
2107
2108
        torch.Tensor | None,
        torch.Tensor | None,
2109
        torch.Tensor,
2110
        IntermediateTensors | None,
2111
2112
        dict[str, Any],
    ]:
2113
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
2114
        is_first_rank = get_pp_group().is_first_rank
2115

2116
2117
        # _prepare_inputs may reorder the batch, so we must gather multi
        # modal outputs after that to ensure the correct order
2118
2119
        if (
            self.supports_mm_inputs
2120
            and is_first_rank
2121
2122
            and not self.model_config.is_encoder_decoder
        ):
2123
2124
            # Run the multimodal encoder if any.
            self._execute_mm_encoder(scheduler_output)
2125
            mm_embeds, is_mm_embed = self._gather_mm_embeddings(scheduler_output)
2126

2127
2128
2129
            # 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.
2130
            inputs_embeds_scheduled = self.model.get_input_embeddings(
2131
2132
2133
                self.input_ids.gpu[:num_scheduled_tokens],
                multimodal_embeddings=mm_embeds,
                is_multimodal=is_mm_embed,
2134
            )
2135

2136
            # TODO(woosuk): Avoid the copy. Optimize.
2137
            self.inputs_embeds.gpu[:num_scheduled_tokens].copy_(inputs_embeds_scheduled)
2138

2139
            input_ids = None
2140
            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
2141
2142
2143
2144
            model_kwargs = {
                **self._init_model_kwargs(num_scheduled_tokens),
                **self._extract_mm_kwargs(scheduler_output),
            }
2145
        elif self.enable_prompt_embeds and is_first_rank:
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
            # 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).
2158
2159
2160
            token_ids_idx = (
                self.is_token_ids.gpu[:num_scheduled_tokens]
                .nonzero(as_tuple=False)
2161
                .squeeze(1)
2162
            )
2163
2164
2165
            # Some tokens ids may need to become embeds
            if token_ids_idx.numel() > 0:
                token_ids = self.input_ids.gpu[token_ids_idx]
2166
                tokens_to_embeds = self.model.get_input_embeddings(input_ids=token_ids)
2167
2168
2169
2170
2171
                self.inputs_embeds.gpu[token_ids_idx] = tokens_to_embeds

            inputs_embeds = self.inputs_embeds.gpu[:num_input_tokens]
            model_kwargs = self._init_model_kwargs(num_input_tokens)
            input_ids = None
2172
        else:
2173
2174
2175
2176
            # 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.
2177
            input_ids = self.input_ids.gpu[:num_input_tokens]
2178
            inputs_embeds = None
2179
            model_kwargs = self._init_model_kwargs(num_input_tokens)
2180
        if self.uses_mrope:
2181
            positions = self.mrope_positions.gpu[:, :num_input_tokens]
2182
        else:
2183
            positions = self.positions.gpu[:num_input_tokens]
2184

2185
        if is_first_rank:
2186
2187
            intermediate_tensors = None
        else:
2188
            intermediate_tensors = self.sync_and_slice_intermediate_tensors(
2189
2190
                num_input_tokens, intermediate_tensors, True
            )
2191

2192
2193
2194
2195
        if (
            self.model_config.is_encoder_decoder
            and scheduler_output.scheduled_encoder_inputs
        ):
2196
2197
2198
            encoder_inputs = self._extract_encoder_inputs(scheduler_output)
            model_kwargs.update(encoder_inputs)

2199
2200
2201
2202
2203
2204
2205
2206
        return (
            num_scheduled_tokens,
            input_ids,
            inputs_embeds,
            positions,
            intermediate_tensors,
            model_kwargs,
        )
2207

2208
    def _sample(
2209
        self,
2210
2211
        logits: torch.Tensor | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2212
    ) -> SamplerOutput:
2213
        # Sample the next token and get logprobs if needed.
2214
        sampling_metadata = self.input_batch.sampling_metadata
2215
        if spec_decode_metadata is None:
2216
2217
2218
            # 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()
2219
            return self.sampler(
2220
2221
2222
                logits=logits,
                sampling_metadata=sampling_metadata,
            )
2223

2224
        sampler_output = self.rejection_sampler(
2225
2226
            spec_decode_metadata,
            None,  # draft_probs
2227
            logits,
2228
2229
            sampling_metadata,
        )
2230
        self._update_states_after_model_execute(sampler_output.sampled_token_ids)
2231
2232
2233
        return sampler_output

    def _bookkeeping_sync(
2234
2235
2236
        self,
        scheduler_output: "SchedulerOutput",
        sampler_output: SamplerOutput,
2237
        logits: torch.Tensor | None,
2238
2239
        hidden_states: torch.Tensor,
        num_scheduled_tokens: int,
2240
        spec_decode_metadata: SpecDecodeMetadata | None,
2241
    ) -> tuple[
2242
        dict[str, int],
2243
        LogprobsLists | None,
2244
        list[list[int]],
2245
        dict[str, LogprobsTensors | None],
2246
2247
2248
        list[str],
        dict[str, int],
        list[int],
2249
    ]:
2250
2251
2252
2253
        num_nans_in_logits = {}
        if envs.VLLM_COMPUTE_NANS_IN_LOGITS:
            num_nans_in_logits = self._get_nans_in_logits(logits)

2254
2255
2256
        discard_sampled_tokens_req_indices = self.discard_request_indices.np[
            : self.num_discarded_requests
        ]
2257
2258
2259
2260
        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)
2261

2262
2263
2264
        # 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()
2265
        req_id_to_index_output_copy = self.input_batch.req_id_to_index.copy()
2266
2267

        num_sampled_tokens = sampler_output.sampled_token_ids.shape[0]
2268
        sampled_token_ids = sampler_output.sampled_token_ids
2269
        invalid_req_indices = []
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
        if not self.use_async_scheduling:
            # Get the valid generated tokens.
            max_gen_len = sampled_token_ids.shape[-1]
            if max_gen_len == 1:
                # No spec decode tokens.
                valid_sampled_token_ids = self._to_list(sampled_token_ids)
            else:
                # Includes spec decode tokens.
                valid_sampled_token_ids = self.rejection_sampler.parse_output(
                    sampled_token_ids,
                    self.input_batch.vocab_size,
                )
            # Mask out the sampled tokens that should not be sampled.
            for i in discard_sampled_tokens_req_indices:
2284
                valid_sampled_token_ids[int(i)].clear()
2285
        else:
2286
            valid_sampled_token_ids = []
2287
            invalid_req_indices = discard_sampled_tokens_req_indices.tolist()
2288
2289
2290
2291
2292
2293
            invalid_req_indices_set = set(invalid_req_indices)
            assert sampled_token_ids.shape[-1] == 1

            # 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.
2294
            self.input_batch.prev_sampled_token_ids = sampled_token_ids
2295
2296
2297
2298
2299
            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
            }
2300

2301
2302
2303
2304
2305
        # 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.
2306
        req_ids = self.input_batch.req_ids
2307
2308
2309
2310
        logprobs_tensors = sampler_output.logprobs_tensors
        cu_num_accepted_tokens = (
            [0] if spec_decode_metadata and logprobs_tensors else None
        )
2311
2312
        for req_idx in range(num_sampled_tokens):
            if self.use_async_scheduling:
2313
                sampled_ids = [-1] if req_idx not in invalid_req_indices_set else None
2314
2315
            else:
                sampled_ids = valid_sampled_token_ids[req_idx]
2316
2317
2318
2319
2320
            if not sampled_ids:
                continue

            start_idx = self.input_batch.num_tokens_no_spec[req_idx]
            end_idx = start_idx + len(sampled_ids)
2321
2322
2323
2324
            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}"
2325
            )
2326

2327
2328
            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
2329
2330
            self.input_batch.num_tokens_no_spec[req_idx] = end_idx
            self.input_batch.num_tokens[req_idx] = end_idx
2331

2332
            req_id = req_ids[req_idx]
2333
2334
2335
            req_state = self.requests[req_id]
            req_state.output_token_ids.extend(sampled_ids)

2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
            if cu_num_accepted_tokens is not None:
                cu_num_accepted_tokens.append(
                    cu_num_accepted_tokens[-1] + len(sampled_ids)
                )

        # NOTE: GPU -> CPU Sync happens here.
        # Move as many CPU operations as possible before this sync point.
        logprobs_lists = (
            logprobs_tensors.tolists(cu_num_accepted_tokens)
            if logprobs_tensors is not None
            else None
        )

        # Compute prompt logprobs if needed.
        prompt_logprobs_dict = self._get_prompt_logprobs_dict(
            hidden_states[:num_scheduled_tokens],
            scheduler_output.num_scheduled_tokens,
        )

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
        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,
        )

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

2380
2381
    def _model_forward(
        self,
2382
2383
2384
2385
        input_ids: torch.Tensor | None = None,
        positions: torch.Tensor | None = None,
        intermediate_tensors: IntermediateTensors | None = None,
        inputs_embeds: torch.Tensor | None = None,
2386
2387
2388
2389
2390
        **model_kwargs: dict[str, Any],
    ) -> Any:
        """Helper method to call the model forward pass.

        This method can be overridden by subclasses for model execution.
2391
        Motivation: We can inspect only this method versus
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
        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,
        )

2412
2413
2414
2415
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: "SchedulerOutput",
2416
2417
        intermediate_tensors: IntermediateTensors | None = None,
    ) -> ModelRunnerOutput | AsyncModelRunnerOutput | IntermediateTensors:
2418
        with record_function_or_nullcontext("Preprocess"):
2419
2420
2421
2422
2423
2424
2425
2426
2427
            with self.synchronize_input_prep():
                # Update persistent batch states.
                self._update_states(scheduler_output)

                if not scheduler_output.total_num_scheduled_tokens:
                    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(
2428
2429
                        scheduler_output, self.vllm_config
                    )
2430
2431
2432
2433
                if self.cache_config.kv_sharing_fast_prefill:
                    assert not self.input_batch.num_prompt_logprobs, (
                        "--kv-sharing-fast-prefill produces incorrect "
                        "logprobs for prompt tokens, tokens, please disable "
2434
2435
                        "it when the requests need prompt logprobs"
                    )
2436

2437
                # Prepare the decoder inputs.
2438
2439
2440
2441
2442
2443
2444
2445
                (
                    attn_metadata,
                    logits_indices,
                    spec_decode_metadata,
                    num_scheduled_tokens_np,
                    spec_decode_common_attn_metadata,
                    max_query_len,
                    ubatch_slices,
2446
                    num_tokens_across_dp,
2447
2448
                    use_cascade_attn,
                ) = self._prepare_inputs(scheduler_output)
2449

2450
            dp_rank = self.parallel_config.data_parallel_rank
2451
2452
            if ubatch_slices:
                assert num_tokens_across_dp is not None
2453
                num_input_tokens = int(num_tokens_across_dp[dp_rank].item())
2454
2455
                self.pad_out_ubatch_slice(ubatch_slices, num_input_tokens)
            elif num_tokens_across_dp is not None:
2456
                num_input_tokens = int(num_tokens_across_dp[dp_rank].item())
2457
2458
2459
2460
2461
            else:
                num_input_tokens = self._get_num_input_tokens(
                    scheduler_output.total_num_scheduled_tokens
                )

2462
2463
2464
2465
2466
2467
2468
            (
                num_scheduled_tokens,
                input_ids,
                inputs_embeds,
                positions,
                intermediate_tensors,
                model_kwargs,
2469
            ) = self._preprocess(
2470
                scheduler_output, num_input_tokens, intermediate_tensors
2471
2472
2473
2474
2475
2476
            )

            uniform_decode = (max_query_len == self.uniform_decode_query_len) and (
                num_scheduled_tokens == self.input_batch.num_reqs * max_query_len
            )
            batch_descriptor = BatchDescriptor(
2477
2478
2479
                num_tokens=num_input_tokens,
                uniform_decode=uniform_decode,
                has_lora=len(self.input_batch.lora_id_to_lora_request) > 0,
2480
2481
2482
2483
            )
            cudagraph_runtime_mode, batch_descriptor = (
                self.cudagraph_dispatcher.dispatch(batch_descriptor, use_cascade_attn)
            )
2484

2485
2486
        # Set cudagraph mode to none if calc_kv_scales is true.
        if attn_metadata is not None:
2487
2488
2489
2490
2491
            metadata_list = (
                attn_metadata.values()
                if isinstance(attn_metadata, dict)
                else [attn_metadata]
            )
2492
            if any(
2493
2494
                getattr(m, "enable_kv_scales_calculation", False) for m in metadata_list
            ):
2495
2496
                cudagraph_runtime_mode = CUDAGraphMode.NONE

2497
2498
        # Run the model.
        # Use persistent buffers for CUDA graphs.
2499
2500
        with (
            set_forward_context(
2501
2502
2503
2504
2505
2506
                attn_metadata,
                self.vllm_config,
                num_tokens=num_input_tokens,
                num_tokens_across_dp=num_tokens_across_dp,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                batch_descriptor=batch_descriptor,
2507
                ubatch_slices=ubatch_slices,
2508
2509
2510
2511
            ),
            record_function_or_nullcontext("Forward"),
            self.maybe_get_kv_connector_output(scheduler_output) as kv_connector_output,
        ):
2512
            model_output = self._model_forward(
2513
2514
2515
2516
2517
2518
2519
2520
2521
                input_ids=input_ids,
                positions=positions,
                intermediate_tensors=intermediate_tensors,
                inputs_embeds=inputs_embeds,
                **model_kwargs,
            )

        with record_function_or_nullcontext("Postprocess"):
            if self.use_aux_hidden_state_outputs:
2522
                # True when EAGLE 3 is used.
2523
2524
                hidden_states, aux_hidden_states = model_output
            else:
2525
                # Common case.
2526
2527
2528
                hidden_states = model_output
                aux_hidden_states = None

2529
2530
2531
2532
2533
            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)
2534
2535
                    hidden_states.kv_connector_output = kv_connector_output
                    return hidden_states
2536

2537
                if self.is_pooling_model:
2538
                    # Return the pooling output.
2539
2540
2541
                    output = self._pool(
                        hidden_states, num_scheduled_tokens, num_scheduled_tokens_np
                    )
2542
2543
                    output.kv_connector_output = kv_connector_output
                    return output
2544
2545

                sample_hidden_states = hidden_states[logits_indices]
2546
                logits = self.model.compute_logits(sample_hidden_states)
2547
2548
2549
2550
2551
            else:
                # Rare case.
                assert not self.is_pooling_model

                if not get_pp_group().is_last_rank:
2552
                    all_gather_tensors = {
2553
2554
2555
                        "residual": not is_residual_scattered_for_sp(
                            self.vllm_config, num_input_tokens
                        )
2556
                    }
2557
                    get_pp_group().send_tensor_dict(
2558
2559
                        hidden_states.tensors,
                        all_gather_group=get_tp_group(),
2560
2561
                        all_gather_tensors=all_gather_tensors,
                    )
2562
2563
2564
                    logits = None
                else:
                    sample_hidden_states = hidden_states[logits_indices]
2565
                    logits = self.model.compute_logits(sample_hidden_states)
2566
2567
2568
2569
2570

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

2571
2572
2573
                model_output_broadcast_data = get_pp_group().broadcast_tensor_dict(
                    model_output_broadcast_data, src=len(get_pp_group().ranks) - 1
                )
2574
2575
2576
2577
                assert model_output_broadcast_data is not None
                logits = model_output_broadcast_data["logits"]

            # Apply structured output bitmasks if present
2578
2579
            if scheduler_output.structured_output_request_ids:
                apply_grammar_bitmask(scheduler_output, self.input_batch, logits)
2580
2581
2582
2583

        with record_function_or_nullcontext("Sample"):
            sampler_output = self._sample(logits, spec_decode_metadata)

2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
        def propose_draft_token_ids(sampled_token_ids):
            assert spec_decode_common_attn_metadata is not None
            with record_function_or_nullcontext("Draft"):
                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,
                )

2598
2599
2600
2601
2602
        use_padded_batch_for_eagle = (
            self.speculative_config
            and self.speculative_config.use_eagle()
            and not self.speculative_config.disable_padded_drafter_batch
        )
2603
2604
2605
        effective_drafter_max_model_len = self.max_model_len
        if effective_drafter_max_model_len is None:
            effective_drafter_max_model_len = self.model_config.max_model_len
2606
2607
2608
2609
2610
        if (
            self.speculative_config
            and self.speculative_config.draft_model_config is not None
            and self.speculative_config.draft_model_config.max_model_len is not None
        ):
2611
            effective_drafter_max_model_len = (
2612
2613
                self.speculative_config.draft_model_config.max_model_len
            )
2614
        input_fits_in_drafter = spec_decode_common_attn_metadata and (
2615
2616
2617
2618
            spec_decode_common_attn_metadata.max_seq_len
            + self.speculative_config.num_speculative_tokens
            <= effective_drafter_max_model_len
        )
2619
        if use_padded_batch_for_eagle and input_fits_in_drafter:
2620
2621
2622
2623
            # EAGLE speculative decoding can use the GPU sampled tokens
            # as inputs, and does not need to wait for bookkeeping to finish.
            propose_draft_token_ids(sampler_output.sampled_token_ids)

2624
2625
2626
2627
2628
2629
2630
2631
2632
        with record_function_or_nullcontext("Bookkeep"):
            (
                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,
2633
2634
2635
2636
2637
2638
            ) = self._bookkeeping_sync(
                scheduler_output,
                sampler_output,
                logits,
                hidden_states,
                num_scheduled_tokens,
2639
                spec_decode_metadata,
2640
            )
2641

2642
2643
2644
2645
2646
        if (
            self.speculative_config
            and not use_padded_batch_for_eagle
            and input_fits_in_drafter
        ):
2647
2648
2649
            # 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)
2650

2651
2652
        with record_function_or_nullcontext("EPLB"):
            self.eplb_step()
2653

2654
2655
2656
        output = ModelRunnerOutput(
            req_ids=req_ids_output_copy,
            req_id_to_index=req_id_to_index_output_copy,
2657
2658
2659
2660
            sampled_token_ids=valid_sampled_token_ids,
            logprobs=logprobs_lists,
            prompt_logprobs_dict=prompt_logprobs_dict,
            pooler_output=[],
2661
            kv_connector_output=kv_connector_output,
2662
2663
2664
            num_nans_in_logits=num_nans_in_logits,
        )

2665
2666
2667
        if not self.use_async_scheduling:
            return output

2668
        async_output = AsyncGPUModelRunnerOutput(
2669
            model_runner_output=output,
2670
            sampled_token_ids=sampler_output.sampled_token_ids,
2671
2672
2673
2674
            invalid_req_indices=invalid_req_indices,
            async_output_copy_stream=self.async_output_copy_stream,
        )

2675
2676
2677
2678
2679
2680
2681
2682
2683
        # Save ref of sampled_token_ids CPU tensor if the batch contains
        # any requests with sampling params that that require output ids.
        self.input_batch.set_async_sampled_token_ids(
            async_output.sampled_token_ids_cpu,
            async_output.async_copy_ready_event,
        )

        return async_output

2684
    def take_draft_token_ids(self) -> DraftTokenIds | None:
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
        if self._draft_token_ids is None:
            return None
        req_ids = self.input_batch.req_ids
        if isinstance(self._draft_token_ids, torch.Tensor):
            draft_token_ids = self._draft_token_ids.tolist()
        else:
            draft_token_ids = self._draft_token_ids
        self._draft_token_ids = None
        return DraftTokenIds(req_ids, draft_token_ids)

2695
2696
2697
    def propose_draft_token_ids(
        self,
        scheduler_output: "SchedulerOutput",
2698
        sampled_token_ids: torch.Tensor | list[list[int]],
2699
2700
2701
        sampling_metadata: SamplingMetadata,
        hidden_states: torch.Tensor,
        sample_hidden_states: torch.Tensor,
2702
2703
        aux_hidden_states: list[torch.Tensor] | None,
        spec_decode_metadata: SpecDecodeMetadata | None,
2704
        common_attn_metadata: CommonAttentionMetadata,
2705
    ) -> list[list[int]] | torch.Tensor:
2706
2707
        num_scheduled_tokens = scheduler_output.total_num_scheduled_tokens
        if self.speculative_config.method == "ngram":
2708
            assert isinstance(sampled_token_ids, list)
2709
            assert isinstance(self.drafter, NgramProposer)
2710
            draft_token_ids = self.drafter.propose(
2711
2712
                sampled_token_ids,
                self.input_batch.req_ids,
2713
2714
                self.input_batch.num_tokens_no_spec,
                self.input_batch.token_ids_cpu,
2715
2716
                self.input_batch.spec_decode_unsupported_reqs,
            )
2717
        elif self.speculative_config.method == "medusa":
2718
            assert isinstance(sampled_token_ids, list)
2719
            assert isinstance(self.drafter, MedusaProposer)
2720

2721
2722
            if sample_hidden_states.shape[0] == len(sampled_token_ids):
                # The input to the target model does not include draft tokens.
2723
2724
2725
2726
                hidden_states = sample_hidden_states
            else:
                indices = []
                offset = 0
Wentao Ye's avatar
Wentao Ye committed
2727
                assert spec_decode_metadata is not None
2728
                for num_draft, tokens in zip(
2729
2730
                    spec_decode_metadata.num_draft_tokens, sampled_token_ids
                ):
2731
2732
                    indices.append(offset + len(tokens) - 1)
                    offset += num_draft + 1
2733
                indices = torch.tensor(indices, device=self.device)
2734
2735
                hidden_states = sample_hidden_states[indices]

2736
            draft_token_ids = self.drafter.propose(
2737
2738
2739
                target_hidden_states=hidden_states,
                sampling_metadata=sampling_metadata,
            )
2740
        elif self.speculative_config.use_eagle():
2741
            assert isinstance(self.drafter, EagleProposer)
2742
2743
2744
2745
2746

            if self.speculative_config.disable_padded_drafter_batch:
                # When padded-batch is disabled, the sampled_token_ids should be
                # the cpu-side list[list[int]] of valid sampled tokens for each
                # request, with invalid requests having empty lists.
2747
2748
                assert isinstance(sampled_token_ids, list), (
                    "sampled_token_ids should be a python list when"
2749
                    "padded-batch is disabled."
2750
                )
2751
                next_token_ids = self.drafter.prepare_next_token_ids_cpu(
2752
2753
2754
2755
2756
                    sampled_token_ids,
                    self.requests,
                    self.input_batch,
                    scheduler_output.num_scheduled_tokens,
                )
2757
2758
2759
2760
2761
            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.
2762
2763
                assert isinstance(sampled_token_ids, torch.Tensor), (
                    "sampled_token_ids should be a torch.Tensor when"
2764
                    "padded-batch is enabled."
2765
2766
                )
                next_token_ids, valid_sampled_tokens_count = (
2767
2768
2769
2770
2771
2772
                    self.drafter.prepare_next_token_ids_padded(
                        common_attn_metadata,
                        sampled_token_ids,
                        self.requests,
                        self.input_batch,
                        self.discard_request_indices.gpu,
2773
                        self.num_discarded_requests,
2774
                    )
2775
                )
Jiayi Yao's avatar
Jiayi Yao committed
2776

2777
            if spec_decode_metadata is None:
2778
                token_indices_to_sample = None
2779
                # input_ids can be None for multimodal models.
2780
                target_token_ids = self.input_ids.gpu[:num_scheduled_tokens]
2781
                target_positions = self._get_positions(num_scheduled_tokens)
2782
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
2783
                    assert aux_hidden_states is not None
2784
                    target_hidden_states = torch.cat(
2785
2786
                        [h[:num_scheduled_tokens] for h in aux_hidden_states], dim=-1
                    )
2787
2788
                else:
                    target_hidden_states = hidden_states[:num_scheduled_tokens]
2789
            else:
2790
2791
                if self.speculative_config.disable_padded_drafter_batch:
                    token_indices_to_sample = None
2792
2793
2794
2795
2796
                    common_attn_metadata, token_indices = self.drafter.prepare_inputs(
                        common_attn_metadata,
                        sampled_token_ids,
                        spec_decode_metadata.num_draft_tokens,
                    )
2797
                else:
2798
                    common_attn_metadata, token_indices, token_indices_to_sample = (
2799
2800
2801
                        self.drafter.prepare_inputs_padded(
                            common_attn_metadata,
                            spec_decode_metadata,
2802
2803
2804
                            valid_sampled_tokens_count,
                        )
                    )
2805

2806
                target_token_ids = self.input_ids.gpu[token_indices]
2807
                target_positions = self._get_positions(token_indices)
2808
                if self.use_aux_hidden_state_outputs:
Wentao Ye's avatar
Wentao Ye committed
2809
                    assert aux_hidden_states is not None
2810
                    target_hidden_states = torch.cat(
2811
2812
                        [h[token_indices] for h in aux_hidden_states], dim=-1
                    )
2813
2814
                else:
                    target_hidden_states = hidden_states[token_indices]
2815

2816
            if self.supports_mm_inputs:
2817
2818
2819
2820
2821
2822
                mm_embed_inputs = self._gather_mm_embeddings(
                    scheduler_output,
                    shift_computed_tokens=1,
                )
            else:
                mm_embed_inputs = None
2823

2824
            draft_token_ids = self.drafter.propose(
2825
2826
2827
2828
                target_token_ids=target_token_ids,
                target_positions=target_positions,
                target_hidden_states=target_hidden_states,
                next_token_ids=next_token_ids,
2829
                last_token_indices=token_indices_to_sample,
2830
                sampling_metadata=sampling_metadata,
2831
                common_attn_metadata=common_attn_metadata,
2832
                mm_embed_inputs=mm_embed_inputs,
2833
            )
2834

2835
        return draft_token_ids
2836

2837
2838
2839
    def update_config(self, overrides: dict[str, Any]) -> None:
        allowed_config_names = {"load_config", "model_config"}
        for config_name, config_overrides in overrides.items():
2840
2841
            assert config_name in allowed_config_names, (
                f"Config `{config_name}` not supported. "
2842
                f"Allowed configs: {allowed_config_names}"
2843
            )
2844
2845
2846
2847
            config = getattr(self, config_name)
            new_config = update_config(config, config_overrides)
            setattr(self, config_name, new_config)

2848
2849
2850
2851
2852
    def load_model(self, eep_scale_up: bool = False) -> None:
        """
        Args:
            eep_scale_up: the model loading is for elastic EP scale up.
        """
2853
        logger.info("Starting to load model %s...", self.model_config.model)
2854
2855
        if eep_scale_up:
            from vllm.distributed.parallel_state import get_ep_group
2856
2857
2858
2859
2860

            num_local_physical_experts = torch.empty(1, dtype=torch.int32, device="cpu")
            torch.distributed.broadcast(
                num_local_physical_experts, group=get_ep_group().cpu_group, group_src=0
            )
2861
2862
            num_local_physical_experts = int(num_local_physical_experts.item())
            new_ep_size = get_ep_group().world_size
2863
            global_expert_load, old_global_expert_indices = EplbState.recv_state()
2864
            num_logical_experts = global_expert_load.shape[1]
2865
            self.parallel_config.eplb_config.num_redundant_experts = (
2866
2867
2868
2869
2870
2871
                num_local_physical_experts * new_ep_size - num_logical_experts
            )
            assert old_global_expert_indices.shape[1] % num_local_physical_experts == 0
            old_ep_size = (
                old_global_expert_indices.shape[1] // num_local_physical_experts
            )
2872
            rank_mapping = {
2873
                old_ep_rank: old_ep_rank for old_ep_rank in range(old_ep_size)
2874
2875
2876
2877
2878
2879
            }
        else:
            global_expert_load = None
            old_global_expert_indices = None
            rank_mapping = None

2880
        with DeviceMemoryProfiler() as m:
2881
            time_before_load = time.perf_counter()
2882
            model_loader = get_model_loader(self.load_config)
2883
            self.model = model_loader.load_model(
2884
2885
                vllm_config=self.vllm_config, model_config=self.model_config
            )
2886
            if self.lora_config:
2887
2888
2889
                self.model = self.load_lora_model(
                    self.model, self.vllm_config, self.device
                )
2890
2891
2892
            if hasattr(self, "drafter"):
                logger.info("Loading drafter model...")
                self.drafter.load_model(self.model)
2893
            if self.use_aux_hidden_state_outputs:
2894
                if not supports_eagle3(self.get_model()):
2895
2896
                    raise RuntimeError(
                        "Model does not support EAGLE3 interface but "
2897
2898
                        "aux_hidden_state_outputs was requested"
                    )
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911

                # 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)
2912
            time_after_load = time.perf_counter()
2913
        self.model_memory_usage = m.consumed_memory
2914
2915
2916
2917
2918
        logger.info(
            "Model loading took %.4f GiB and %.6f seconds",
            self.model_memory_usage / GiB_bytes,
            time_after_load - time_before_load,
        )
2919
        prepare_communication_buffer_for_model(self.model)
2920

2921
        self.is_multimodal_pruning_enabled = (
2922
            supports_multimodal_pruning(self.get_model())
2923
2924
            and self.model_config.multimodal_config.is_multimodal_pruning_enabled()
        )
2925

2926
2927
        if is_mixture_of_experts(self.model) and self.parallel_config.enable_eplb:
            logger.info("EPLB is enabled for model %s.", self.model_config.model)
2928
2929
2930
2931
            self.eplb_state = EplbState.build(
                self.model,
                self.device,
                self.parallel_config,
2932
2933
2934
                global_expert_load,
                old_global_expert_indices,
                rank_mapping,
2935
2936
            )

2937
        if (
2938
2939
            self.vllm_config.compilation_config.mode
            == CompilationMode.STOCK_TORCH_COMPILE
2940
            and supports_dynamo()
2941
        ):
2942
            backend = self.vllm_config.compilation_config.init_backend(self.vllm_config)
2943
            compilation_counter.stock_torch_compile_count += 1
2944
            self.model.compile(fullgraph=True, backend=backend)
2945
            return
2946
        # for other compilation modes, cudagraph behavior is controlled by
2947
2948
2949
        # CudagraphWraper and CudagraphDispatcher of vllm.

        # wrap the model with full cudagraph wrapper if needed.
2950
2951
2952
2953
2954
2955
2956
        if (
            self.compilation_config.cudagraph_mode.has_full_cudagraphs()
            and not self.parallel_config.enable_dbo
        ):
            self.model = CUDAGraphWrapper(
                self.model, self.vllm_config, runtime_mode=CUDAGraphMode.FULL
            )
2957
2958
        elif self.parallel_config.enable_dbo:
            if self.compilation_config.cudagraph_mode.has_full_cudagraphs():
2959
2960
2961
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.FULL, self.device
                )
2962
            else:
2963
2964
2965
                self.model = UBatchWrapper(
                    self.model, self.vllm_config, CUDAGraphMode.NONE, self.device
                )
2966

2967
    def _get_eagle3_aux_layers_from_config(self) -> tuple[int, ...] | None:
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
        """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

2991
    def reload_weights(self) -> None:
2992
        assert getattr(self, "model", None) is not None, (
2993
            "Cannot reload weights before model is loaded."
2994
        )
2995
2996
        model_loader = get_model_loader(self.load_config)
        logger.info("Reloading weights inplace...")
2997
        model_loader.load_weights(self.get_model(), model_config=self.model_config)
2998

2999
3000
3001
3002
3003
    def save_tensorized_model(
        self,
        tensorizer_config: "TensorizerConfig",
    ) -> None:
        TensorizerLoader.save_model(
3004
            self.get_model(),
3005
            tensorizer_config=tensorizer_config,
3006
            model_config=self.model_config,
3007
3008
        )

3009
3010
3011
    def _get_prompt_logprobs_dict(
        self,
        hidden_states: torch.Tensor,
3012
        num_scheduled_tokens: dict[str, int],
3013
    ) -> dict[str, LogprobsTensors | None]:
3014
3015
3016
3017
        num_prompt_logprobs_dict = self.input_batch.num_prompt_logprobs
        if not num_prompt_logprobs_dict:
            return {}

3018
        in_progress_dict = self.input_batch.in_progress_prompt_logprobs_cpu
3019
        prompt_logprobs_dict: dict[str, LogprobsTensors | None] = {}
3020
3021
3022
3023
3024

        # 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():
3025
            num_tokens = num_scheduled_tokens[req_id]
3026
3027
3028

            # Get metadata for this request.
            request = self.requests[req_id]
3029
3030
3031
3032
            if request.prompt_token_ids is None:
                # Prompt logprobs is incompatible with prompt embeddings
                continue

3033
3034
            num_prompt_tokens = len(request.prompt_token_ids)
            prompt_token_ids = torch.tensor(request.prompt_token_ids).to(
3035
3036
                self.device, non_blocking=True
            )
3037

3038
3039
3040
3041
3042
3043
            # 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(
3044
3045
                    num_prompt_tokens - 1, num_prompt_logprobs + 1
                )
3046
3047
                in_progress_dict[req_id] = logprobs_tensors

3048
            # Determine number of logits to retrieve.
3049
3050
            start_idx = request.num_computed_tokens
            start_tok = start_idx + 1
3051
            num_remaining_tokens = num_prompt_tokens - start_tok
3052
            if num_tokens <= num_remaining_tokens:
3053
                # This is a chunk, more tokens remain.
3054
3055
3056
                # 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.
3057
3058
3059
3060
3061
                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)
3062
3063
3064
3065
3066
3067
3068
                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
3069
3070
3071
3072
3073

            # 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]
3074
            offset = self.query_start_loc.np[req_idx].item()
3075
            prompt_hidden_states = hidden_states[offset : offset + num_logits]
3076
            logits = self.model.compute_logits(prompt_hidden_states)
3077
3078
3079
3080

            # 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.
3081
            tgt_token_ids = prompt_token_ids[start_tok : start_tok + num_logits]
3082
3083

            # Compute prompt logprobs.
3084
3085
            logprobs = self.sampler.compute_logprobs(logits)
            token_ids, logprobs, ranks = self.sampler.gather_logprobs(
3086
3087
                logprobs, num_prompt_logprobs, tgt_token_ids
            )
3088
3089

            # Transfer GPU->CPU async.
3090
3091
            chunk_slice = slice(start_idx, start_idx + num_logits)
            logprobs_tensors.logprob_token_ids[chunk_slice].copy_(
3092
3093
3094
                token_ids, non_blocking=True
            )
            logprobs_tensors.logprobs[chunk_slice].copy_(logprobs, non_blocking=True)
3095
            logprobs_tensors.selected_token_ranks[chunk_slice].copy_(
3096
3097
                ranks, non_blocking=True
            )
3098
3099
3100
3101
3102

        # 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]
3103
            del in_progress_dict[req_id]
3104
3105

        # Must synchronize the non-blocking GPU->CPU transfers.
3106
        if prompt_logprobs_dict:
3107
            self._sync_device()
3108
3109
3110

        return prompt_logprobs_dict

3111
3112
    def _get_nans_in_logits(
        self,
3113
        logits: torch.Tensor | None,
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
    ) -> 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])
3125
3126
3127
                    if num_nans_for_index is not None and req_index < logits.shape[0]
                    else 0
                )
3128
3129
3130
3131
            return num_nans_in_logits
        except IndexError:
            return {}

3132
3133
3134
3135
3136
3137
    @contextmanager
    def maybe_randomize_inputs(self, input_ids: torch.Tensor):
        """
        Randomize input_ids if VLLM_RANDOMIZE_DP_DUMMY_INPUTS is set.
        This is to help balance expert-selection
         - during profile_run
3138
         - during DP rank dummy run
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
        """
        dp_size = self.vllm_config.parallel_config.data_parallel_size
        randomize_inputs = envs.VLLM_RANDOMIZE_DP_DUMMY_INPUTS and dp_size > 1
        if not randomize_inputs:
            yield
        else:
            import functools

            @functools.cache
            def rand_input_ids() -> torch.Tensor:
                return torch.randint_like(
3150
                    self.input_ids.gpu,
3151
3152
                    low=0,
                    high=self.model_config.get_vocab_size(),
3153
3154
                    dtype=input_ids.dtype,
                )
3155

3156
            logger.debug_once("Randomizing dummy data for DP Rank")
3157
            input_ids.copy_(rand_input_ids()[: input_ids.size(0)], non_blocking=True)
3158
3159
3160
            yield
            input_ids.fill_(0)

3161
3162
3163
3164
3165
3166
    def _get_mm_dummy_batch(
        self,
        modality: str,
        max_items_per_batch: int,
    ) -> BatchedTensorInputs:
        """Dummy data for profiling and precompiling multimodal models."""
3167
3168
        assert self.mm_budget is not None

3169
3170
        dummy_decoder_data = self.mm_registry.get_decoder_dummy_data(
            model_config=self.model_config,
3171
            seq_len=self.max_model_len,
3172
            mm_counts={modality: 1},
3173
            cache=self.mm_budget.cache,
3174
3175
3176
3177
        )
        dummy_mm_data = dummy_decoder_data.multi_modal_data

        # Result in the maximum GPU consumption of the model
3178
3179
        dummy_mm_item = dummy_mm_data[modality][0]
        dummy_mm_items = [dummy_mm_item] * max_items_per_batch
3180

3181
        model = cast(SupportsMultiModal, self.model)
3182
3183
3184
3185
3186
3187
3188
3189
3190
        return next(
            mm_kwargs_group
            for _, _, mm_kwargs_group in group_mm_kwargs_by_modality(
                dummy_mm_items,
                device=self.device,
                pin_memory=self.pin_memory,
                merge_by_field_config=model.merge_by_field_config,
            )
        )
3191

3192
3193
3194
3195
    @torch.inference_mode()
    def _dummy_run(
        self,
        num_tokens: int,
3196
        cudagraph_runtime_mode: CUDAGraphMode | None = None,
3197
3198
        force_attention: bool = False,
        uniform_decode: bool = False,
3199
        allow_microbatching: bool = True,
3200
3201
        skip_eplb: bool = False,
        is_profile: bool = False,
3202
        create_mixed_batch: bool = False,
3203
        remove_lora: bool = True,
3204
        activate_lora: bool = False,
3205
    ) -> tuple[torch.Tensor, torch.Tensor]:
3206
3207
3208
3209
3210
3211
3212
        """
        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.
3213
                - if not set will determine the cudagraph mode based on using
3214
                    the self.cudagraph_dispatcher.
3215
3216
3217
3218
                - CUDAGraphMode.NONE: No cudagraph, for warm up and profile run
                - CUDAGraphMode.PIECEWISE: Piecewise cudagraph.
                - CUDAGraphMode.FULL: Full cudagraph, attention metadata is
                    needed.
3219
            force_attention: If True, always create attention metadata. Used to
3220
3221
3222
3223
                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.
3224
3225
            create_mixed_batch: If True, create a mixed batch with both decode
                (1 token) and prefill (multiple tokens) requests.
3226
            remove_lora: If False, dummy LoRAs are not destroyed after the run
3227
            activate_lora: If False, dummy_run is performed without LoRAs.
3228
        """
3229
3230
3231
3232
        assert (
            cudagraph_runtime_mode is None
            or cudagraph_runtime_mode.valid_runtime_modes()
        )
3233

3234
        # If cudagraph_mode.decode_mode() == FULL and
3235
        # cudagraph_mode.separate_routine(). This means that we are using
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
        # 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.
3247
        max_query_len = self.uniform_decode_query_len if uniform_decode else num_tokens
3248

3249
3250
3251
3252
3253
        # 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
3254
3255
3256
3257
        if create_mixed_batch:
            assert not uniform_decode
            # Create mixed batch:
            # first half decode tokens, second half one prefill
3258
            num_decode_tokens = min(max_num_reqs - 1, num_tokens // 2)
3259
3260
3261
3262
            num_prefill_tokens = num_tokens - num_decode_tokens
            num_reqs = num_decode_tokens + 1

            # Create decode requests (1 token each) followed by prefill request
3263
            num_scheduled_tokens_list = [1] * num_decode_tokens + [num_prefill_tokens]
3264
3265
3266
            # Note: Overriding max_query_len to be the prefill tokens
            max_query_len = num_prefill_tokens
        elif uniform_decode:
3267
            assert not create_mixed_batch
3268
            num_reqs = min(max_num_reqs, cdiv(num_tokens, max_query_len))
3269
3270
            num_scheduled_tokens_list = [max_query_len] * num_reqs
            if num_tokens % max_query_len != 0:
3271
                num_scheduled_tokens_list[-1] = num_tokens % max_query_len
3272
3273
3274
3275
3276
3277
        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

3278
3279
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs
3280
        num_scheduled_tokens = np.array(num_scheduled_tokens_list, dtype=np.int32)
3281
        total_num_scheduled_tokens = int(num_scheduled_tokens.sum())
3282

3283
3284
3285
        # Disable DP padding when running eager
        allow_dp_padding = self.compilation_config.cudagraph_mode != CUDAGraphMode.NONE

3286
3287
        # We currently only microbatch if the number of tokens is
        # over a certain threshold.
3288
        ubatch_slices, num_tokens_across_dp = coordinate_batch_across_dp(
3289
3290
3291
3292
3293
3294
3295
            num_tokens_unpadded=total_num_scheduled_tokens,
            parallel_config=self.vllm_config.parallel_config,
            allow_microbatching=allow_microbatching,
            allow_dp_padding=allow_dp_padding,
            num_tokens_padded=total_num_scheduled_tokens,
            uniform_decode=uniform_decode,
            num_scheduled_tokens_per_request=num_scheduled_tokens,
3296
3297
3298
        )
        num_tokens_after_padding = num_tokens
        if num_tokens_across_dp is not None:
3299
3300
            dp_rank = self.parallel_config.data_parallel_rank
            num_tokens_after_padding = int(num_tokens_across_dp[dp_rank])
3301

3302
        attn_metadata: PerLayerAttnMetadata | None = None
3303
3304
3305

        # If force_attention is True, we always capture attention. Otherwise,
        # it only happens for cudagraph_runtime_mode=FULL.
3306
        if force_attention or cudagraph_runtime_mode == CUDAGraphMode.FULL:
3307
            attn_metadata = {}
3308
3309
            if ubatch_slices is not None:
                attn_metadata = [dict() for _ in range(len(ubatch_slices))]
3310

3311
3312
3313
3314
3315
3316
            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:
3317
                seq_lens = max_query_len
3318
            self.seq_lens.np[:num_reqs] = seq_lens
3319
3320
            self.seq_lens.np[num_reqs:] = 0
            self.seq_lens.copy_to_gpu()
3321

3322
3323
            cum_num_tokens, _ = self._get_cumsum_and_arange(num_scheduled_tokens)
            self.query_start_loc.np[1 : num_reqs + 1] = cum_num_tokens
3324
3325
            self.query_start_loc.copy_to_gpu()

3326
            for kv_cache_group_id, kv_cache_group_spec in enumerate(
3327
3328
                self.kv_cache_config.kv_cache_groups
            ):
3329
                common_attn_metadata = CommonAttentionMetadata(
3330
3331
                    query_start_loc=self.query_start_loc.gpu[: num_reqs + 1],
                    query_start_loc_cpu=self.query_start_loc.cpu[: num_reqs + 1],
3332
3333
                    seq_lens=self.seq_lens.gpu[:num_reqs],
                    seq_lens_cpu=self.seq_lens.cpu[:num_reqs],
3334
3335
3336
                    num_computed_tokens_cpu=self.input_batch.num_computed_tokens_cpu_tensor[
                        :num_reqs
                    ],
3337
3338
                    num_reqs=num_reqs,
                    num_actual_tokens=num_tokens,
3339
                    max_query_len=max_query_len,
3340
                    max_seq_len=self.max_model_len,
3341
3342
3343
                    block_table_tensor=self.input_batch.block_table[
                        kv_cache_group_id
                    ].get_device_tensor(num_reqs),
3344
                    slot_mapping=self.input_batch.block_table[
3345
3346
3347
                        kv_cache_group_id
                    ].slot_mapping.gpu[:num_tokens],
                    causal=True,
3348
3349
3350
                    dcp_local_seq_lens=self.dcp_local_seq_lens.gpu[:num_reqs]
                    if self.dcp_world_size > 1
                    else None,
3351
                )
3352
                for attn_group in self.attn_groups[kv_cache_group_id]:
3353
3354
                    if ubatch_slices is not None:
                        common_attn_metadata_list = split_attn_metadata(
3355
3356
                            ubatch_slices, common_attn_metadata
                        )
3357
                        for ubid, common_attn_metadata in enumerate(
3358
3359
                            common_attn_metadata_list
                        ):
3360
                            assert common_attn_metadata.max_query_len == 1
3361
3362
3363
                            attn_metadata_i = attn_group.get_metadata_builder(
                                ubatch_id=ubid
                            ).build_for_cudagraph_capture(common_attn_metadata)
3364
                            for layer_name in attn_group.layer_names:
3365
                                assert type(attn_metadata) is list
3366
                                attn_metadata[ubid][layer_name] = attn_metadata_i
3367
3368
                    else:
                        assert type(attn_metadata) is dict
3369
3370
                        metadata_builder = attn_group.get_metadata_builder()
                        attn_metadata_i = metadata_builder.build_for_cudagraph_capture(
3371
3372
                            common_attn_metadata
                        )
3373
                        for layer_name in attn_group.layer_names:
3374
                            attn_metadata[layer_name] = attn_metadata_i
3375

3376
        with self.maybe_dummy_run_with_lora(
3377
            self.lora_config, num_scheduled_tokens, activate_lora, remove_lora
3378
        ):
3379
3380
3381
            # Make sure padding doesn't exceed max_num_tokens
            assert num_tokens_after_padding <= self.max_num_tokens
            model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3382
            if self.supports_mm_inputs and not self.model_config.is_encoder_decoder:
3383
                input_ids = None
3384
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
3385
                model_kwargs = {
3386
                    **model_kwargs,
3387
3388
                    **self._dummy_mm_kwargs(num_reqs),
                }
3389
3390
            elif self.enable_prompt_embeds:
                input_ids = None
3391
3392
                inputs_embeds = self.inputs_embeds.gpu[:num_tokens_after_padding]
                model_kwargs = self._init_model_kwargs(num_tokens_after_padding)
3393
            else:
3394
                input_ids = self.input_ids.gpu[:num_tokens_after_padding]
3395
                inputs_embeds = None
3396

3397
            if self.uses_mrope:
3398
                positions = self.mrope_positions.gpu[:, :num_tokens_after_padding]
3399
            else:
3400
                positions = self.positions.gpu[:num_tokens_after_padding]
3401
3402
3403
3404
3405
3406
3407
3408
3409

            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,
3410
3411
3412
                            device=self.device,
                        )
                    )
3413
3414

                intermediate_tensors = self.sync_and_slice_intermediate_tensors(
3415
                    num_tokens_after_padding, None, False
3416
                )
3417
3418

            # filter out the valid batch descriptor
3419
3420
3421
3422
3423
            _cg_mode, batch_descriptor = (
                self.cudagraph_dispatcher.dispatch(
                    BatchDescriptor(
                        num_tokens=num_tokens_after_padding,
                        uniform_decode=uniform_decode,
3424
                        has_lora=activate_lora and self.lora_config is not None,
3425
3426
3427
3428
3429
                    )
                )
                if not is_profile
                else (CUDAGraphMode.NONE, None)
            )
3430
3431
3432
            if cudagraph_runtime_mode is not None:
                # we allow forcing NONE when the dispatcher disagrees to support
                # warm ups for cudagraph capture
3433
3434
3435
3436
                assert (
                    cudagraph_runtime_mode == CUDAGraphMode.NONE
                    or cudagraph_runtime_mode == _cg_mode
                ), (
3437
                    f"Cudagraph runtime mode mismatch at dummy_run. "
3438
3439
                    f"Expected {_cg_mode}, but got {cudagraph_runtime_mode}."
                )
3440
3441
            else:
                cudagraph_runtime_mode = _cg_mode
3442

3443
            if ubatch_slices is not None:
3444
3445
3446
3447
3448
3449
3450
                # Adjust values to reflect a single ubatch.
                # TODO(sage,lucas): this is cruft that should be addressed in
                #  the padding refactor.
                num_tokens_after_padding = ubatch_slices[0].num_tokens
                if num_tokens_across_dp is not None:
                    num_tokens_across_dp[:] = num_tokens_after_padding

3451
3452
3453
            with (
                self.maybe_randomize_inputs(input_ids),
                set_forward_context(
3454
3455
                    attn_metadata,
                    self.vllm_config,
3456
                    num_tokens=num_tokens_after_padding,
3457
3458
                    num_tokens_across_dp=num_tokens_across_dp,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
3459
                    batch_descriptor=batch_descriptor,
3460
3461
3462
                    ubatch_slices=ubatch_slices,
                ),
            ):
3463
                outputs = self.model(
3464
3465
3466
3467
                    input_ids=input_ids,
                    positions=positions,
                    intermediate_tensors=intermediate_tensors,
                    inputs_embeds=inputs_embeds,
3468
                    **model_kwargs,
3469
                )
3470

3471
3472
3473
3474
            if self.use_aux_hidden_state_outputs:
                hidden_states, _ = outputs
            else:
                hidden_states = outputs
3475

3476
            if self.speculative_config and self.speculative_config.use_eagle():
3477
                assert isinstance(self.drafter, EagleProposer)
3478
3479
3480
3481
                use_cudagraphs = (
                    cudagraph_runtime_mode == CUDAGraphMode.PIECEWISE
                    and not self.speculative_config.enforce_eager
                )
3482
                self.drafter.dummy_run(num_tokens, use_cudagraphs=use_cudagraphs)
3483

3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
        # 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)

3494
        logit_indices = np.cumsum(num_scheduled_tokens) - 1
3495
3496
3497
3498
        logit_indices_device = torch.from_numpy(logit_indices).to(
            self.device, non_blocking=True
        )
        return hidden_states, hidden_states[logit_indices_device]
3499
3500
3501
3502
3503
3504

    @torch.inference_mode()
    def _dummy_sampler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> torch.Tensor:
3505
3506
3507
3508
        # The dummy hidden states may contain special values,
        # like `inf` or `nan`.
        # To avoid breaking the sampler, we use a random tensor here instead.
        hidden_states = torch.rand_like(hidden_states)
3509

3510
        logits = self.model.compute_logits(hidden_states)
3511
3512
        num_reqs = logits.size(0)

3513
        dummy_tensors = lambda v: torch.full((num_reqs,), v, device=self.device)
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528

        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)],
3529
            spec_token_ids=[[] for _ in range(num_reqs)],
3530
3531
            allowed_token_ids_mask=None,
            bad_words_token_ids={},
3532
            logitsprocs=LogitsProcessors(),
3533
        )
3534
        try:
3535
3536
3537
            sampler_output = self.sampler(
                logits=logits, sampling_metadata=dummy_metadata
            )
3538
        except RuntimeError as e:
3539
            if "out of memory" in str(e):
3540
3541
3542
3543
                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 "
3544
3545
                    "initializing the engine."
                ) from e
3546
3547
            else:
                raise e
3548
        if self.speculative_config:
3549
3550
            draft_token_ids = [[0] for _ in range(num_reqs)]
            dummy_spec_decode_metadata = SpecDecodeMetadata.make_dummy(
3551
3552
                draft_token_ids, self.device
            )
3553
3554
3555
3556
3557
3558

            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
3559
3560
3561
3562
3563
            logits = torch.randn(
                num_tokens + num_reqs,
                logits.shape[-1],
                device=self.device,
                dtype=logits.dtype,
3564
            )
3565
3566
3567
            self.rejection_sampler(
                dummy_spec_decode_metadata,
                draft_probs,
3568
                logits,
3569
3570
                dummy_metadata,
            )
3571
        return sampler_output
3572

3573
    def _dummy_pooler_run_task(
3574
3575
        self,
        hidden_states: torch.Tensor,
3576
3577
        task: PoolingTask,
    ) -> PoolerOutput:
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
        num_tokens = hidden_states.shape[0]
        max_num_reqs = self.scheduler_config.max_num_seqs
        num_reqs = min(num_tokens, max_num_reqs)
        min_tokens_per_req = num_tokens // num_reqs
        num_scheduled_tokens_list = [min_tokens_per_req] * num_reqs
        num_scheduled_tokens_list[-1] += num_tokens % num_reqs
        assert sum(num_scheduled_tokens_list) == num_tokens
        assert len(num_scheduled_tokens_list) == num_reqs

        req_num_tokens = num_tokens // num_reqs

3589
        dummy_prompt_lens = torch.tensor(
3590
3591
            num_scheduled_tokens_list,
            device="cpu",
3592
        )
3593
3594
3595
        dummy_token_ids = torch.zeros(
            (num_reqs, req_num_tokens), dtype=torch.int32, device=self.device
        )
3596

3597
        model = cast(VllmModelForPooling, self.get_model())
3598
        dummy_pooling_params = PoolingParams(task=task)
3599
        dummy_pooling_params.verify(task=task, model_config=self.model_config)
3600
        to_update = model.pooler.get_pooling_updates(task)
3601
3602
        to_update.apply(dummy_pooling_params)

3603
        dummy_metadata = PoolingMetadata(
3604
3605
3606
3607
            prompt_lens=dummy_prompt_lens,
            prompt_token_ids=dummy_token_ids,
            pooling_params=[dummy_pooling_params] * num_reqs,
        )
3608

3609
3610
3611
        dummy_metadata.build_pooling_cursor(
            num_scheduled_tokens_list, device=hidden_states.device
        )
3612

3613
        try:
3614
3615
3616
            return model.pooler(
                hidden_states=hidden_states, pooling_metadata=dummy_metadata
            )
3617
        except RuntimeError as e:
3618
            if "out of memory" in str(e):
3619
                raise RuntimeError(
3620
3621
3622
                    "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 "
3623
3624
                    "initializing the engine."
                ) from e
3625
3626
            else:
                raise e
3627
3628
3629
3630
3631
3632
3633

    @torch.inference_mode()
    def _dummy_pooler_run(
        self,
        hidden_states: torch.Tensor,
    ) -> PoolerOutput:
        # Find the task that has the largest output for subsequent steps
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
        supported_pooling_tasks = self.get_supported_pooling_tasks()

        if not supported_pooling_tasks:
            if self.scheduler_config.chunked_prefill_enabled:
                raise RuntimeError(
                    f"Model {self.model_config.model} does not support "
                    "any pooling tasks with chunked prefill enabled. "
                    "Please add --no-enable-chunked-prefill to your "
                    "config or CLI args. See "
                    "https://docs.vllm.ai/en/latest/models/pooling_models.html "
                    "to learn more."
                )
            else:
                raise RuntimeError(
                    f"Model {self.model_config.model} does not support "
                    "any pooling tasks. See "
                    "https://docs.vllm.ai/en/latest/models/pooling_models.html "
                    "to learn more."
                )

3654
        output_size = dict[PoolingTask, float]()
3655
        for task in supported_pooling_tasks:
3656
3657
            # Run a full batch with each task to ensure none of them OOMs
            output = self._dummy_pooler_run_task(hidden_states, task)
3658
            output_size[task] = sum(o.nbytes for o in output)
3659
3660
3661
3662
            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)
3663

3664
    def profile_run(self) -> None:
3665
        # Profile with multimodal encoder & encoder cache.
3666
        if self.supports_mm_inputs:
3667
            if self.model_config.multimodal_config.skip_mm_profiling:
3668
                logger.info(
3669
                    "Skipping memory profiling for multimodal encoder and "
3670
3671
                    "encoder cache."
                )
3672
3673
3674
3675
3676
3677
3678
3679
            else:
                mm_budget = self.mm_budget
                assert mm_budget is not None

                if (encoder_budget := mm_budget.get_encoder_budget()) > 0:
                    # NOTE: Currently model is profiled with a single non-text
                    # modality with the max possible input tokens even when
                    # it supports multiple.
3680
                    dummy_modality = mm_budget.get_modality_with_max_tokens()
3681
3682
3683
                    max_mm_items_per_batch = mm_budget.max_items_per_batch_by_modality[
                        dummy_modality
                    ]
3684
3685
3686
3687
3688
3689
3690
3691
3692

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

3694
3695
3696
3697
3698
                    # Create dummy batch of multimodal inputs.
                    batched_dummy_mm_inputs = self._get_mm_dummy_batch(
                        dummy_modality,
                        max_mm_items_per_batch,
                    )
3699

3700
                    # Run multimodal encoder.
3701
3702
3703
                    dummy_encoder_outputs = self.model.get_multimodal_embeddings(
                        **batched_dummy_mm_inputs
                    )
3704

3705
3706
3707
3708
                    sanity_check_mm_encoder_outputs(
                        dummy_encoder_outputs,
                        expected_num_items=max_mm_items_per_batch,
                    )
3709

3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
                    # NOTE: This happens when encoder cache needs to store
                    # the embeddings that encoder outputs are scattered onto.
                    # In this case we create dummy embeddings of size
                    # (encode_budget, hidden_size) and scatter encoder
                    # output into it.
                    encoder_output_shape = dummy_encoder_outputs[0].shape
                    if encoder_output_shape[0] < encoder_budget:
                        expanded_outputs = []
                        for output in dummy_encoder_outputs:
                            expanded = output.new_zeros(
3720
3721
                                (encoder_budget, encoder_output_shape[-1])
                            )
3722
3723
3724
3725
3726
3727
                            num_tokens = output.shape[0]
                            expanded[:num_tokens].copy_(output)
                            expanded_outputs.append(expanded)

                        dummy_encoder_outputs = expanded_outputs

3728
                    # Cache the dummy encoder outputs.
3729
                    self.encoder_cache["tmp"] = dict(enumerate(dummy_encoder_outputs))
3730

3731
        # Add `is_profile` here to pre-allocate communication buffers
3732
3733
3734
        hidden_states, last_hidden_states = self._dummy_run(
            self.max_num_tokens, is_profile=True
        )
3735
        if get_pp_group().is_last_rank:
3736
3737
3738
3739
            if self.is_pooling_model:
                output = self._dummy_pooler_run(hidden_states)
            else:
                output = self._dummy_sampler_run(last_hidden_states)
3740
        else:
3741
            output = None
3742
        self._sync_device()
3743
        del hidden_states, output
3744
        self.encoder_cache.clear()
3745
        gc.collect()
3746

3747
    def capture_model(self) -> int:
3748
        if self.compilation_config.cudagraph_mode == CUDAGraphMode.NONE:
3749
            logger.warning(
3750
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
3751
3752
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
3753
            return 0
3754

3755
3756
        compilation_counter.num_gpu_runner_capture_triggers += 1

3757
3758
        start_time = time.perf_counter()

3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
        @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()
3773
                    gc.collect()
3774

3775
3776
3777
        # 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.
3778
        set_cudagraph_capturing_enabled(True)
3779
        with freeze_gc(), graph_capture(device=self.device):
3780
            start_free_gpu_memory = torch.cuda.mem_get_info()[0]
3781
            cudagraph_mode = self.compilation_config.cudagraph_mode
3782
            assert cudagraph_mode is not None
3783
3784
3785
3786
3787
3788
3789
3790
3791

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

3792
3793
            if cudagraph_mode.mixed_mode() != CUDAGraphMode.NONE:
                cudagraph_runtime_mode = cudagraph_mode.mixed_mode()
3794
                # make sure we capture the largest batch size first
3795
3796
3797
                compilation_cases = list(
                    product(reversed(self.cudagraph_batch_sizes), lora_cases)
                )
3798
3799
3800
                self._capture_cudagraphs(
                    compilation_cases,
                    cudagraph_runtime_mode=cudagraph_runtime_mode,
3801
3802
                    uniform_decode=False,
                )
3803

3804
3805
            # Capture full cudagraph for uniform decode batches if we
            # don't already have full mixed prefill-decode cudagraphs.
3806
3807
3808
3809
3810
3811
3812
            if (
                cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
                and cudagraph_mode.separate_routine()
            ):
                max_num_tokens = (
                    self.scheduler_config.max_num_seqs * self.uniform_decode_query_len
                )
3813
                decode_cudagraph_batch_sizes = [
3814
3815
                    x
                    for x in self.cudagraph_batch_sizes
3816
                    if max_num_tokens >= x >= self.uniform_decode_query_len
3817
                ]
3818
3819
3820
                compilation_cases_decode = list(
                    product(reversed(decode_cudagraph_batch_sizes), lora_cases)
                )
3821
3822
3823
                self._capture_cudagraphs(
                    compilation_cases=compilation_cases_decode,
                    cudagraph_runtime_mode=CUDAGraphMode.FULL,
3824
3825
                    uniform_decode=True,
                )
3826

3827
3828
3829
            torch.cuda.synchronize()
            end_free_gpu_memory = torch.cuda.mem_get_info()[0]

3830
3831
3832
        # 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
3833
        # we may do lazy capturing in future that still allows capturing
3834
3835
        # after here.
        set_cudagraph_capturing_enabled(False)
3836
3837
3838
3839
3840

        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.
3841
3842
3843
3844
3845
        logger.info(
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
        )
3846
        return cuda_graph_size
3847

3848
3849
    def _capture_cudagraphs(
        self,
3850
        compilation_cases: list[tuple[int, bool]],
3851
3852
3853
3854
3855
3856
3857
        cudagraph_runtime_mode: CUDAGraphMode,
        uniform_decode: bool,
    ):
        assert (
            cudagraph_runtime_mode != CUDAGraphMode.NONE
            and cudagraph_runtime_mode.valid_runtime_modes()
        ), f"Invalid cudagraph runtime mode: {cudagraph_runtime_mode}"
3858
3859
3860
3861
3862
3863
3864
3865

        # Only rank 0 should print progress bar during capture
        if is_global_first_rank():
            compilation_cases = tqdm(
                compilation_cases,
                disable=not self.load_config.use_tqdm_on_load,
                desc="Capturing CUDA graphs ({}, {})".format(
                    "decode" if uniform_decode else "mixed prefill-decode",
3866
3867
3868
                    cudagraph_runtime_mode.name,
                ),
            )
3869

3870
        # We skip EPLB here since we don't want to record dummy metrics
3871
        for num_tokens, activate_lora in compilation_cases:
3872
            # We currently only capture ubatched graphs when its a FULL
3873
3874
3875
            # 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
3876
3877
3878
3879
            allow_microbatching = (
                self.parallel_config.enable_dbo
                and cudagraph_runtime_mode == CUDAGraphMode.FULL
                and uniform_decode
3880
3881
3882
3883
3884
                and check_ubatch_thresholds(
                    config=self.vllm_config.parallel_config,
                    num_tokens=num_tokens,
                    uniform_decode=uniform_decode,
                )
3885
            )
3886

3887
3888
3889
3890
3891
3892
            for _ in range(self.compilation_config.cudagraph_num_of_warmups):
                # Use CUDAGraphRuntimeStyle.NONE (default) for warmup.
                # But be careful, warm up with `NONE`is orthogonal to
                # if we want to warm up attention or not. This is
                # different from the case where `FULL` implies capture
                # attention while `PIECEWISE` implies no attention.
3893
3894
3895
3896
3897
3898
3899
3900
3901
                force_attention = cudagraph_runtime_mode == CUDAGraphMode.FULL
                self._dummy_run(
                    num_tokens,
                    cudagraph_runtime_mode=CUDAGraphMode.NONE,
                    force_attention=force_attention,
                    uniform_decode=uniform_decode,
                    allow_microbatching=allow_microbatching,
                    skip_eplb=True,
                    remove_lora=False,
3902
                    activate_lora=activate_lora,
3903
3904
3905
3906
3907
3908
3909
3910
                )
            self._dummy_run(
                num_tokens,
                cudagraph_runtime_mode=cudagraph_runtime_mode,
                uniform_decode=uniform_decode,
                allow_microbatching=allow_microbatching,
                skip_eplb=True,
                remove_lora=False,
3911
                activate_lora=activate_lora,
3912
            )
3913
        self.maybe_remove_all_loras(self.lora_config)
3914

3915
3916
3917
3918
    def initialize_attn_backend(self, kv_cache_config: KVCacheConfig) -> None:
        """
        Initialize the attention backends and attention metadata builders.
        """
3919
        assert len(self.attn_groups) == 0, "Attention backends are already initialized"
3920

3921
3922
3923
3924
3925
3926
        class AttentionGroupKey(NamedTuple):
            attn_backend: type[AttentionBackend]
            kv_cache_spec: KVCacheSpec

        def get_attn_backends_for_group(
            kv_cache_group_spec: KVCacheGroupSpec,
3927
        ) -> tuple[dict[AttentionGroupKey, list[str]], set[type[AttentionBackend]]]:
3928
            layers = get_layers_from_vllm_config(
3929
3930
                self.vllm_config, AttentionLayerBase, kv_cache_group_spec.layer_names
            )
3931
3932
            attn_backends = {}
            attn_backend_layers = defaultdict(list)
3933
            # Dedupe based on full class name; this is a bit safer than
3934
3935
3936
3937
            # 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.
3938
            for layer_name in kv_cache_group_spec.layer_names:
3939
                attn_backend = layers[layer_name].get_attn_backend()
3940
3941
3942
3943
3944
3945
3946

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

3947
3948
3949
                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):
3950
                    layer_kv_cache_spec = layer_kv_cache_spec.kv_cache_specs[layer_name]
3951
                key = (full_cls_name, layer_kv_cache_spec)
3952
3953
3954
                attn_backends[key] = AttentionGroupKey(
                    attn_backend, layer_kv_cache_spec
                )
3955
                attn_backend_layers[key].append(layer_name)
3956
3957
3958
3959
            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()),
            )
3960
3961

        def create_attn_groups(
3962
            attn_backends_map: dict[AttentionGroupKey, list[str]],
3963
3964
        ) -> list[AttentionGroup]:
            attn_groups: list[AttentionGroup] = []
3965
            for (attn_backend, kv_cache_spec), layer_names in attn_backends_map.items():
3966
3967
                attn_group = AttentionGroup.create_with_metadata_builders(
                    attn_backend,
3968
                    layer_names,
3969
                    kv_cache_spec,
3970
3971
                    self.vllm_config,
                    self.device,
3972
                    num_metadata_builders=1
3973
3974
                    if not self.parallel_config.enable_dbo
                    else 2,
3975
3976
                )

3977
3978
3979
                attn_groups.append(attn_group)
            return attn_groups

3980
3981
        attention_backend_maps = []
        attention_backend_set: set[type[AttentionBackend]] = set()
3982
        for kv_cache_group_spec in kv_cache_config.kv_cache_groups:
3983
            attn_backends = get_attn_backends_for_group(kv_cache_group_spec)
3984
3985
3986
3987
3988
3989
3990
3991
            attention_backend_maps.append(attn_backends[0])
            attention_backend_set.update(attn_backends[1])

        # Resolve cudagraph_mode before actually initialize metadata_builders
        self._check_and_update_cudagraph_mode(attention_backend_set)

        for attn_backends_map in attention_backend_maps:
            self.attn_groups.append(create_attn_groups(attn_backends_map))
3992

co63oc's avatar
co63oc committed
3993
        # Calculate reorder batch threshold (if needed)
3994
3995
        self.calculate_reorder_batch_threshold()

3996
3997
3998
    def _check_and_update_cudagraph_mode(
        self, attention_backends: set[type[AttentionBackend]]
    ) -> None:
3999
        """
4000
        Resolve the cudagraph_mode when there are multiple attention
4001
4002
4003
4004
        backends with potential conflicting CUDA graph support.
        Then initialize the cudagraph_dispatcher based on the resolved
        cudagraph_mode.
        """
4005
        min_cg_support = AttentionCGSupport.ALWAYS
4006
        min_cg_backend_name = None
4007

4008
4009
4010
4011
4012
        for attn_backend in attention_backends:
            builder_cls = attn_backend.get_builder_cls()
            if builder_cls.cudagraph_support.value < min_cg_support.value:
                min_cg_support = builder_cls.cudagraph_support
                min_cg_backend_name = attn_backend.__name__
4013
4014
4015
        # Flexible resolve the cudagraph mode
        cudagraph_mode = self.compilation_config.cudagraph_mode
        # check cudagraph for mixed batch is supported
4016
4017
4018
4019
4020
4021
        if (
            cudagraph_mode.mixed_mode() == CUDAGraphMode.FULL
            and min_cg_support != AttentionCGSupport.ALWAYS
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4022
                f"with {min_cg_backend_name} backend (support: "
4023
4024
                f"{min_cg_support})"
            )
4025
4026
            if min_cg_support == AttentionCGSupport.NEVER:
                # if not supported any full cudagraphs, just raise it.
4027
4028
                msg += (
                    "; please try cudagraph_mode=PIECEWISE, and "
4029
                    "make sure compilation mode is VLLM_COMPILE"
4030
                )
4031
4032
4033
4034
4035
                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"
4036
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4037
                    CUDAGraphMode.FULL_AND_PIECEWISE
4038
                )
4039
4040
            else:
                msg += "; setting cudagraph_mode=FULL_DECODE_ONLY"
4041
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4042
                    CUDAGraphMode.FULL_DECODE_ONLY
4043
                )
4044
4045
            logger.warning(msg)

4046
        # check that if we are doing decode full-cudagraphs it is supported
4047
4048
4049
4050
4051
4052
        if (
            cudagraph_mode.decode_mode() == CUDAGraphMode.FULL
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            msg = (
                f"CUDAGraphMode.{cudagraph_mode.name} is not supported "
4053
                f"with {min_cg_backend_name} backend (support: "
4054
4055
                f"{min_cg_support})"
            )
4056
            if self.compilation_config.mode == CompilationMode.VLLM_COMPILE and (
4057
4058
4059
4060
4061
                self.compilation_config.splitting_ops_contain_attention()
                or self.compilation_config.use_inductor_graph_partition
            ):
                msg += (
                    "; setting cudagraph_mode=PIECEWISE because "
4062
                    "attention is compiled piecewise"
4063
4064
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4065
                    CUDAGraphMode.PIECEWISE
4066
                )
4067
            else:
4068
4069
                msg += (
                    "; setting cudagraph_mode=NONE because "
4070
                    "attention is not compiled piecewise"
4071
4072
                )
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4073
                    CUDAGraphMode.NONE
4074
                )
4075
4076
            logger.warning(msg)

4077
4078
        # check that if we are doing spec-decode + decode full-cudagraphs it is
        # supported
4079
4080
4081
4082
4083
4084
4085
4086
        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 "
4087
                f"{min_cg_backend_name} (support: {min_cg_support})"
4088
            )
4089
4090
            if self.compilation_config.splitting_ops_contain_attention():
                msg += "; setting cudagraph_mode=PIECEWISE"
4091
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4092
                    CUDAGraphMode.PIECEWISE
4093
                )
4094
4095
            else:
                msg += "; setting cudagraph_mode=NONE"
4096
                cudagraph_mode = self.compilation_config.cudagraph_mode = (
4097
                    CUDAGraphMode.NONE
4098
                )
4099
4100
4101
4102
            logger.warning(msg)

        # double check that we can support full cudagraph if they are requested
        # even after automatic downgrades
4103
4104
4105
4106
4107
4108
        if (
            cudagraph_mode.has_full_cudagraphs()
            and min_cg_support == AttentionCGSupport.NEVER
        ):
            raise ValueError(
                f"CUDAGraphMode.{cudagraph_mode.name} is not "
4109
                f"supported with {min_cg_backend_name} backend ("
4110
4111
                f"support:{min_cg_support}) "
                "; please try cudagraph_mode=PIECEWISE, "
4112
                "and make sure compilation mode is VLLM_COMPILE"
4113
            )
4114

4115
4116
        # Trigger cudagraph dispatching keys initialization after
        # resolved cudagraph mode.
4117
        self.cudagraph_dispatcher.initialize_cudagraph_keys(
4118
4119
            self.compilation_config.cudagraph_mode, self.uniform_decode_query_len
        )
4120

4121
4122
4123
4124
4125
    def calculate_reorder_batch_threshold(self) -> None:
        """
        Check that if any backends reorder batches; that the reordering
        is compatible (e.g., decode threshold is the same)
        """
4126
        for group in self._attn_group_iterator():
4127
            attn_metadata_builder_i = group.get_metadata_builder()
4128

4129
4130
            # check that if any backends reorder batches; that the reordering
            # is compatible (e.g., decode threshold is the same)
4131
            reorder_batch_threshold_i = attn_metadata_builder_i.reorder_batch_threshold
4132
4133
            if reorder_batch_threshold_i is not None:
                if self.reorder_batch_threshold is not None:
4134
                    if reorder_batch_threshold_i != self.reorder_batch_threshold:
4135
4136
4137
4138
                        raise ValueError(
                            f"Attention backend reorders decodes with "
                            f"threshold {reorder_batch_threshold_i} but other "
                            f"backend uses threshold "
4139
4140
                            f"{self.reorder_batch_threshold}"
                        )
4141
4142
4143
                else:
                    self.reorder_batch_threshold = reorder_batch_threshold_i

4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
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
    def _find_compatible_block_sizes(
        self,
        kv_manager_block_size: int,
        backend_cls: type[AttentionBackend],
        return_all: bool = False,
    ) -> list[int]:
        """
        Find compatible block sizes for a backend.

        Args:
            kv_manager_block_size: Physical block size of KV cache
            backend_cls: Attention backend class
            return_all: Return all compatible sizes if True, max size if False

        Returns:
            Compatible block size(s) based on return_all parameter

        Raises:
            ValueError: If no compatible block size found
        """
        supported_block_size = backend_cls.get_supported_kernel_block_size()
        compatible_sizes = []

        for block_size in supported_block_size:
            if isinstance(block_size, int):
                if kv_manager_block_size % block_size == 0:
                    compatible_sizes.append(block_size)
            elif (
                isinstance(block_size, MultipleOf)
                and kv_manager_block_size % block_size.base == 0
            ):
                compatible_sizes.append(kv_manager_block_size)

        if not compatible_sizes:
            raise ValueError(f"No compatible block size for {kv_manager_block_size}")

        return compatible_sizes if return_all else [max(compatible_sizes)]

    def _select_common_block_size(
        self, kv_manager_block_size: int, attn_groups: list[AttentionGroup]
    ) -> int:
        """
        Select common block size for all backends.

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

        Returns:
            Block size supported by all backends,
            prioritizing cache_config.block_size

        Raises:
            ValueError: If no common block size found
        """
        all_backend_supports = []

        for attn_group in attn_groups:
            compatible_sizes = self._find_compatible_block_sizes(
                kv_manager_block_size, attn_group.backend, return_all=True
            )
            supported_sizes = sorted(list(set(compatible_sizes)), reverse=True)
            all_backend_supports.append(set(supported_sizes))

        common_supported_sizes = set.intersection(*all_backend_supports)

        if not common_supported_sizes:
            error_msg = f"No common block size for {kv_manager_block_size}. "
            for i, attn_group in enumerate(attn_groups):
                supported = all_backend_supports[i]
                error_msg += (
                    f"Backend {attn_group.backend} supports: {sorted(supported)}. "
                )
            raise ValueError(error_msg)

        if self.cache_config.block_size in common_supported_sizes:
            return self.cache_config.block_size

        return max(common_supported_sizes)

4224
    def may_reinitialize_input_batch(self, kv_cache_config: KVCacheConfig) -> None:
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
        """
        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.
        """
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
4236
            if not isinstance(kv_cache_group.kv_cache_spec, EncoderOnlyAttentionSpec)
4237
        ]
4238
4239
4240
4241
4242
4243
4244

        # Generate kernel_block_sizes that matches each block_size
        kernel_block_sizes = self._prepare_kernel_block_sizes(kv_cache_config)

        if block_sizes != [self.cache_config.block_size] or kernel_block_sizes != [
            self.cache_config.block_size
        ]:
4245
4246
4247
            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
4248
4249
                "for more details."
            )
4250
4251
            self.input_batch = InputBatch(
                max_num_reqs=self.max_num_reqs,
4252
                max_model_len=max(self.max_model_len, self.max_encoder_len),
4253
4254
4255
4256
4257
                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,
4258
                kernel_block_sizes=kernel_block_sizes,
4259
                is_spec_decode=bool(self.vllm_config.speculative_config),
4260
                logitsprocs=self.input_batch.logitsprocs,
4261
                logitsprocs_need_output_token_ids=self.input_batch.logitsprocs_need_output_token_ids,
4262
                is_pooling_model=self.is_pooling_model,
4263
4264
                num_speculative_tokens=(
                    self.vllm_config.speculative_config.num_speculative_tokens
4265
4266
4267
                    if self.vllm_config.speculative_config
                    else 0
                ),
4268
4269
            )

4270
    def _allocate_kv_cache_tensors(
4271
4272
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
4273
        """
4274
4275
4276
        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.

4277
        Args:
4278
            kv_cache_config: The KV cache config
4279
        Returns:
4280
            dict[str, torch.Tensor]: A map between layer names to their
4281
            corresponding memory buffer for KV cache.
4282
        """
4283
4284
        kv_cache_raw_tensors: dict[str, torch.Tensor] = {}
        for kv_cache_tensor in kv_cache_config.kv_cache_tensors:
4285
4286
4287
            tensor = torch.zeros(
                kv_cache_tensor.size, dtype=torch.int8, device=self.device
            )
4288
4289
4290
4291
4292
            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:
4293
4294
4295
4296
            for layer_name in group.layer_names:
                if layer_name in self.runner_only_attn_layers:
                    continue
                layer_names.add(layer_name)
4297
4298
4299
        assert layer_names == set(kv_cache_raw_tensors.keys()), (
            "Some layers are not correctly initialized"
        )
4300
4301
        return kv_cache_raw_tensors

4302
4303
4304
    def _attn_group_iterator(self) -> Iterator[AttentionGroup]:
        return itertools.chain.from_iterable(self.attn_groups)

4305
    def _kv_cache_spec_attn_group_iterator(self) -> Iterator[AttentionGroup]:
4306
4307
        if not self.kv_cache_config.kv_cache_groups:
            return
4308
4309
        for attn_groups in self.attn_groups:
            yield from attn_groups
4310

4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
    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 = []
        for kv_cache_group_id, kv_cache_group in enumerate(
            kv_cache_config.kv_cache_groups
        ):
4329
4330
4331
4332
4333
4334
            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):
4335
                continue
4336
            elif isinstance(kv_cache_spec, AttentionSpec):
4337
4338
4339
4340
4341
4342
4343
4344
4345
                # This is an attention backend that supports virtual
                # block splitting. Get the supported block sizes from
                # all backends in the group.
                attn_groups = self.attn_groups[kv_cache_group_id]
                kv_manager_block_size = kv_cache_group.kv_cache_spec.block_size
                selected_kernel_size = self._select_common_block_size(
                    kv_manager_block_size, attn_groups
                )
                kernel_block_sizes.append(selected_kernel_size)
4346
            elif isinstance(kv_cache_spec, MambaSpec):
4347
4348
                # This is likely Mamba or other non-attention cache,
                # no splitting.
4349
                kernel_block_sizes.append(kv_cache_spec.block_size)
4350
4351
4352
4353
4354
4355
            else:
                raise NotImplementedError(
                    f"unknown kv cache spec {kv_cache_group.kv_cache_spec}"
                )
        return kernel_block_sizes

4356
4357
4358
4359
4360
    def _reshape_kv_cache_tensors(
        self,
        kv_cache_config: KVCacheConfig,
        kv_cache_raw_tensors: dict[str, torch.Tensor],
    ) -> dict[str, torch.Tensor]:
4361
        """
4362
        Reshape the KV cache tensors to the desired shape and dtype.
4363

4364
        Args:
4365
4366
            kv_cache_config: The KV cache config
            kv_cache_raw_tensors: The KV cache buffer of each layer, with
4367
                correct size but uninitialized shape.
4368
        Returns:
4369
            Dict[str, torch.Tensor]: A map between layer names to their
4370
4371
            corresponding memory buffer for KV cache.
        """
4372
        kv_caches: dict[str, torch.Tensor] = {}
4373
        has_attn, has_mamba = False, False
4374
4375
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
4376
4377
            attn_backend = group.backend
            for layer_name in group.layer_names:
4378
4379
                if layer_name in self.runner_only_attn_layers:
                    continue
4380
4381
                raw_tensor = kv_cache_raw_tensors[layer_name]
                assert raw_tensor.numel() % kv_cache_spec.page_size_bytes == 0
4382
                num_blocks = raw_tensor.numel() // kv_cache_spec.page_size_bytes
4383
                if isinstance(kv_cache_spec, AttentionSpec):
4384
                    has_attn = True
4385
4386
4387
4388
4389
4390
4391
4392
                    kv_manager_block_size = kv_cache_spec.block_size
                    kernel_size_list = self._find_compatible_block_sizes(
                        kv_manager_block_size, attn_backend, return_all=False
                    )
                    kernel_size = kernel_size_list[0]
                    num_blocks_per_kv_block = kv_manager_block_size // kernel_size
                    kernel_num_blocks = num_blocks * num_blocks_per_kv_block

4393
                    kv_cache_shape = attn_backend.get_kv_cache_shape(
4394
4395
                        kernel_num_blocks,
                        kernel_size,
4396
4397
                        kv_cache_spec.num_kv_heads,
                        kv_cache_spec.head_size,
4398
4399
                        cache_dtype_str=self.cache_config.cache_dtype,
                    )
4400
                    dtype = kv_cache_spec.dtype
4401
                    try:
4402
                        kv_cache_stride_order = attn_backend.get_kv_cache_stride_order()  # noqa: E501
4403
                        assert len(kv_cache_stride_order) == len(kv_cache_shape)
4404
                    except (AttributeError, NotImplementedError):
4405
                        kv_cache_stride_order = tuple(range(len(kv_cache_shape)))
4406
4407
4408
4409
4410
                    # 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.
4411
4412
4413
                    kv_cache_shape = tuple(
                        kv_cache_shape[i] for i in kv_cache_stride_order
                    )
4414
4415
4416
4417
4418
                    # Maintain original KV shape view.
                    inv_order = [
                        kv_cache_stride_order.index(i)
                        for i in range(len(kv_cache_stride_order))
                    ]
4419
4420
4421
4422
4423
4424
                    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
4425
                elif isinstance(kv_cache_spec, MambaSpec):
4426
                    has_mamba = True
Chen Zhang's avatar
Chen Zhang committed
4427
4428
                    raw_tensor = kv_cache_raw_tensors[layer_name]
                    state_tensors = []
4429
                    storage_offset_bytes = 0
4430
                    for shape, dtype in zip(kv_cache_spec.shapes, kv_cache_spec.dtypes):
4431
4432
                        dtype_size = get_dtype_size(dtype)
                        num_element_per_page = (
4433
4434
                            kv_cache_spec.page_size_bytes // dtype_size
                        )
Chen Zhang's avatar
Chen Zhang committed
4435
                        target_shape = (num_blocks, *shape)
4436
4437
                        stride = torch.empty(target_shape).stride()
                        target_stride = (num_element_per_page, *stride[1:])
4438
                        assert storage_offset_bytes % dtype_size == 0
4439
4440
4441
4442
                        tensor = torch.as_strided(
                            raw_tensor.view(dtype),
                            size=target_shape,
                            stride=target_stride,
4443
                            storage_offset=storage_offset_bytes // dtype_size,
4444
                        )
Chen Zhang's avatar
Chen Zhang committed
4445
                        state_tensors.append(tensor)
4446
                        storage_offset_bytes += stride[0] * dtype_size
4447
4448

                    kv_caches[layer_name] = state_tensors
4449
                else:
4450
                    raise NotImplementedError
4451
4452

        if has_attn and has_mamba:
4453
            self._update_hybrid_attention_mamba_layout(kv_caches)
4454

4455
4456
        return kv_caches

4457
    def _update_hybrid_attention_mamba_layout(
4458
4459
        self, kv_caches: dict[str, torch.Tensor]
    ) -> None:
4460
        """
4461
4462
        Update the layout of attention layers from (2, num_blocks, ...) to
        (num_blocks, 2, ...).
4463
4464

        Args:
4465
            kv_caches: The KV cache buffer of each layer.
4466
4467
        """

4468
4469
        for group in self._kv_cache_spec_attn_group_iterator():
            kv_cache_spec = group.kv_cache_spec
4470
            for layer_name in group.layer_names:
4471
                kv_cache = kv_caches[layer_name]
4472
4473
4474
4475
                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 "
4476
                        f"a tensor of shape {kv_cache.shape}"
4477
                    )
4478
                    hidden_size = kv_cache.shape[2:].numel()
4479
4480
4481
4482
                    kv_cache.as_strided_(
                        size=kv_cache.shape,
                        stride=(hidden_size, 2 * hidden_size, *kv_cache.stride()[2:]),
                    )
4483

4484
    def initialize_kv_cache_tensors(
4485
4486
        self, kv_cache_config: KVCacheConfig
    ) -> dict[str, torch.Tensor]:
4487
4488
4489
4490
4491
4492
        """
        Initialize the memory buffer for KV cache.

        Args:
            kv_cache_config: The KV cache config
        Returns:
4493
            Dict[str, torch.Tensor]: A map between layer names to their
4494
4495
4496
4497
4498
            corresponding memory buffer for KV cache.
        """
        # Initialize the memory buffer for KV cache
        kv_cache_raw_tensors = self._allocate_kv_cache_tensors(kv_cache_config)
        # Change the memory buffer to the desired shape
4499
4500
4501
        kv_caches = self._reshape_kv_cache_tensors(
            kv_cache_config, kv_cache_raw_tensors
        )
4502

4503
        # Set up cross-layer KV cache sharing
4504
4505
        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)
4506
4507
            kv_caches[layer_name] = kv_caches[target_layer_name]

4508
4509
4510
4511
4512
4513
4514
4515
4516
        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,
        )
4517
4518
4519
        return kv_caches

    def maybe_add_kv_sharing_layers_to_kv_cache_groups(
4520
4521
        self, kv_cache_config: KVCacheConfig
    ) -> None:
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
        """
        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.
4540
            attn_layers = get_layers_from_vllm_config(self.vllm_config, Attention)
4541
4542
            for layer_name in reversed(attn_layers):
                if layer_name in self.shared_kv_cache_layers:
4543
                    self.kv_sharing_fast_prefill_eligible_layers.add(layer_name)
4544
4545
                else:
                    break
4546

4547
4548
4549
4550
4551
4552
4553
    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
        """
4554
        kv_cache_config = deepcopy(kv_cache_config)
4555
        self.kv_cache_config = kv_cache_config
4556
        self.may_add_encoder_only_layers_to_kv_cache_config()
4557
        self.maybe_add_kv_sharing_layers_to_kv_cache_groups(kv_cache_config)
4558
        self.initialize_attn_backend(kv_cache_config)
4559
4560
        # Reinitialize need to after initialize_attn_backend
        self.may_reinitialize_input_batch(kv_cache_config)
4561
4562
        kv_caches = self.initialize_kv_cache_tensors(kv_cache_config)

4563
4564
4565
4566
4567
4568
        if self.speculative_config and self.speculative_config.use_eagle():
            assert isinstance(self.drafter, EagleProposer)
            # validate all draft model layers belong to the same kv cache
            # group
            self.drafter.validate_same_kv_cache_group(kv_cache_config)

Robert Shaw's avatar
Robert Shaw committed
4569
        if has_kv_transfer_group():
4570
4571
4572
            kv_transfer_group = get_kv_transfer_group()
            kv_transfer_group.register_kv_caches(kv_caches)
            kv_transfer_group.set_host_xfer_buffer_ops(copy_kv_blocks)
Robert Shaw's avatar
Robert Shaw committed
4573

4574
        if self.dcp_world_size > 1:
4575
            layer_names = self.attn_groups[0][0].layer_names
4576
4577
4578
            layers = get_layers_from_vllm_config(
                self.vllm_config, AttentionLayerBase, layer_names
            )
4579
4580
4581
4582
4583
            for layer in layers.values():
                assert layer.impl.need_to_return_lse_for_decode, (
                    "DCP requires attention impls to return"
                    " the softmax lse for decode, but the impl "
                    f"{layer.impl.__class__.__name__} "
4584
4585
                    "does not return the softmax lse for decode."
                )
4586

4587
4588
4589
4590
4591
    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
4592
        encoder_only_attn_specs: dict[AttentionSpec, list[str]] = defaultdict(list)
4593
4594
4595
        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:
4596
                attn_spec: AttentionSpec = EncoderOnlyAttentionSpec(
4597
4598
4599
                    block_size=block_size,
                    num_kv_heads=attn_module.num_kv_heads,
                    head_size=attn_module.head_size,
4600
4601
                    dtype=self.kv_cache_dtype,
                )
4602
4603
4604
                encoder_only_attn_specs[attn_spec].append(layer_name)
                self.runner_only_attn_layers.add(layer_name)
        if len(encoder_only_attn_specs) > 0:
4605
4606
4607
            assert len(encoder_only_attn_specs) == 1, (
                "Only support one encoder-only attention spec now"
            )
4608
4609
            spec, layer_names = encoder_only_attn_specs.popitem()
            self.kv_cache_config.kv_cache_groups.append(
4610
4611
                KVCacheGroupSpec(layer_names=layer_names, kv_cache_spec=spec)
            )
4612

4613
    def get_kv_cache_spec(self) -> dict[str, KVCacheSpec]:
4614
        """
4615
        Generates the KVCacheSpec by parsing the kv cache format from each
4616
4617
        Attention module in the static forward context.
        Returns:
4618
            KVCacheSpec: A dictionary mapping layer names to their KV cache
4619
4620
4621
            format. Layers that do not need KV cache are not included.
        """

4622
        kv_cache_spec: dict[str, KVCacheSpec] = {}
4623
        attn_layers = get_layers_from_vllm_config(self.vllm_config, AttentionLayerBase)
Chen Zhang's avatar
Chen Zhang committed
4624
        for layer_name, attn_module in attn_layers.items():
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
            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
4640

4641
        return kv_cache_spec
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651

    def _to_list(self, sampled_token_ids: torch.Tensor) -> list[list[int]]:
        # 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.
4652
        pinned = self.sampled_token_ids_pinned_cpu[: sampled_token_ids.shape[0]]
4653
4654
4655
4656
        pinned.copy_(sampled_token_ids, non_blocking=True)
        self.transfer_event.record()
        self.transfer_event.synchronize()
        return pinned.tolist()