model_runner.py 48.4 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

Woosuk Kwon's avatar
Woosuk Kwon committed
129
130
131
132
        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()

133
134
135
136
137
138
139
140
141
142
        # 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

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

147
148
149
150
151
152
        # 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

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

162
        self.speculator = None
163
        self.num_speculative_steps = 0
164
        self.use_aux_hidden_state_outputs = False
165
        use_strict_rejection_sampling = False
166
167
        if self.speculative_config is not None:
            self.num_speculative_steps = self.speculative_config.num_speculative_tokens
168
169
170
171
172
173
174
175
            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.")
176
177
178
            use_strict_rejection_sampling = (
                self.speculative_config.rejection_sample_method == "strict"
            )
179
180
181
182

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

Woosuk Kwon's avatar
Woosuk Kwon committed
183
184
185
186
        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,
187
            num_speculative_steps=self.num_speculative_steps,
Woosuk Kwon's avatar
Woosuk Kwon committed
188
189
            vocab_size=self.vocab_size,
            device=self.device,
190
191
            model_dtype=self.dtype,
            cache_draft_logits=not use_strict_rejection_sampling,
Woosuk Kwon's avatar
Woosuk Kwon committed
192
193
194
195
196
197
        )
        self.input_buffers = InputBuffers(
            max_num_reqs=self.max_num_reqs,
            max_num_tokens=self.max_num_tokens,
            device=self.device,
        )
198
199
200
201
        self.sampler = Sampler(
            max_num_reqs=self.max_num_reqs,
            vocab_size=self.vocab_size,
            device=self.device,
202
            req_states=self.req_states,
203
            logprobs_mode=self.model_config.logprobs_mode,
204
            num_speculative_tokens=self.num_speculative_steps + 1,
205
        )
206
207
208
209
210
        self.rejection_sampler = RejectionSampler(
            self.sampler,
            num_speculative_steps=self.num_speculative_steps,
            use_strict_rejection_sampling=use_strict_rejection_sampling,
        )
211
        self.prompt_logprobs_worker = PromptLogprobsWorker(self.max_num_reqs)
Woosuk Kwon's avatar
Woosuk Kwon committed
212
213

        # CUDA graphs.
214
215
        self.decode_query_len = self.num_speculative_steps + 1
        self.cudagraph_manager = ModelCudaGraphManager(
216
217
            self.vllm_config,
            self.device,
218
219
            self.compilation_config.cudagraph_mode,
            decode_query_len=self.decode_query_len,
220
        )
221
222
223
224
        # Structured outputs worker.
        self.structured_outputs_worker = StructuredOutputsWorker(
            max_num_logits=self.max_num_reqs * (self.num_speculative_steps + 1),
            vocab_size=self.vocab_size,
225
            device=self.device,
226
        )
227
228
        # LoRA-related workers.
        self.lora_state = LoraState(max_num_reqs=self.max_num_reqs)
229
        # KV Connector if configured.
230
231
        self.kv_connector: KVConnector = NO_OP_KV_CONNECTOR

232
233
234
235
        # Pooling models.
        self.is_pooling_model = self.model_config.runner_type == "pooling"
        self.pooling_runner: PoolingRunner | None = None

236
        # For transferring state from execute_model to subsequent sample_tokens call.
237
        self.execute_model_state: ExecuteModelState | None = None
238

239
240
241
242
    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

243
244
245
246
247
248
249
    def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
        tasks: list[SupportedTask] = []
        if self.model_config.runner_type == "generate":
            tasks.append("generate")
        if self.pooling_runner is not None:
            tasks.extend(self.pooling_runner.get_supported_pooling_tasks())
        return tuple(tasks)
Woosuk Kwon's avatar
Woosuk Kwon committed
250
251
252
253
254
255
256
257
258
259
260
261
262

    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(
263
                    self.model, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
264
                )
265
266
267
268
269

            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:
270
                self.speculator.load_model(self.model)
Woosuk Kwon's avatar
Woosuk Kwon committed
271
272
273
274
        time_after_load = time.perf_counter()

        self.model_memory_usage = m.consumed_memory
        logger.info(
275
276
            "Model loading took %s GiB and %.6f seconds",
            format_gib(m.consumed_memory),
Woosuk Kwon's avatar
Woosuk Kwon committed
277
278
279
            time_after_load - time_before_load,
        )

280
        prepare_communication_buffer_for_model(self.model)
281
        if self.speculator is not None:
282
            prepare_communication_buffer_for_model(self.speculator.model)
283

284
        # Initialize the components that require the model.
285
        self.model_state = init_model_state(
286
287
            self.vllm_config, self.model, self.encoder_cache, self.device
        )
288
289
        if self.is_pooling_model:
            self.pooling_runner = PoolingRunner(self.model)
290

Woosuk Kwon's avatar
Woosuk Kwon committed
291
292
293
    def get_model(self) -> nn.Module:
        return self.model

294
295
296
297
298
    @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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
    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
        ]

        self.block_tables = BlockTables(
            block_sizes=block_sizes,
            max_num_reqs=self.max_num_reqs,
            max_num_batched_tokens=self.max_num_tokens,
            max_model_len=self.max_model_len,
            device=self.device,
316
317
318
            cp_size=self.dcp_size,
            cp_rank=self.dcp_rank,
            cp_interleave=self.cp_interleave,
Woosuk Kwon's avatar
Woosuk Kwon committed
319
320
        )

321
        self.attn_backends, self.attn_groups = init_attn_backend(
322
            self.kv_cache_config, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
323
        )
324
        check_attention_cp_compatibility(self.vllm_config)
325
        if self.speculator is not None:
326
327
            # HACK(woosuk)
            self.speculator.set_attn(
328
                self.model_state,
329
                self.kv_cache_config,
330
                self.attn_groups,
331
332
                self.block_tables,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
333
334

        self.kv_caches: list[torch.Tensor] = []
335
        kv_caches_dict = init_kv_cache(
Woosuk Kwon's avatar
Woosuk Kwon committed
336
337
338
339
340
341
            self.kv_caches,
            self.compilation_config.static_forward_context,
            self.kv_cache_config,
            self.attn_backends,
            self.device,
        )
342
343
        self.kv_connector = get_kv_connector(self.vllm_config, kv_caches_dict)

Woosuk Kwon's avatar
Woosuk Kwon committed
344
345
    @torch.inference_mode()
    def _dummy_run(
346
347
348
349
350
351
        self,
        num_tokens: int,
        *args,
        skip_attn: bool = True,
        uniform_decode: bool = False,
        **kwargs,
352
    ) -> tuple[torch.Tensor | None, torch.Tensor | None]:
353
        # Create a dummy scheduler output.
354
        num_reqs = min(num_tokens, self.max_num_reqs)
355
        if uniform_decode:
356
357
358
359
360
361
362
363
364
365
            # 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

366
367
        assert sum(num_tokens_per_request) == num_tokens
        num_scheduled_tokens = {
368
            f"_dummy_req_{i}": n for i, n in enumerate(num_tokens_per_request)
369
370
371
372
373
        }
        dummy_scheduler_output = SchedulerOutput.make_empty()
        dummy_scheduler_output.total_num_scheduled_tokens = num_tokens
        dummy_scheduler_output.num_scheduled_tokens = num_scheduled_tokens

374
375
376
        # Disable any use of KVConnector for dummy runs.
        self.kv_connector.set_disabled(True)

377
378
        # For non-first PP ranks, create dummy intermediate_tensors.
        intermediate_tensors = None
379
        if not self.is_first_pp_rank:
380
381
382
383
384
385
            intermediate_tensors = self.model.make_empty_intermediate_tensors(
                batch_size=num_tokens,
                dtype=self.model_config.dtype,
                device=self.device,
            )

386
387
        # Execute the model.
        self.execute_model(
388
389
390
391
            dummy_scheduler_output,
            intermediate_tensors=intermediate_tensors,
            dummy_run=True,
            skip_attn_for_dummy_run=skip_attn,
392
        )
393
        self.kv_connector.set_disabled(False)
394
395

        # Non-last PP ranks don't produce output for sampling.
396
        if not self.is_last_pp_rank:
397
398
            return None, None

399
        assert self.execute_model_state is not None
400
401
402
403
404
405
        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
406
        self.execute_model_state = None
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425

        # dummy run the eagle speculator's propose to ensure DP/EP sync.
        if self.speculator is not None:
            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,
426
                draft_logits_out=self.req_states.draft_logits,
427
428
429
430
431
                num_tokens_across_dp=num_tokens_across_dp,
                dummy_run=True,
                skip_attn_for_dummy_run=skip_attn,
            )

432
        assert hidden_states is not None  # Last PP rank always has hidden_states
433
        sample_hidden_states = hidden_states[input_batch.logits_indices]
Woosuk Kwon's avatar
Woosuk Kwon committed
434
435
436
        return hidden_states, sample_hidden_states

    @torch.inference_mode()
437
    def _dummy_sampler_run(self, hidden_states: torch.Tensor) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
438
439
        num_reqs = hidden_states.shape[0]
        logits = self.model.compute_logits(hidden_states)
440
441
        dummy_input_batch = InputBatch.make_dummy(
            num_reqs, num_reqs, self.input_buffers
442
        )
443

444
445
446
        # 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.
447
448
        self.sampler(
            logits,
449
            dummy_input_batch,
450
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
451

452
453
454
455
456
    @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
457
458
459
    @torch.inference_mode()
    def profile_run(self) -> None:
        hidden_states, sample_hidden_states = self._dummy_run(
460
            self.max_num_tokens, skip_attn=True
Woosuk Kwon's avatar
Woosuk Kwon committed
461
        )
462

463
        # Only run sampler/pooler on last PP rank (non-last ranks return None).
464
        if self.is_last_pp_rank:
465
            assert sample_hidden_states is not None
466
467
468
469
            if self.pooling_runner is None:
                self._dummy_sampler_run(sample_hidden_states)
            else:
                self._dummy_pooler_run(hidden_states)
470

471
        torch.accelerator.synchronize()
Woosuk Kwon's avatar
Woosuk Kwon committed
472
473
474
475
        del hidden_states, sample_hidden_states
        gc.collect()

    def reset_mm_cache(self) -> None:
476
477
        if self.encoder_cache is not None:
            self.encoder_cache.reset_mm_cache()
478
479

    def reset_encoder_cache(self) -> None:
480
481
        if self.encoder_cache is not None:
            self.encoder_cache.reset_encoder_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
482
483
484
485
486

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

487
488
489
490
    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
491
492
493
494
495
496
497
498
499
    @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

500
501
502
503
504
505
506
507
        # 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
508
        start_time = time.perf_counter()
509
        gc.collect()
510
        torch.accelerator.empty_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
511
512
513
514
        start_free_gpu_memory = torch.cuda.mem_get_info()[0]

        with self.maybe_setup_dummy_loras(self.lora_config):
            self.cudagraph_manager.capture(
515
516
517
518
519
520
                self.model,
                self.model_state,
                self.input_buffers,
                self.block_tables,
                self.attn_groups,
                self.kv_cache_config,
521
                has_lora=self.lora_config is not None,
522
                use_aux_hidden_state_outputs=self.use_aux_hidden_state_outputs,
Woosuk Kwon's avatar
Woosuk Kwon committed
523
            )
524
            if self.speculator is not None:
525
                self.speculator.capture_model()
Woosuk Kwon's avatar
Woosuk Kwon committed
526
527
528
529
530
531
532
533
534
535
536
537
538

        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

539
    def finish_requests(self, scheduler_output: SchedulerOutput) -> None:
540
        finished_req_ids = scheduler_output.finished_req_ids
541
542
543
        preempted_req_ids = scheduler_output.preempted_req_ids
        if preempted_req_ids:
            finished_req_ids = finished_req_ids.union(preempted_req_ids)
544
        for req_id in finished_req_ids:
Woosuk Kwon's avatar
Woosuk Kwon committed
545
            self.req_states.remove_request(req_id)
546
547
            if self.encoder_cache is not None:
                self.encoder_cache.remove_request(req_id)
548
            self.prompt_logprobs_worker.remove_request(req_id)
549
            self.lora_state.remove_request(req_id)
550

551
    def free_states(self, scheduler_output: SchedulerOutput) -> None:
552
        if self.encoder_cache is not None:
553
            for mm_hash in scheduler_output.free_encoder_mm_hashes:
554
                self.encoder_cache.free_encoder_cache(mm_hash)
Woosuk Kwon's avatar
Woosuk Kwon committed
555

556
    def add_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
557
        for new_req_data in scheduler_output.scheduled_new_reqs:
558
559
            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
560
            req_id = new_req_data.req_id
561
            prompt_len = len(new_req_data.prompt_token_ids)
Woosuk Kwon's avatar
Woosuk Kwon committed
562
563
            self.req_states.add_request(
                req_id=req_id,
564
                prompt_len=prompt_len,
565
                all_token_ids=new_req_data.prefill_token_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
566
567
568
                num_computed_tokens=new_req_data.num_computed_tokens,
            )
            req_index = self.req_states.req_id_to_index[req_id]
569

570
571
            if self.encoder_cache is not None:
                self.encoder_cache.add_request(req_id, new_req_data.mm_features)
572

573
            self.model_state.add_request(req_index, new_req_data)
574
575
576
            self.block_tables.append_block_ids(
                req_index, new_req_data.block_ids, overwrite=True
            )
577
            self.lora_state.add_request(req_id, req_index, new_req_data.lora_request)
Woosuk Kwon's avatar
Woosuk Kwon committed
578

579
580
581
582
583
584
585
586
            if new_req_data.sampling_params is not None:
                self.sampler.add_request(
                    req_index, prompt_len, new_req_data.sampling_params
                )
                self.prompt_logprobs_worker.add_request(
                    req_id, req_index, new_req_data.sampling_params
                )

587
588
        if scheduler_output.scheduled_new_reqs:
            self.req_states.apply_staged_writes()
589
            self.sampler.apply_staged_writes()
590
            self.model_state.apply_staged_writes()
591
592

    def update_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
593
        # Add new blocks for the existing requests.
594
595
        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
596
            if req_new_block_ids is not None:
597
                req_index = self.req_states.req_id_to_index[req_id]
598
599
600
                self.block_tables.append_block_ids(
                    req_index, req_new_block_ids, overwrite=False
                )
Woosuk Kwon's avatar
Woosuk Kwon committed
601
602

    def prepare_inputs(
603
        self, scheduler_output: SchedulerOutput, batch_desc: BatchExecutionDescriptor
Woosuk Kwon's avatar
Woosuk Kwon committed
604
605
    ) -> InputBatch:
        num_tokens = scheduler_output.total_num_scheduled_tokens
606
        num_tokens_after_padding = batch_desc.num_tokens
Woosuk Kwon's avatar
Woosuk Kwon committed
607
        assert num_tokens > 0
608
609
        num_tokens_per_req = scheduler_output.num_scheduled_tokens
        num_reqs = len(num_tokens_per_req)
Woosuk Kwon's avatar
Woosuk Kwon committed
610
611
612

        # Decode first, then prefill.
        # batch_idx -> req_id
613
614
615
        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
616

617
618
        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)
619
        idx_mapping = async_copy_to_gpu(idx_mapping_np, device=self.device)
Woosuk Kwon's avatar
Woosuk Kwon committed
620

621
        # Get the number of draft tokens for each request.
622
623
        draft_tokens = scheduler_output.scheduled_spec_decode_tokens
        if not draft_tokens:
624
625
626
            # No draft token scheduled (common case).
            total_num_draft_tokens = 0
            total_num_logits = num_reqs
627
            cu_num_logits_np = np.arange(num_reqs + 1, dtype=np.int32)
628
629
630
            cu_num_logits = torch.arange(
                num_reqs + 1, device=self.device, dtype=torch.int32
            )
631
            expanded_idx_mapping = idx_mapping
632
633
634
            expanded_local_pos = torch.zeros(
                num_reqs, dtype=torch.int32, device=self.device
            )
635
        else:
636
637
            num_draft_tokens = np.fromiter(
                (len(draft_tokens.get(req_id, ())) for req_id in req_ids),
638
                dtype=np.int32,
639
                count=num_reqs,
640
641
642
643
            )
            total_num_draft_tokens = int(num_draft_tokens.sum())
            total_num_logits = num_reqs + total_num_draft_tokens

644
645
646
647
            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:])
648
            cu_num_logits = async_copy_to_gpu(cu_num_logits_np, device=self.device)
649

650
            max_expand_len = self.num_speculative_steps + 1
651
            expanded_idx_mapping, expanded_local_pos = expand_idx_mapping(
652
                idx_mapping, total_num_logits, cu_num_logits, max_expand_len
653
654
            )

655
        # Get query_start_loc.
656
657
        # num_reqs_padded is None for PIECEWISE graphs (no request padding needed)
        num_reqs_padded = batch_desc.num_reqs or num_reqs
658
659
660
        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])
661
662
        # Pad for full CUDA graph mode.
        # Some attention backends like FA3 require query_start_loc to be non-decreasing.
663
        query_start_loc_np[num_reqs + 1 :] = num_tokens
664
        async_copy_to_gpu(query_start_loc_np, out=self.input_buffers.query_start_loc)
665
666
        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]
667

668
669
670
671
672
673
674
675
676
677
678
        # 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
679

680
681
682
        # Prepare positions and seq_lens.
        prepare_pos_seq_lens(
            idx_mapping,
683
684
            query_start_loc,
            self.req_states.num_computed_tokens.gpu,
685
686
687
            self.input_buffers.positions,
            self.input_buffers.seq_lens,
        )
688
        seq_lens = self.input_buffers.seq_lens[:num_reqs_padded]
689

690
        dcp_local_seq_lens = None
691
692
        if self.use_dcp:
            # Prepare dcp local seq_lens.
693
694
            prepare_dcp_local_seq_lens(
                self.input_buffers.dcp_local_seq_lens,
695
                self.input_buffers.seq_lens,
696
                num_reqs,
697
698
699
                self.dcp_size,
                self.dcp_rank,
                self.cp_interleave,
700
            )
701
            dcp_local_seq_lens = self.input_buffers.dcp_local_seq_lens[:num_reqs_padded]
702

703
        # Some input token ids are directly read from the last sampled tokens
704
705
        # and draft tokens. Also, get the logits indices to sample tokens from.
        logits_indices = combine_sampled_and_draft_tokens(
706
            self.input_buffers.input_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
707
708
            idx_mapping,
            self.req_states.last_sampled_tokens,
709
            query_start_loc,
710
711
            seq_lens,
            self.req_states.prefill_len.gpu,
712
713
714
            self.req_states.draft_tokens,
            cu_num_logits,
            total_num_logits,
Woosuk Kwon's avatar
Woosuk Kwon committed
715
716
717
718
719
        )

        return InputBatch(
            req_ids=req_ids,
            num_reqs=num_reqs,
720
            num_reqs_after_padding=num_reqs_padded,
Woosuk Kwon's avatar
Woosuk Kwon committed
721
722
            idx_mapping=idx_mapping,
            idx_mapping_np=idx_mapping_np,
723
            expanded_idx_mapping=expanded_idx_mapping,
724
            expanded_local_pos=expanded_local_pos,
Woosuk Kwon's avatar
Woosuk Kwon committed
725
726
727
            num_scheduled_tokens=num_scheduled_tokens,
            num_tokens=num_tokens,
            num_tokens_after_padding=num_tokens_after_padding,
728
            num_draft_tokens=total_num_draft_tokens,
729
            query_start_loc=query_start_loc,
Woosuk Kwon's avatar
Woosuk Kwon committed
730
            query_start_loc_np=query_start_loc_np,
731
            seq_lens=seq_lens,
732
733
734
            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
735
            logits_indices=logits_indices,
736
            cu_num_logits=cu_num_logits,
737
            cu_num_logits_np=cu_num_logits_np,
738
            has_structured_output_reqs=scheduler_output.has_structured_output_requests,
Woosuk Kwon's avatar
Woosuk Kwon committed
739
740
        )

741
742
743
    def prepare_attn(
        self, input_batch: InputBatch
    ) -> tuple[tuple[torch.Tensor, ...], torch.Tensor]:
744
745
746
747
748
749
750
        # 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.
751
752
753
754
        slot_mappings = self.block_tables.compute_slot_mappings(
            input_batch.idx_mapping,
            input_batch.query_start_loc,
            input_batch.positions,
755
            num_tokens_padded=input_batch.num_tokens_after_padding,
756
757
758
759
760
761
762
763
764
765
766
767
        )
        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
768
769
770
771
772
    def sample(
        self,
        hidden_states: torch.Tensor,
        input_batch: InputBatch,
        grammar_output: GrammarOutput | None,
773
    ) -> tuple[SamplerOutput, torch.Tensor, torch.Tensor]:
Woosuk Kwon's avatar
Woosuk Kwon committed
774
775
776
777
        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.
778
779
780
781
782
783
            self.structured_outputs_worker.apply_grammar_bitmask(
                logits,
                input_batch,
                grammar_output.structured_output_request_ids,
                grammar_output.grammar_bitmask,
            )
784

785
786
        if input_batch.num_draft_tokens == 0:
            # No draft tokens (common case).
787
788
789
790
            sampler_output = self.sampler(
                logits,
                input_batch,
            )
791
        else:
792
            # Rejection sampling for spec decoding.
793
794
795
796
797
798
799
            sampler_output = self.rejection_sampler(
                logits,
                input_batch,
                # Draft logits are needed for probabilistic rejection sampling.
                self.req_states.draft_logits[input_batch.idx_mapping]
                if self.req_states.draft_logits is not None
                else None,
800
            )
801
802
803
804

        # 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(
805
            sampler_output.num_sampled,
806
807
808
809
810
            input_batch.seq_lens,
            input_batch.cu_num_logits,
            input_batch.idx_mapping,
            self.req_states.prefill_len.gpu,
        )
811
        return sampler_output, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
812
813
814
815

    def postprocess(
        self,
        input_batch: InputBatch,
816
817
        sampled_tokens: torch.Tensor,
        num_sampled: torch.Tensor,
818
        num_rejected: torch.Tensor,
819
820
    ) -> None:
        # Update the number of computed tokens.
821
        post_update(
822
            input_batch.idx_mapping,
823
            self.req_states.num_computed_tokens.gpu,
824
            self.req_states.last_sampled_tokens,
825
            self.sampler.penalties_state.output_bin_counts,
826
827
            sampled_tokens,
            num_sampled,
828
            num_rejected,
829
            input_batch.query_start_loc,
830
831
            self.req_states.all_token_ids.gpu,
            self.req_states.total_len.gpu,
Woosuk Kwon's avatar
Woosuk Kwon committed
832
        )
833
834

        # Update the number of computed prefill tokens.
Woosuk Kwon's avatar
Woosuk Kwon committed
835
        idx_mapping_np = input_batch.idx_mapping_np
836
        computed_prefill = self.req_states.num_computed_prefill_tokens
837
838
839
        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
840
841
842
843
844
845
        )

    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: SchedulerOutput,
846
        intermediate_tensors: IntermediateTensors | None = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
847
        dummy_run: bool = False,
848
        skip_attn_for_dummy_run: bool = False,
849
    ) -> ModelRunnerOutput | IntermediateTensors | None:
850
851
852
853
854
855
856
857
858
        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.
859
860
                empty_output = self.kv_connector.no_forward(scheduler_output)
                return empty_output
Woosuk Kwon's avatar
Woosuk Kwon committed
861

862
863
864
865
866
867
868
869
        # 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
870
        )
871
        num_tokens_across_dp = None
872

873
874
875
876
877
878
879
880
881
        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,
882
            )
883
884

        if batch_desc.num_tokens == 0:
885
            # All DP ranks have zero tokens to run.
886
887
            empty_output = self.kv_connector.no_forward(scheduler_output)
            return empty_output
888
889
890
891

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

895
896
            if self.lora_config:
                # Activate LoRA adapters.
897
                lora_inputs = self.lora_state.make_lora_inputs(
898
899
900
                    input_batch.req_ids,
                    input_batch.idx_mapping_np,
                    input_batch.num_scheduled_tokens,
Woosuk Kwon's avatar
Woosuk Kwon committed
901
                )
902
903
                self._set_active_loras(*lora_inputs)
        else:
904
            # No actual tokens to run. A dummy run for DP or memory profiling.
905
            input_batch = InputBatch.make_dummy(
906
907
908
                batch_desc.num_reqs or num_reqs,
                batch_desc.num_tokens,
                self.input_buffers,
909
            )
910
            if not skip_attn_for_dummy_run:
911
912
913
914
                block_tables, slot_mappings = self.prepare_dummy_attn(input_batch)
            else:
                block_tables = None
                slot_mappings = None
915
            # FIXME(woosuk): Fix warmup for LoRA.
Woosuk Kwon's avatar
Woosuk Kwon committed
916

917
918
919
920
921
922
923
924
925
926
        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,
927
                batch_desc.cg_mode,
928
929
930
931
932
933
                block_tables,
                slot_mappings,
                self.attn_groups,
                self.kv_cache_config,
            )

934
        inputs_embeds = None
935
        if self.supports_mm_inputs and self.is_first_pp_rank:
936
937
            # Run MM encoder (if needed) and get multimodal embeddings.
            # Only first PP rank prepares multimodal embeddings.
938
939
            # NOTE(woosuk): We must call get_mm_embeddings even during dummy runs
            # to obtain inputs_embeds, because the compiled model expects this input.
940
941
942
943
944
945
            inputs_embeds = self.model_state.get_mm_embeddings(
                scheduler_output.scheduled_encoder_inputs,
                input_batch,
                self.req_states,
            )

946
947
948
        model_inputs = {
            "input_ids": input_batch.input_ids,
            "positions": input_batch.positions,
949
            "inputs_embeds": inputs_embeds,
950
951
952
953
954
955
956
957
958
959
            # 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
            model_inputs["intermediate_tensors"] = intermediate_tensors

Woosuk Kwon's avatar
Woosuk Kwon committed
960
        # Run model.
961
        if batch_desc.cg_mode == CUDAGraphMode.FULL:
962
            # Use explicit cudagraph replay for FULL mode.
Woosuk Kwon's avatar
Woosuk Kwon committed
963
964
            # NOTE(woosuk): Here, we don't need to pass the input tensors,
            # because they are already copied to the CUDA graph input buffers.
965
            self.kv_connector.pre_forward(scheduler_output)
966
            model_output = self.cudagraph_manager.run_fullgraph(batch_desc)
967
968
969
970
971
            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
972
        else:
973
974
975
976
977
978
            # 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
979
            with set_forward_context(
980
                attn_metadata,
Woosuk Kwon's avatar
Woosuk Kwon committed
981
982
                self.vllm_config,
                num_tokens=input_batch.num_tokens_after_padding,
983
                cudagraph_runtime_mode=batch_desc.cg_mode,
Woosuk Kwon's avatar
Woosuk Kwon committed
984
                num_tokens_across_dp=num_tokens_across_dp,
985
                batch_descriptor=batch_descriptor,
986
                slot_mapping=slot_mappings_by_layer,
Woosuk Kwon's avatar
Woosuk Kwon committed
987
            ):
988
                self.kv_connector.pre_forward(scheduler_output)
989
                model_output = self.model(**model_inputs)
990
991
992
993
994
                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
995

996
        kv_connector_output = self.kv_connector.post_forward(scheduler_output)
997
998
999
1000
1001
1002
1003
1004
        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,
1005
        )
1006

1007
        if not self.is_last_pp_rank:
1008
1009
1010
1011
1012
            # 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.
1013
        assert isinstance(hidden_states, torch.Tensor)
Woosuk Kwon's avatar
Woosuk Kwon committed
1014
1015
1016
1017
        return None

    @torch.inference_mode()
    def sample_tokens(
1018
        self, grammar_output: GrammarOutput | None
1019
    ) -> AsyncOutput | ModelRunnerOutput | None:
1020
1021
1022
        if self.execute_model_state is None:
            # The prior execute_model call must have failed.
            return None
1023
1024
1025
1026
1027
1028
1029
1030

        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
1031
        self.execute_model_state = None
Woosuk Kwon's avatar
Woosuk Kwon committed
1032

1033
        if not self.is_last_pp_rank:
1034
1035
1036
1037
            # 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(
1038
                input_batch.num_reqs, max_sample_len=self.num_speculative_steps + 1
1039
            )
1040
            self.postprocess(input_batch, sampled, num_sampled, num_rejected)
1041
1042
1043
            return None

        # Last rank: sample tokens
1044
        sampler_output, num_sampled, num_rejected = self.sample(
1045
            hidden_states, input_batch, grammar_output
Woosuk Kwon's avatar
Woosuk Kwon committed
1046
        )
1047
1048

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

1052
1053
1054
1055
        prompt_logprobs_dict = self.prompt_logprobs_worker.compute_prompt_logprobs(
            self.model.compute_logits,
            hidden_states,
            input_batch,
1056
            self.req_states.all_token_ids.gpu,
1057
            self.req_states.num_computed_tokens.gpu,
1058
            self.req_states.prompt_len.np,
1059
1060
1061
            self.req_states.prefill_len.np,
            self.req_states.num_computed_prefill_tokens,
        )
1062
1063
1064
1065
1066
1067
1068
1069

        # 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
1070
            prompt_logprobs_dict=prompt_logprobs_dict,  # type: ignore[arg-type]
1071
            kv_connector_output=kv_connector_output,
1072
1073
1074
1075
        )
        async_output = AsyncOutput(
            model_runner_output=model_runner_output,
            sampler_output=sampler_output,
1076
            num_sampled_tokens=num_sampled,
1077
            main_stream=self.main_stream,
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
            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(
1088
            input_batch, sampler_output.sampled_token_ids, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
1089
        )
1090
        if self.speculator is not None:
1091
            draft_tokens = self.speculator.propose(
1092
                input_batch,
1093
1094
                attn_metadata,
                slot_mappings_by_layer,
1095
                hidden_states,
1096
                aux_hidden_states,
1097
1098
                num_sampled,
                num_rejected,
1099
1100
1101
1102
                self.req_states.last_sampled_tokens,
                self.req_states.next_prefill_tokens,
                self.sampler.sampling_states.temperature.gpu,
                self.sampler.sampling_states.seeds.gpu,
1103
                self.req_states.draft_logits,
1104
                num_tokens_across_dp=num_tokens_across_dp,
1105
            )
1106
            self.req_states.draft_tokens[input_batch.idx_mapping] = draft_tokens
1107
            self.draft_tokens_handler.set_draft_tokens(input_batch, draft_tokens)
1108
1109
1110
1111

        if self.use_async_scheduling:
            return async_output
        return async_output.get_output()
1112
1113
1114

    def take_draft_token_ids(self) -> DraftTokenIds | None:
        return self.draft_tokens_handler.get_draft_tokens()
1115
1116
1117
1118
1119
1120
1121

    @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

1122
1123
1124
        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
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
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
        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
        )
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179


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