model_runner.py 51 KB
Newer Older
Woosuk Kwon's avatar
Woosuk Kwon committed
1
2
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
"""
NOTE: Coding style guide for this file:
This model runner is shared by all models: text and multimodal, generative
and embedding, public and private. As a result, this file must only contain
code that is common to every model. Model-specific behavior belongs in the
appropriate model-specific files.

In other words:
* Be paranoid about changing this file. It should remain stable.
* Be even more paranoid about adding new lines. It should remain minimal.

Even for shared features (for example, different parallelism modes), keep the
complexity out of this path. The less common the feature, the more it should be
hidden. Prefer utility functions defined elsewhere and call them from here,
instead of embedding feature-specific logic directly.
"""

20
import functools
Woosuk Kwon's avatar
Woosuk Kwon committed
21
22
23
import gc
import time
from copy import deepcopy
24
from typing import Any, NamedTuple
Woosuk Kwon's avatar
Woosuk Kwon committed
25
26
27
28
29
30
31

import numpy as np
import torch
import torch.nn as nn

from vllm.config import VllmConfig
from vllm.config.compilation import CUDAGraphMode
32
from vllm.distributed.parallel_state import (
33
    get_dcp_group,
34
35
36
    get_pp_group,
    prepare_communication_buffer_for_model,
)
37
from vllm.forward_context import BatchDescriptor, set_forward_context
Woosuk Kwon's avatar
Woosuk Kwon committed
38
39
from vllm.logger import init_logger
from vllm.model_executor.model_loader import get_model_loader
40
from vllm.multimodal import MULTIMODAL_REGISTRY
41
from vllm.sequence import IntermediateTensors
42
from vllm.tasks import SupportedTask
43
from vllm.utils.mem_utils import DeviceMemoryProfiler, format_gib
Woosuk Kwon's avatar
Woosuk Kwon committed
44
45
46
from vllm.utils.torch_utils import STR_DTYPE_TO_TORCH_DTYPE
from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
from vllm.v1.kv_cache_interface import KVCacheConfig
47
from vllm.v1.outputs import DraftTokenIds, KVConnectorOutput, ModelRunnerOutput
48
from vllm.v1.worker.cp_utils import check_attention_cp_compatibility
49
from vllm.v1.worker.gpu.async_utils import AsyncOutput, AsyncPoolingOutput
Woosuk Kwon's avatar
Woosuk Kwon committed
50
from vllm.v1.worker.gpu.attn_utils import (
51
    build_slot_mappings_by_layer,
Woosuk Kwon's avatar
Woosuk Kwon committed
52
53
54
55
56
    get_kv_cache_spec,
    init_attn_backend,
    init_kv_cache,
)
from vllm.v1.worker.gpu.block_table import BlockTables
57
from vllm.v1.worker.gpu.buffer_utils import async_copy_to_gpu
58
from vllm.v1.worker.gpu.cp_utils import prepare_dcp_local_seq_lens
59
60
61
62
63
64
from vllm.v1.worker.gpu.cudagraph_utils import (
    BatchExecutionDescriptor,
    ModelCudaGraphManager,
    get_uniform_token_count,
)
from vllm.v1.worker.gpu.dp_utils import sync_cudagraph_and_dp_padding
Woosuk Kwon's avatar
Woosuk Kwon committed
65
66
67
from vllm.v1.worker.gpu.input_batch import (
    InputBatch,
    InputBuffers,
68
    combine_sampled_and_draft_tokens,
69
    expand_idx_mapping,
70
    get_num_sampled_and_rejected,
71
    post_update,
72
    post_update_pool,
73
74
    prepare_pos_seq_lens,
    prepare_prefill_inputs,
Woosuk Kwon's avatar
Woosuk Kwon committed
75
)
76
77
78
79
80
from vllm.v1.worker.gpu.kv_connector import (
    NO_OP_KV_CONNECTOR,
    KVConnector,
    get_kv_connector,
)
81
from vllm.v1.worker.gpu.lora_utils import LoraState
82
from vllm.v1.worker.gpu.mm.encoder_cache import EncoderCache
83
from vllm.v1.worker.gpu.model_states import init_model_state
84
from vllm.v1.worker.gpu.pool.pooling_runner import PoolingRunner
85
from vllm.v1.worker.gpu.pp_utils import pp_broadcast, pp_receive
86
from vllm.v1.worker.gpu.sample.output import SamplerOutput
87
from vllm.v1.worker.gpu.sample.prompt_logprob import PromptLogprobsWorker
88
from vllm.v1.worker.gpu.sample.sampler import Sampler
89
from vllm.v1.worker.gpu.spec_decode import init_speculator
90
91
92
from vllm.v1.worker.gpu.spec_decode.eagle.eagle3_utils import (
    set_eagle3_aux_hidden_state_layers,
)
93
from vllm.v1.worker.gpu.spec_decode.rejection_sampler import RejectionSampler
94
from vllm.v1.worker.gpu.spec_decode.utils import DraftTokensHandler
95
from vllm.v1.worker.gpu.states import RequestState
96
from vllm.v1.worker.gpu.structured_outputs import StructuredOutputsWorker
Woosuk Kwon's avatar
Woosuk Kwon committed
97
98
99
100
101
from vllm.v1.worker.lora_model_runner_mixin import LoRAModelRunnerMixin

logger = init_logger(__name__)


102
class GPUModelRunner(LoRAModelRunnerMixin):
103
    def __init__(self, vllm_config: VllmConfig, device: torch.device):
Woosuk Kwon's avatar
Woosuk Kwon committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
        self.vllm_config = vllm_config
        self.model_config = vllm_config.model_config
        self.cache_config = vllm_config.cache_config
        self.compilation_config = vllm_config.compilation_config
        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

        self.device = device
        self.dtype = self.model_config.dtype
        self.kv_cache_dtype = self.dtype
        if self.cache_config.cache_dtype != "auto":
            # Quantized KV cache.
            self.kv_cache_dtype = STR_DTYPE_TO_TORCH_DTYPE[
                self.cache_config.cache_dtype
            ]

        self.vocab_size = self.model_config.get_vocab_size()
        self.max_model_len = self.model_config.max_model_len
        self.max_num_tokens = self.scheduler_config.max_num_batched_tokens
        self.max_num_reqs = self.scheduler_config.max_num_seqs
128
        self.is_encoder_decoder = self.model_config.is_encoder_decoder
129

Woosuk Kwon's avatar
Woosuk Kwon committed
130
131
132
133
        self.use_async_scheduling = self.scheduler_config.async_scheduling
        self.output_copy_stream = torch.cuda.Stream(self.device)
        self.output_copy_event = torch.cuda.Event()

134
135
136
137
138
139
140
141
142
143
        # Pipeline parallelism.
        self.pp_size = self.parallel_config.pipeline_parallel_size
        self.use_pp = self.pp_size > 1
        if self.use_pp:
            self.is_first_pp_rank = get_pp_group().is_first_rank
            self.is_last_pp_rank = get_pp_group().is_last_rank
        else:
            self.is_first_pp_rank = True
            self.is_last_pp_rank = True

144
145
146
147
        # Data parallelism.
        self.dp_size = self.parallel_config.data_parallel_size
        self.dp_rank = self.parallel_config.data_parallel_rank

148
149
150
151
152
153
        # Decode context parallelism.
        self.dcp_size = self.parallel_config.decode_context_parallel_size
        self.use_dcp = self.dcp_size > 1
        self.dcp_rank = get_dcp_group().rank_in_group if self.use_dcp else 0
        self.cp_interleave = self.parallel_config.cp_kv_cache_interleave_size

154
155
156
157
158
159
160
161
162
        # Multimodal
        self.mm_registry = MULTIMODAL_REGISTRY
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
            self.model_config
        )
        self.encoder_cache = None
        if self.supports_mm_inputs and self.is_first_pp_rank:
            self.encoder_cache = EncoderCache()

163
        # Speculative decoding.
164
        self.speculator = None
165
        self.num_speculative_steps = 0
166
        self.use_aux_hidden_state_outputs = False
167
        use_strict_rejection_sampling = False
168
169
        if self.speculative_config is not None:
            self.num_speculative_steps = self.speculative_config.num_speculative_tokens
170
171
172
173
            use_strict_rejection_sampling = (
                self.speculative_config.rejection_sample_method == "strict"
            )

174
175
176
177
178
179
180
181
182
183
184
185
            if self.is_last_pp_rank:
                self.speculator = init_speculator(self.vllm_config, self.device)

            if self.speculative_config.method == "eagle3":
                # EAGLE3 may require auxiliary hidden states from target model outputs.
                self.use_aux_hidden_state_outputs = True
                if self.pp_size > 1:
                    raise ValueError("EAGLE3 with pipeline parallel is not supported.")

        # Draft tokens propagation - for spec-dec + struct outputs.
        self.draft_tokens_handler = DraftTokensHandler(self.device)

186
187
188
189
        # Pooling models.
        self.is_pooling_model = self.model_config.runner_type == "pooling"
        self.pooling_runner: PoolingRunner | None = None

190
        # General request states.
Woosuk Kwon's avatar
Woosuk Kwon committed
191
192
193
194
        self.req_states = RequestState(
            max_num_reqs=self.max_num_reqs,
            max_model_len=self.max_model_len,
            max_num_batched_tokens=self.max_num_tokens,
195
            num_speculative_steps=self.num_speculative_steps,
Woosuk Kwon's avatar
Woosuk Kwon committed
196
197
            vocab_size=self.vocab_size,
            device=self.device,
198
199
            model_dtype=self.dtype,
            cache_draft_logits=not use_strict_rejection_sampling,
Woosuk Kwon's avatar
Woosuk Kwon committed
200
201
202
203
204
205
        )
        self.input_buffers = InputBuffers(
            max_num_reqs=self.max_num_reqs,
            max_num_tokens=self.max_num_tokens,
            device=self.device,
        )
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233

        self.sampler: Sampler | None = None
        self.rejection_sampler: RejectionSampler | None = None
        self.prompt_logprobs_worker: PromptLogprobsWorker | None = None
        self.structured_outputs_worker: StructuredOutputsWorker | None = None
        if self.is_last_pp_rank and not self.is_pooling_model:
            # Initialize sampling-related workers.
            # These components are only set up on the last PP rank and
            # for generative (non-pooling) models.
            self.sampler = Sampler(
                max_num_reqs=self.max_num_reqs,
                vocab_size=self.vocab_size,
                device=self.device,
                req_states=self.req_states,
                logprobs_mode=self.model_config.logprobs_mode,
                num_speculative_tokens=self.num_speculative_steps + 1,
            )
            self.rejection_sampler = RejectionSampler(
                self.sampler,
                num_speculative_steps=self.num_speculative_steps,
                use_strict_rejection_sampling=use_strict_rejection_sampling,
            )
            self.prompt_logprobs_worker = PromptLogprobsWorker(self.max_num_reqs)
            self.structured_outputs_worker = StructuredOutputsWorker(
                max_num_logits=self.max_num_reqs * (self.num_speculative_steps + 1),
                vocab_size=self.vocab_size,
                device=self.device,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
234
235

        # CUDA graphs.
236
237
        self.decode_query_len = self.num_speculative_steps + 1
        self.cudagraph_manager = ModelCudaGraphManager(
238
239
            self.vllm_config,
            self.device,
240
241
            self.compilation_config.cudagraph_mode,
            decode_query_len=self.decode_query_len,
242
        )
243
244
        # LoRA-related workers.
        self.lora_state = LoraState(max_num_reqs=self.max_num_reqs)
245
        # KV Connector if configured.
246
247
        self.kv_connector: KVConnector = NO_OP_KV_CONNECTOR

248
        # For transferring state from execute_model to subsequent sample_tokens call.
249
        self.execute_model_state: ExecuteModelState | None = None
250

251
252
253
254
    def update_max_model_len(self, max_model_len: int) -> None:
        self.max_model_len = max_model_len
        self.req_states.max_model_len = max_model_len

255
256
257
    def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
        tasks: list[SupportedTask] = []
        if self.model_config.runner_type == "generate":
258
            tasks.extend(self.model_state.get_supported_generation_tasks())
259
260
261
262
263
        if self.is_pooling_model:
            # Do not rely on pooling_runner here, since this information is needed
            # on the first PP rank, while pooling_runner is only initialized
            # on the last PP rank.
            tasks.extend(PoolingRunner.get_supported_tasks(self.model))
264
        return tuple(tasks)
Woosuk Kwon's avatar
Woosuk Kwon committed
265
266
267
268
269
270
271
272
273
274
275
276
277

    def load_model(self, *args, **kwargs) -> None:
        time_before_load = time.perf_counter()
        with DeviceMemoryProfiler() as m:
            model_loader = get_model_loader(self.vllm_config.load_config)
            logger.info("Loading model from scratch...")

            self.model = model_loader.load_model(
                vllm_config=self.vllm_config,
                model_config=self.vllm_config.model_config,
            )
            if self.lora_config:
                self.model = self.load_lora_model(
278
                    self.model, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
279
                )
280
281
282
283
284

            if self.use_aux_hidden_state_outputs:
                assert self.speculative_config is not None
                set_eagle3_aux_hidden_state_layers(self.model, self.speculative_config)
            if self.speculator is not None:
285
                self.speculator.load_model(self.model)
Woosuk Kwon's avatar
Woosuk Kwon committed
286
287
288
289
        time_after_load = time.perf_counter()

        self.model_memory_usage = m.consumed_memory
        logger.info(
290
291
            "Model loading took %s GiB and %.6f seconds",
            format_gib(m.consumed_memory),
Woosuk Kwon's avatar
Woosuk Kwon committed
292
293
294
            time_after_load - time_before_load,
        )

295
        prepare_communication_buffer_for_model(self.model)
296
        if self.speculator is not None:
297
            prepare_communication_buffer_for_model(self.speculator.model)
298

299
        # Initialize the components that require the model.
300
        self.model_state = init_model_state(
301
302
            self.vllm_config, self.model, self.encoder_cache, self.device
        )
303
        if self.is_pooling_model and self.is_last_pp_rank:
304
            self.pooling_runner = PoolingRunner(self.model)
305

Woosuk Kwon's avatar
Woosuk Kwon committed
306
307
308
    def get_model(self) -> nn.Module:
        return self.model

309
310
311
312
313
    @functools.cached_property
    def main_stream(self) -> torch.cuda.Stream:
        # Cache the default CUDA stream to avoid lookup overhead.
        return torch.cuda.current_stream(self.device)

Woosuk Kwon's avatar
Woosuk Kwon committed
314
315
316
317
318
319
320
321
322
323
324
    def get_kv_cache_spec(self):
        return get_kv_cache_spec(self.vllm_config)

    def initialize_kv_cache(self, kv_cache_config: KVCacheConfig) -> None:
        kv_cache_config = deepcopy(kv_cache_config)
        self.kv_cache_config = kv_cache_config
        block_sizes = [
            kv_cache_group.kv_cache_spec.block_size
            for kv_cache_group in kv_cache_config.kv_cache_groups
        ]

325
326
327
328
329
330
331
332
333
        block_table_max_model_len = self.max_model_len
        if self.is_encoder_decoder:
            # Cross-attention block tables need to index encoder tokens
            # (e.g., Whisper ~1500), which can exceed decoder max_model_len.
            block_table_max_model_len = max(
                block_table_max_model_len,
                getattr(self.model_config.hf_config, "max_source_positions", 0),
            )

Woosuk Kwon's avatar
Woosuk Kwon committed
334
335
336
337
        self.block_tables = BlockTables(
            block_sizes=block_sizes,
            max_num_reqs=self.max_num_reqs,
            max_num_batched_tokens=self.max_num_tokens,
338
            max_model_len=block_table_max_model_len,
Woosuk Kwon's avatar
Woosuk Kwon committed
339
            device=self.device,
340
341
342
            cp_size=self.dcp_size,
            cp_rank=self.dcp_rank,
            cp_interleave=self.cp_interleave,
Woosuk Kwon's avatar
Woosuk Kwon committed
343
344
        )

345
        self.attn_backends, self.attn_groups = init_attn_backend(
346
            self.kv_cache_config, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
347
        )
348
        check_attention_cp_compatibility(self.vllm_config)
349
        if self.speculator is not None:
350
351
            # HACK(woosuk)
            self.speculator.set_attn(
352
                self.model_state,
353
                self.kv_cache_config,
354
                self.attn_groups,
355
356
                self.block_tables,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
357
358

        self.kv_caches: list[torch.Tensor] = []
359
        kv_caches_dict = init_kv_cache(
Woosuk Kwon's avatar
Woosuk Kwon committed
360
361
362
363
364
365
            self.kv_caches,
            self.compilation_config.static_forward_context,
            self.kv_cache_config,
            self.attn_backends,
            self.device,
        )
366
367
        self.kv_connector = get_kv_connector(self.vllm_config, kv_caches_dict)

Woosuk Kwon's avatar
Woosuk Kwon committed
368
369
    @torch.inference_mode()
    def _dummy_run(
370
371
372
373
374
375
        self,
        num_tokens: int,
        *args,
        skip_attn: bool = True,
        uniform_decode: bool = False,
        **kwargs,
376
    ) -> tuple[torch.Tensor | None, torch.Tensor | None]:
377
        # Create a dummy scheduler output.
378
        num_reqs = min(num_tokens, self.max_num_reqs)
379
        if uniform_decode:
380
381
382
383
384
385
386
387
388
389
            # HACK(lucas): for now since the worker is shared between MRV1 and MRV2,
            # and for spec-decode with MTP we want to make sure the dummy runs use
            # 1+num_speculative_tokens we use max here, this will likely be eventually
            # changed in the worker: https://github.com/vllm-project/vllm/pull/35243
            num_tokens = max(num_tokens, self.decode_query_len)
            num_reqs = num_tokens // self.decode_query_len
            assert num_tokens % self.decode_query_len == 0
        num_tokens_per_request = [num_tokens // num_reqs] * num_reqs
        num_tokens_per_request[-1] += num_tokens % num_reqs

390
391
        assert sum(num_tokens_per_request) == num_tokens
        num_scheduled_tokens = {
392
            f"_dummy_req_{i}": n for i, n in enumerate(num_tokens_per_request)
393
394
395
396
397
        }
        dummy_scheduler_output = SchedulerOutput.make_empty()
        dummy_scheduler_output.total_num_scheduled_tokens = num_tokens
        dummy_scheduler_output.num_scheduled_tokens = num_scheduled_tokens

398
399
400
        # Disable any use of KVConnector for dummy runs.
        self.kv_connector.set_disabled(True)

401
402
        # For non-first PP ranks, create dummy intermediate_tensors.
        intermediate_tensors = None
403
        if not self.is_first_pp_rank:
404
405
406
407
408
409
            intermediate_tensors = self.model.make_empty_intermediate_tensors(
                batch_size=num_tokens,
                dtype=self.model_config.dtype,
                device=self.device,
            )

410
411
        # Execute the model.
        self.execute_model(
412
413
414
415
            dummy_scheduler_output,
            intermediate_tensors=intermediate_tensors,
            dummy_run=True,
            skip_attn_for_dummy_run=skip_attn,
416
        )
417
        self.kv_connector.set_disabled(False)
418
419

        # Non-last PP ranks don't produce output for sampling.
420
        if not self.is_last_pp_rank:
421
422
            return None, None

423
        assert self.execute_model_state is not None
424
425
426
427
428
429
        input_batch = self.execute_model_state.input_batch
        attn_metadata = self.execute_model_state.attn_metadata
        slot_mappings_by_layer = self.execute_model_state.slot_mappings_by_layer
        hidden_states = self.execute_model_state.hidden_states
        aux_hidden_states = self.execute_model_state.aux_hidden_states
        num_tokens_across_dp = self.execute_model_state.num_tokens_across_dp
430
        self.execute_model_state = None
431
432
433

        # dummy run the eagle speculator's propose to ensure DP/EP sync.
        if self.speculator is not None:
434
            assert self.sampler is not None
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
            self.speculator.propose(
                input_batch=input_batch,
                attn_metadata=attn_metadata,
                slot_mappings=slot_mappings_by_layer,
                last_hidden_states=hidden_states,
                aux_hidden_states=aux_hidden_states,
                num_sampled=torch.ones(
                    input_batch.num_reqs, dtype=torch.int32, device=self.device
                ),
                num_rejected=torch.zeros(
                    input_batch.num_reqs, dtype=torch.int32, device=self.device
                ),
                last_sampled=self.req_states.last_sampled_tokens,
                next_prefill_tokens=self.req_states.next_prefill_tokens,
                temperature=self.sampler.sampling_states.temperature.gpu,
                seeds=self.sampler.sampling_states.seeds.gpu,
451
                draft_logits_out=self.req_states.draft_logits,
452
453
454
455
456
                num_tokens_across_dp=num_tokens_across_dp,
                dummy_run=True,
                skip_attn_for_dummy_run=skip_attn,
            )

457
        assert hidden_states is not None  # Last PP rank always has hidden_states
458
        sample_hidden_states = hidden_states[input_batch.logits_indices]
Woosuk Kwon's avatar
Woosuk Kwon committed
459
460
461
        return hidden_states, sample_hidden_states

    @torch.inference_mode()
462
    def _dummy_sampler_run(self, hidden_states: torch.Tensor) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
463
464
        num_reqs = hidden_states.shape[0]
        logits = self.model.compute_logits(hidden_states)
465
466
        dummy_input_batch = InputBatch.make_dummy(
            num_reqs, num_reqs, self.input_buffers
467
        )
468

469
470
471
        # NOTE(woosuk): During the initial memory profiling, the sampler may skip
        # top_k, top_p, and logprobs, using less GPU memory than what is possible
        # during actual execution.
472
473
        assert self.sampler is not None
        self.sampler(logits, dummy_input_batch)
Woosuk Kwon's avatar
Woosuk Kwon committed
474

475
476
477
478
479
    @torch.inference_mode()
    def _dummy_pooler_run(self, hidden_states: torch.Tensor) -> None:
        assert self.pooling_runner is not None
        self.pooling_runner.dummy_pooler_run(hidden_states)

Woosuk Kwon's avatar
Woosuk Kwon committed
480
481
482
    @torch.inference_mode()
    def profile_run(self) -> None:
        hidden_states, sample_hidden_states = self._dummy_run(
483
            self.max_num_tokens, skip_attn=True
Woosuk Kwon's avatar
Woosuk Kwon committed
484
        )
485

486
        # Only run sampler/pooler on last PP rank (non-last ranks return None).
487
        if self.is_last_pp_rank:
488
            assert sample_hidden_states is not None
489
490
491
492
            if self.pooling_runner is None:
                self._dummy_sampler_run(sample_hidden_states)
            else:
                self._dummy_pooler_run(hidden_states)
493

494
        torch.accelerator.synchronize()
Woosuk Kwon's avatar
Woosuk Kwon committed
495
496
497
498
        del hidden_states, sample_hidden_states
        gc.collect()

    def reset_mm_cache(self) -> None:
499
500
        if self.encoder_cache is not None:
            self.encoder_cache.reset_mm_cache()
501
502

    def reset_encoder_cache(self) -> None:
503
504
        if self.encoder_cache is not None:
            self.encoder_cache.reset_encoder_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
505
506
507
508
509

    def _get_num_input_tokens(self, num_scheduled_tokens: int) -> int:
        # SP is not supported yet.
        return num_scheduled_tokens

510
511
512
513
    def profile_cudagraph_memory(self) -> int:
        # NOTE(woosuk): It is TBD whether we keep this API or not.
        return 0

Woosuk Kwon's avatar
Woosuk Kwon committed
514
515
516
517
518
519
520
521
522
    @torch.inference_mode()
    def capture_model(self) -> int:
        if not self.cudagraph_manager.needs_capture():
            logger.warning(
                "Skipping CUDA graph capture. To turn on CUDA graph capture, "
                "ensure `cudagraph_mode` was not manually set to `NONE`"
            )
            return 0

523
524
525
526
527
528
529
530
        # TODO (zhanqiu): support CUDA graph for PP.
        if self.use_pp:
            logger.warning_once(
                "Skipping CUDA graph capture because pipeline parallel is "
                "enabled. Pipeline parallel is currently eager-only.",
            )
            return 0

Woosuk Kwon's avatar
Woosuk Kwon committed
531
        start_time = time.perf_counter()
532
        gc.collect()
533
        torch.accelerator.empty_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
534
535
536
537
        start_free_gpu_memory = torch.cuda.mem_get_info()[0]

        with self.maybe_setup_dummy_loras(self.lora_config):
            self.cudagraph_manager.capture(
538
539
540
541
542
543
                self.model,
                self.model_state,
                self.input_buffers,
                self.block_tables,
                self.attn_groups,
                self.kv_cache_config,
544
                has_lora=self.lora_config is not None,
545
                use_aux_hidden_state_outputs=self.use_aux_hidden_state_outputs,
Woosuk Kwon's avatar
Woosuk Kwon committed
546
            )
547
            if self.speculator is not None:
548
                self.speculator.capture_model()
Woosuk Kwon's avatar
Woosuk Kwon committed
549
550
551
552
553
554
555
556
557
558
559
560
561

        end_time = time.perf_counter()
        end_free_gpu_memory = torch.cuda.mem_get_info()[0]
        elapsed_time = end_time - start_time
        cuda_graph_size = start_free_gpu_memory - end_free_gpu_memory
        # This usually takes 5~20 seconds.
        logger.info(
            "Graph capturing finished in %.0f secs, took %.2f GiB",
            elapsed_time,
            cuda_graph_size / (1 << 30),
        )
        return cuda_graph_size

562
    def finish_requests(self, scheduler_output: SchedulerOutput) -> None:
563
        finished_req_ids = scheduler_output.finished_req_ids
564
565
566
        preempted_req_ids = scheduler_output.preempted_req_ids
        if preempted_req_ids:
            finished_req_ids = finished_req_ids.union(preempted_req_ids)
567
        for req_id in finished_req_ids:
Woosuk Kwon's avatar
Woosuk Kwon committed
568
            self.req_states.remove_request(req_id)
569
570
            if self.encoder_cache is not None:
                self.encoder_cache.remove_request(req_id)
571
572
            if self.prompt_logprobs_worker is not None:
                self.prompt_logprobs_worker.remove_request(req_id)
573
            self.lora_state.remove_request(req_id)
574

575
    def free_states(self, scheduler_output: SchedulerOutput) -> None:
576
        if self.encoder_cache is not None:
577
            for mm_hash in scheduler_output.free_encoder_mm_hashes:
578
                self.encoder_cache.free_encoder_cache(mm_hash)
Woosuk Kwon's avatar
Woosuk Kwon committed
579

580
    def add_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
581
        for new_req_data in scheduler_output.scheduled_new_reqs:
582
583
            assert new_req_data.prompt_token_ids is not None
            assert new_req_data.prefill_token_ids is not None
Woosuk Kwon's avatar
Woosuk Kwon committed
584
            req_id = new_req_data.req_id
585
            prompt_len = len(new_req_data.prompt_token_ids)
Woosuk Kwon's avatar
Woosuk Kwon committed
586
587
            self.req_states.add_request(
                req_id=req_id,
588
                prompt_len=prompt_len,
589
                all_token_ids=new_req_data.prefill_token_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
590
591
592
                num_computed_tokens=new_req_data.num_computed_tokens,
            )
            req_index = self.req_states.req_id_to_index[req_id]
593

594
595
            if self.encoder_cache is not None:
                self.encoder_cache.add_request(req_id, new_req_data.mm_features)
596

597
            self.model_state.add_request(req_index, new_req_data)
598
599
600
            self.block_tables.append_block_ids(
                req_index, new_req_data.block_ids, overwrite=True
            )
601
            self.lora_state.add_request(req_id, req_index, new_req_data.lora_request)
Woosuk Kwon's avatar
Woosuk Kwon committed
602

603
604
            if self.is_last_pp_rank and new_req_data.sampling_params is not None:
                assert self.sampler is not None
605
606
607
                self.sampler.add_request(
                    req_index, prompt_len, new_req_data.sampling_params
                )
608
                assert self.prompt_logprobs_worker is not None
609
610
611
612
                self.prompt_logprobs_worker.add_request(
                    req_id, req_index, new_req_data.sampling_params
                )

613
614
        if scheduler_output.scheduled_new_reqs:
            self.req_states.apply_staged_writes()
615
            self.model_state.apply_staged_writes()
616
617
        if self.sampler is not None:
            self.sampler.apply_staged_writes()
618
619

    def update_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
620
        # Add new blocks for the existing requests.
621
622
        reqs = scheduler_output.scheduled_cached_reqs
        for req_new_block_ids, req_id in zip(reqs.new_block_ids, reqs.req_ids):
Woosuk Kwon's avatar
Woosuk Kwon committed
623
            if req_new_block_ids is not None:
624
                req_index = self.req_states.req_id_to_index[req_id]
625
626
627
                self.block_tables.append_block_ids(
                    req_index, req_new_block_ids, overwrite=False
                )
Woosuk Kwon's avatar
Woosuk Kwon committed
628
629

    def prepare_inputs(
630
        self, scheduler_output: SchedulerOutput, batch_desc: BatchExecutionDescriptor
Woosuk Kwon's avatar
Woosuk Kwon committed
631
632
    ) -> InputBatch:
        num_tokens = scheduler_output.total_num_scheduled_tokens
633
        num_tokens_after_padding = batch_desc.num_tokens
Woosuk Kwon's avatar
Woosuk Kwon committed
634
        assert num_tokens > 0
635
636
        num_tokens_per_req = scheduler_output.num_scheduled_tokens
        num_reqs = len(num_tokens_per_req)
Woosuk Kwon's avatar
Woosuk Kwon committed
637
638
639

        # Decode first, then prefill.
        # batch_idx -> req_id
640
641
642
        req_ids = sorted(num_tokens_per_req, key=num_tokens_per_req.get)  # type: ignore[arg-type]
        numtoks_iter = map(num_tokens_per_req.get, req_ids)
        num_scheduled_tokens = np.fromiter(numtoks_iter, dtype=np.int32, count=num_reqs)
Woosuk Kwon's avatar
Woosuk Kwon committed
643

644
645
        idx_mapping_iter = map(self.req_states.req_id_to_index.get, req_ids)
        idx_mapping_np = np.fromiter(idx_mapping_iter, dtype=np.int32, count=num_reqs)
646
        idx_mapping = async_copy_to_gpu(idx_mapping_np, device=self.device)
Woosuk Kwon's avatar
Woosuk Kwon committed
647

648
        # Get the number of draft tokens for each request.
649
650
        draft_tokens = scheduler_output.scheduled_spec_decode_tokens
        if not draft_tokens:
651
652
653
            # No draft token scheduled (common case).
            total_num_draft_tokens = 0
            total_num_logits = num_reqs
654
            cu_num_logits_np = np.arange(num_reqs + 1, dtype=np.int32)
655
656
657
            cu_num_logits = torch.arange(
                num_reqs + 1, device=self.device, dtype=torch.int32
            )
658
            expanded_idx_mapping = idx_mapping
659
660
661
            expanded_local_pos = torch.zeros(
                num_reqs, dtype=torch.int32, device=self.device
            )
662
        else:
663
664
            num_draft_tokens = np.fromiter(
                (len(draft_tokens.get(req_id, ())) for req_id in req_ids),
665
                dtype=np.int32,
666
                count=num_reqs,
667
668
669
670
            )
            total_num_draft_tokens = int(num_draft_tokens.sum())
            total_num_logits = num_reqs + total_num_draft_tokens

671
672
673
674
            num_logits = num_draft_tokens + 1
            cu_num_logits_np = np.empty(num_reqs + 1, dtype=np.int32)
            cu_num_logits_np[0] = 0
            np.cumsum(num_logits, out=cu_num_logits_np[1:])
675
            cu_num_logits = async_copy_to_gpu(cu_num_logits_np, device=self.device)
676

677
            max_expand_len = self.num_speculative_steps + 1
678
            expanded_idx_mapping, expanded_local_pos = expand_idx_mapping(
679
                idx_mapping, total_num_logits, cu_num_logits, max_expand_len
680
681
            )

682
        # Get query_start_loc.
683
684
        # num_reqs_padded is None for PIECEWISE graphs (no request padding needed)
        num_reqs_padded = batch_desc.num_reqs or num_reqs
685
686
687
        query_start_loc_np = np.empty(self.max_num_reqs + 1, dtype=np.int32)
        query_start_loc_np[0] = 0
        np.cumsum(num_scheduled_tokens, out=query_start_loc_np[1 : num_reqs + 1])
688
689
        # Pad for full CUDA graph mode.
        # Some attention backends like FA3 require query_start_loc to be non-decreasing.
690
        query_start_loc_np[num_reqs + 1 :] = num_tokens
691
        async_copy_to_gpu(query_start_loc_np, out=self.input_buffers.query_start_loc)
692
693
        query_start_loc_np = query_start_loc_np[: num_reqs_padded + 1]
        query_start_loc = self.input_buffers.query_start_loc[: num_reqs_padded + 1]
694

695
696
697
698
699
700
701
702
703
704
705
        # Get prefill tokens if any.
        if self.req_states.any_prefills(idx_mapping_np):
            prepare_prefill_inputs(
                self.input_buffers.input_ids,
                self.req_states.next_prefill_tokens,
                idx_mapping,
                query_start_loc,
                self.req_states.all_token_ids.gpu,
                self.req_states.prefill_len.gpu,
                self.req_states.num_computed_tokens.gpu,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
706

707
708
709
        # Prepare positions and seq_lens.
        prepare_pos_seq_lens(
            idx_mapping,
710
711
            query_start_loc,
            self.req_states.num_computed_tokens.gpu,
712
713
714
            self.input_buffers.positions,
            self.input_buffers.seq_lens,
        )
715
        seq_lens = self.input_buffers.seq_lens[:num_reqs_padded]
716

717
        dcp_local_seq_lens = None
718
719
        if self.use_dcp:
            # Prepare dcp local seq_lens.
720
721
            prepare_dcp_local_seq_lens(
                self.input_buffers.dcp_local_seq_lens,
722
                self.input_buffers.seq_lens,
723
                num_reqs,
724
725
726
                self.dcp_size,
                self.dcp_rank,
                self.cp_interleave,
727
            )
728
            dcp_local_seq_lens = self.input_buffers.dcp_local_seq_lens[:num_reqs_padded]
729

730
        # Some input token ids are directly read from the last sampled tokens
731
732
        # and draft tokens. Also, get the logits indices to sample tokens from.
        logits_indices = combine_sampled_and_draft_tokens(
733
            self.input_buffers.input_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
734
735
            idx_mapping,
            self.req_states.last_sampled_tokens,
736
            query_start_loc,
737
738
            seq_lens,
            self.req_states.prefill_len.gpu,
739
740
741
            self.req_states.draft_tokens,
            cu_num_logits,
            total_num_logits,
Woosuk Kwon's avatar
Woosuk Kwon committed
742
743
744
745
746
        )

        return InputBatch(
            req_ids=req_ids,
            num_reqs=num_reqs,
747
            num_reqs_after_padding=num_reqs_padded,
Woosuk Kwon's avatar
Woosuk Kwon committed
748
749
            idx_mapping=idx_mapping,
            idx_mapping_np=idx_mapping_np,
750
            expanded_idx_mapping=expanded_idx_mapping,
751
            expanded_local_pos=expanded_local_pos,
Woosuk Kwon's avatar
Woosuk Kwon committed
752
753
754
            num_scheduled_tokens=num_scheduled_tokens,
            num_tokens=num_tokens,
            num_tokens_after_padding=num_tokens_after_padding,
755
            num_draft_tokens=total_num_draft_tokens,
756
            query_start_loc=query_start_loc,
Woosuk Kwon's avatar
Woosuk Kwon committed
757
            query_start_loc_np=query_start_loc_np,
758
            seq_lens=seq_lens,
759
760
761
            dcp_local_seq_lens=dcp_local_seq_lens,
            input_ids=self.input_buffers.input_ids[:num_tokens_after_padding],
            positions=self.input_buffers.positions[:num_tokens_after_padding],
Woosuk Kwon's avatar
Woosuk Kwon committed
762
            logits_indices=logits_indices,
763
            cu_num_logits=cu_num_logits,
764
            cu_num_logits_np=cu_num_logits_np,
765
            has_structured_output_reqs=scheduler_output.has_structured_output_requests,
Woosuk Kwon's avatar
Woosuk Kwon committed
766
767
        )

768
769
770
    def prepare_attn(
        self, input_batch: InputBatch
    ) -> tuple[tuple[torch.Tensor, ...], torch.Tensor]:
771
772
773
774
775
776
777
        # Block tables: num_kv_cache_groups x [num_reqs_padded, max_num_blocks].
        block_tables = self.block_tables.gather_block_tables(
            input_batch.idx_mapping,
            num_reqs_padded=input_batch.num_reqs_after_padding,
        )
        # Slot mappings: [num_kv_cache_groups, num_tokens_padded].
        # Kernel pads beyond num_tokens with PAD_SLOT_ID.
778
779
780
781
        slot_mappings = self.block_tables.compute_slot_mappings(
            input_batch.idx_mapping,
            input_batch.query_start_loc,
            input_batch.positions,
782
            num_tokens_padded=input_batch.num_tokens_after_padding,
783
784
785
786
787
788
789
790
791
792
793
794
        )
        return block_tables, slot_mappings

    def prepare_dummy_attn(
        self, input_batch: InputBatch
    ) -> tuple[tuple[torch.Tensor, ...], torch.Tensor]:
        block_tables = self.block_tables.get_dummy_block_tables(input_batch.num_reqs)
        slot_mappings = self.block_tables.get_dummy_slot_mappings(
            input_batch.num_tokens
        )
        return block_tables, slot_mappings

Woosuk Kwon's avatar
Woosuk Kwon committed
795
796
797
798
799
    def sample(
        self,
        hidden_states: torch.Tensor,
        input_batch: InputBatch,
        grammar_output: GrammarOutput | None,
800
    ) -> tuple[SamplerOutput, torch.Tensor, torch.Tensor]:
Woosuk Kwon's avatar
Woosuk Kwon committed
801
802
803
804
        sample_hidden_states = hidden_states[input_batch.logits_indices]
        logits = self.model.compute_logits(sample_hidden_states)
        if grammar_output is not None:
            # Apply grammar bitmask to the logits in-place.
805
            assert self.structured_outputs_worker is not None
806
807
808
809
810
811
            self.structured_outputs_worker.apply_grammar_bitmask(
                logits,
                input_batch,
                grammar_output.structured_output_request_ids,
                grammar_output.grammar_bitmask,
            )
812

813
814
        if input_batch.num_draft_tokens == 0:
            # No draft tokens (common case).
815
816
            assert self.sampler is not None
            sampler_output = self.sampler(logits, input_batch)
817
        else:
818
            # Rejection sampling for spec decoding.
819
            assert self.rejection_sampler is not None
820
821
822
823
            sampler_output = self.rejection_sampler(
                logits,
                input_batch,
                # Draft logits are needed for probabilistic rejection sampling.
824
                self.req_states.draft_logits,
825
            )
826
827
828
829

        # Get the number of sampled and rejected tokens.
        # For chunked prefills, num_sampled and num_rejected are both 0.
        num_sampled, num_rejected = get_num_sampled_and_rejected(
830
            sampler_output.num_sampled,
831
832
833
834
835
            input_batch.seq_lens,
            input_batch.cu_num_logits,
            input_batch.idx_mapping,
            self.req_states.prefill_len.gpu,
        )
836
        return sampler_output, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
837
838
839
840

    def postprocess(
        self,
        input_batch: InputBatch,
841
842
        sampled_tokens: torch.Tensor,
        num_sampled: torch.Tensor,
843
        num_rejected: torch.Tensor,
844
845
    ) -> None:
        # Update the number of computed tokens.
846
847
848
849
850
        if self.is_last_pp_rank:
            assert self.sampler is not None
            output_bin_counts = self.sampler.penalties_state.output_bin_counts
        else:
            output_bin_counts = None
851
        post_update(
852
            input_batch.idx_mapping,
853
            self.req_states.num_computed_tokens.gpu,
854
            self.req_states.last_sampled_tokens,
855
            output_bin_counts,
856
857
            sampled_tokens,
            num_sampled,
858
            num_rejected,
859
            input_batch.query_start_loc,
860
861
            self.req_states.all_token_ids.gpu,
            self.req_states.total_len.gpu,
Woosuk Kwon's avatar
Woosuk Kwon committed
862
        )
863
864

        # Update the number of computed prefill tokens.
Woosuk Kwon's avatar
Woosuk Kwon committed
865
        idx_mapping_np = input_batch.idx_mapping_np
866
        computed_prefill = self.req_states.num_computed_prefill_tokens
867
868
869
        computed_prefill[idx_mapping_np] += input_batch.num_scheduled_tokens
        np.minimum(
            computed_prefill, self.req_states.prefill_len.np, out=computed_prefill
Woosuk Kwon's avatar
Woosuk Kwon committed
870
871
872
873
874
875
        )

    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: SchedulerOutput,
876
        intermediate_tensors: IntermediateTensors | None = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
877
        dummy_run: bool = False,
878
        skip_attn_for_dummy_run: bool = False,
879
    ) -> ModelRunnerOutput | IntermediateTensors | None:
880
881
882
883
884
885
886
887
888
        if not dummy_run:
            # Update the request states.
            self.finish_requests(scheduler_output)
            self.free_states(scheduler_output)
            self.add_requests(scheduler_output)
            self.update_requests(scheduler_output)
            self.block_tables.apply_staged_writes()
            if scheduler_output.total_num_scheduled_tokens == 0:
                # No need to run the model.
889
890
                empty_output = self.kv_connector.no_forward(scheduler_output)
                return empty_output
Woosuk Kwon's avatar
Woosuk Kwon committed
891

892
893
894
895
896
897
898
899
        # Get batch descriptor and sync across DP ranks.
        num_reqs = len(scheduler_output.num_scheduled_tokens)
        num_toks = scheduler_output.total_num_scheduled_tokens
        max_query_len = max(scheduler_output.num_scheduled_tokens.values())
        uniform_tok_count = get_uniform_token_count(num_reqs, num_toks, max_query_len)

        batch_desc = self.cudagraph_manager.dispatch(
            num_reqs, num_toks, uniform_tok_count
900
        )
901
        num_tokens_across_dp = None
902

903
904
905
906
907
908
909
910
911
912
913
914
915
        skip_compiled = False
        if self.is_encoder_decoder and scheduler_output.scheduled_encoder_inputs:
            # Encoder-decoder models such as Whisper should run eager/non-compiled
            # when encoder inputs are scheduled, because this step updates
            # cross-attention cache with dynamic encoder outputs.
            # Override batch_desc to NONE.
            skip_compiled = True
            batch_desc = BatchExecutionDescriptor(
                cg_mode=CUDAGraphMode.NONE,
                num_tokens=num_toks,
                num_reqs=num_reqs,
            )

916
917
918
919
920
921
922
923
924
        if self.dp_size > 1:
            batch_desc, num_tokens_across_dp = sync_cudagraph_and_dp_padding(
                self.cudagraph_manager,
                batch_desc,
                num_toks,
                num_reqs,
                uniform_tok_count,
                self.dp_size,
                self.dp_rank,
925
            )
926
927

        if batch_desc.num_tokens == 0:
928
            # All DP ranks have zero tokens to run.
929
930
            empty_output = self.kv_connector.no_forward(scheduler_output)
            return empty_output
931
932
933
934

        if not dummy_run:
            # Common case.
            # Prepare all the inputs and copy to the input buffers.
935
            input_batch = self.prepare_inputs(scheduler_output, batch_desc)
936
937
            block_tables, slot_mappings = self.prepare_attn(input_batch)

938
939
            if self.lora_config:
                # Activate LoRA adapters.
940
                lora_inputs = self.lora_state.make_lora_inputs(
941
942
943
                    input_batch.req_ids,
                    input_batch.idx_mapping_np,
                    input_batch.num_scheduled_tokens,
Woosuk Kwon's avatar
Woosuk Kwon committed
944
                )
945
946
                self._set_active_loras(*lora_inputs)
        else:
947
            # No actual tokens to run. A dummy run for DP or memory profiling.
948
            input_batch = InputBatch.make_dummy(
949
950
951
                batch_desc.num_reqs or num_reqs,
                batch_desc.num_tokens,
                self.input_buffers,
952
            )
953
            if not skip_attn_for_dummy_run:
954
955
956
957
                block_tables, slot_mappings = self.prepare_dummy_attn(input_batch)
            else:
                block_tables = None
                slot_mappings = None
958
            # FIXME(woosuk): Fix warmup for LoRA.
Woosuk Kwon's avatar
Woosuk Kwon committed
959

960
961
962
963
964
965
966
967
968
969
        attn_metadata = None
        slot_mappings_by_layer = None
        if not (dummy_run and skip_attn_for_dummy_run):
            assert slot_mappings is not None
            slot_mappings_by_layer = build_slot_mappings_by_layer(
                slot_mappings, self.kv_cache_config
            )
            assert block_tables is not None
            attn_metadata = self.model_state.prepare_attn(
                input_batch,
970
                batch_desc.cg_mode,
971
972
973
974
975
976
                block_tables,
                slot_mappings,
                self.attn_groups,
                self.kv_cache_config,
            )

977
        inputs_embeds = None
978
        if self.supports_mm_inputs and self.is_first_pp_rank:
979
980
            # Run MM encoder (if needed) and get multimodal embeddings.
            # Only first PP rank prepares multimodal embeddings.
981
982
            # NOTE(woosuk): We must call get_mm_embeddings even during dummy runs
            # to obtain inputs_embeds, because the compiled model expects this input.
983
984
985
986
987
988
            inputs_embeds = self.model_state.get_mm_embeddings(
                scheduler_output.scheduled_encoder_inputs,
                input_batch,
                self.req_states,
            )

989
990
991
        model_inputs = {
            "input_ids": input_batch.input_ids,
            "positions": input_batch.positions,
992
            "inputs_embeds": inputs_embeds,
993
            "intermediate_tensors": intermediate_tensors,
994
995
996
997
998
999
1000
1001
            # NOTE: Values returned by `prepare_inputs` will override the default
            # values above.
            **self.model_state.prepare_inputs(input_batch, self.req_states),
        }
        if not self.is_first_pp_rank:
            # Update for non-first PP ranks.
            model_inputs["input_ids"] = None
            model_inputs["inputs_embeds"] = None
1002
            assert intermediate_tensors is not None
1003

Woosuk Kwon's avatar
Woosuk Kwon committed
1004
        # Run model.
1005
        if batch_desc.cg_mode == CUDAGraphMode.FULL:
1006
            # Use explicit cudagraph replay for FULL mode.
Woosuk Kwon's avatar
Woosuk Kwon committed
1007
1008
            # NOTE(woosuk): Here, we don't need to pass the input tensors,
            # because they are already copied to the CUDA graph input buffers.
1009
            self.kv_connector.pre_forward(scheduler_output)
1010
            model_output = self.cudagraph_manager.run_fullgraph(batch_desc)
1011
1012
1013
1014
1015
            if self.use_aux_hidden_state_outputs:
                hidden_states, aux_hidden_states = model_output
            else:
                hidden_states = model_output
                aux_hidden_states = None
Woosuk Kwon's avatar
Woosuk Kwon committed
1016
        else:
1017
1018
1019
1020
1021
1022
            # For piecewise and eager mode, just call model().
            batch_descriptor = BatchDescriptor(
                num_tokens=input_batch.num_tokens_after_padding,
                has_lora=self.lora_config is not None,
            )

Woosuk Kwon's avatar
Woosuk Kwon committed
1023
            with set_forward_context(
1024
                attn_metadata,
Woosuk Kwon's avatar
Woosuk Kwon committed
1025
1026
                self.vllm_config,
                num_tokens=input_batch.num_tokens_after_padding,
1027
                cudagraph_runtime_mode=batch_desc.cg_mode,
Woosuk Kwon's avatar
Woosuk Kwon committed
1028
                num_tokens_across_dp=num_tokens_across_dp,
1029
                batch_descriptor=batch_descriptor,
1030
                slot_mapping=slot_mappings_by_layer,
1031
                skip_compiled=skip_compiled,
Woosuk Kwon's avatar
Woosuk Kwon committed
1032
            ):
1033
                self.kv_connector.pre_forward(scheduler_output)
1034
                model_output = self.model(**model_inputs)
1035
1036
1037
1038
1039
                if self.use_aux_hidden_state_outputs:
                    hidden_states, aux_hidden_states = model_output
                else:
                    hidden_states = model_output
                    aux_hidden_states = None
Woosuk Kwon's avatar
Woosuk Kwon committed
1040

1041
        kv_connector_output = self.kv_connector.post_forward(scheduler_output)
1042
1043
1044
1045
1046
1047
1048
1049
        self.execute_model_state = ExecuteModelState(
            input_batch=input_batch,
            attn_metadata=attn_metadata,
            slot_mappings_by_layer=slot_mappings_by_layer,
            hidden_states=hidden_states,
            aux_hidden_states=aux_hidden_states,
            kv_connector_output=kv_connector_output,
            num_tokens_across_dp=num_tokens_across_dp,
1050
        )
1051

1052
        if not self.is_last_pp_rank:
1053
1054
1055
1056
1057
            # Non-last PP rank: return IntermediateTensors for sending.
            assert isinstance(hidden_states, IntermediateTensors)
            hidden_states.kv_connector_output = kv_connector_output
            return hidden_states
        # Last rank (or no PP): hidden_states is a tensor for sampling.
1058
        assert isinstance(hidden_states, torch.Tensor)
Woosuk Kwon's avatar
Woosuk Kwon committed
1059
1060
1061
1062
        return None

    @torch.inference_mode()
    def sample_tokens(
1063
        self, grammar_output: GrammarOutput | None
1064
    ) -> AsyncOutput | ModelRunnerOutput | None:
1065
1066
1067
        if self.execute_model_state is None:
            # The prior execute_model call must have failed.
            return None
1068
1069
1070
1071
1072
1073
1074
1075

        input_batch = self.execute_model_state.input_batch
        attn_metadata = self.execute_model_state.attn_metadata
        slot_mappings_by_layer = self.execute_model_state.slot_mappings_by_layer
        hidden_states = self.execute_model_state.hidden_states
        aux_hidden_states = self.execute_model_state.aux_hidden_states
        kv_connector_output = self.execute_model_state.kv_connector_output
        num_tokens_across_dp = self.execute_model_state.num_tokens_across_dp
1076
        self.execute_model_state = None
Woosuk Kwon's avatar
Woosuk Kwon committed
1077

1078
        if not self.is_last_pp_rank:
1079
1080
1081
1082
            # Non-last PP rank: hidden_states is None because this rank produced
            # IntermediateTensors instead of final hidden states. Receive the
            # sampled tokens broadcast from the last rank and update local state.
            sampled, num_sampled, num_rejected = pp_receive(
1083
                input_batch.num_reqs, max_sample_len=self.num_speculative_steps + 1
1084
            )
1085
            self.postprocess(input_batch, sampled, num_sampled, num_rejected)
1086
1087
1088
            return None

        # Last rank: sample tokens
1089
        sampler_output, num_sampled, num_rejected = self.sample(
1090
            hidden_states, input_batch, grammar_output
Woosuk Kwon's avatar
Woosuk Kwon committed
1091
        )
1092
1093

        if self.use_pp:
1094
            # Broadcast to non-last PP ranks (handles spec decode multi-token).
1095
            pp_broadcast(sampler_output.sampled_token_ids, num_sampled, num_rejected)
1096

1097
        assert self.prompt_logprobs_worker is not None
1098
1099
1100
1101
        prompt_logprobs_dict = self.prompt_logprobs_worker.compute_prompt_logprobs(
            self.model.compute_logits,
            hidden_states,
            input_batch,
1102
            self.req_states.all_token_ids.gpu,
1103
            self.req_states.num_computed_tokens.gpu,
1104
            self.req_states.prompt_len.np,
1105
1106
1107
            self.req_states.prefill_len.np,
            self.req_states.num_computed_prefill_tokens,
        )
1108
1109
1110
1111
1112
1113
1114
1115

        # Prepare the model runner output.
        model_runner_output = ModelRunnerOutput(
            req_ids=input_batch.req_ids,
            # NOTE(woosuk): req_id_to_index is unused in this model runner.
            # Only for compatibility with the existing model runner and scheduler.
            req_id_to_index={req_id: i for i, req_id in enumerate(input_batch.req_ids)},
            sampled_token_ids=None,  # type: ignore
1116
            prompt_logprobs_dict=prompt_logprobs_dict,  # type: ignore[arg-type]
1117
            kv_connector_output=kv_connector_output,
1118
1119
1120
1121
        )
        async_output = AsyncOutput(
            model_runner_output=model_runner_output,
            sampler_output=sampler_output,
1122
            num_sampled_tokens=num_sampled,
1123
            main_stream=self.main_stream,
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
            copy_stream=self.output_copy_stream,
            copy_event=self.output_copy_event,
        )

        # Postprocess results and update request states.
        # NOTE: This is intentionally done after creating the AsyncOutput,
        # ensuring that `copy_event` is recorded before calling postprocess.
        # This sequencing may slightly reduce latency as async D2H copy does not
        # need to wait for the postprocess to finish.
        self.postprocess(
1134
            input_batch, sampler_output.sampled_token_ids, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
1135
        )
1136
        if self.speculator is not None:
1137
            assert self.sampler is not None
1138
            draft_tokens = self.speculator.propose(
1139
                input_batch,
1140
1141
                attn_metadata,
                slot_mappings_by_layer,
1142
                hidden_states,
1143
                aux_hidden_states,
1144
1145
                num_sampled,
                num_rejected,
1146
1147
1148
1149
                self.req_states.last_sampled_tokens,
                self.req_states.next_prefill_tokens,
                self.sampler.sampling_states.temperature.gpu,
                self.sampler.sampling_states.seeds.gpu,
1150
                self.req_states.draft_logits,
1151
                num_tokens_across_dp=num_tokens_across_dp,
1152
            )
1153
            self.req_states.draft_tokens[input_batch.idx_mapping] = draft_tokens
1154
            self.draft_tokens_handler.set_draft_tokens(input_batch, draft_tokens)
1155
1156
1157
1158

        if self.use_async_scheduling:
            return async_output
        return async_output.get_output()
1159
1160
1161

    def take_draft_token_ids(self) -> DraftTokenIds | None:
        return self.draft_tokens_handler.get_draft_tokens()
1162
1163
1164
1165
1166
1167
1168

    @torch.inference_mode()
    def pool(self) -> AsyncPoolingOutput | ModelRunnerOutput | None:
        if self.execute_model_state is None:
            # The prior execute_model call must have failed.
            return None

1169
1170
1171
        input_batch = self.execute_model_state.input_batch
        hidden_states = self.execute_model_state.hidden_states
        kv_connector_output = self.execute_model_state.kv_connector_output
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
        self.execute_model_state = None

        if not self.is_last_pp_rank:
            self.postprocess_pool(input_batch)
            return None

        assert self.pooling_runner is not None
        pooler_output, is_valid = self.pooling_runner.pool(
            hidden_states, input_batch, self.req_states
        )
        self.postprocess_pool(input_batch)

        # Build the model runner output.
        model_runner_output = ModelRunnerOutput(
            req_ids=input_batch.req_ids,
            req_id_to_index={req_id: i for i, req_id in enumerate(input_batch.req_ids)},
            kv_connector_output=kv_connector_output,
        )
        async_output = AsyncPoolingOutput(
            model_runner_output=model_runner_output,
            pooler_output=pooler_output,
            is_valid=is_valid,
            main_stream=self.main_stream,
            copy_stream=self.output_copy_stream,
            copy_event=self.output_copy_event,
        )
        if self.use_async_scheduling:
            return async_output
        return async_output.get_output()

    def postprocess_pool(self, input_batch: InputBatch) -> None:
        # Update the number of computed tokens.
        post_update_pool(
            input_batch.idx_mapping,
            self.req_states.num_computed_tokens.gpu,
            input_batch.query_start_loc,
        )

        # Update the number of computed prefill tokens.
        idx_mapping_np = input_batch.idx_mapping_np
        computed_prefill = self.req_states.num_computed_prefill_tokens
        computed_prefill[idx_mapping_np] += input_batch.num_scheduled_tokens
        np.minimum(
            computed_prefill, self.req_states.prefill_len.np, out=computed_prefill
        )
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226


class ExecuteModelState(NamedTuple):
    input_batch: InputBatch
    attn_metadata: dict[str, Any] | None
    slot_mappings_by_layer: dict[str, torch.Tensor] | None
    hidden_states: torch.Tensor | IntermediateTensors
    aux_hidden_states: list[torch.Tensor] | None
    kv_connector_output: KVConnectorOutput | None
    num_tokens_across_dp: torch.Tensor | None