model_runner.py 47 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
24
25
26
27
28
29
30
import gc
import time
from copy import deepcopy

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

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

logger = init_logger(__name__)


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

132
        # Multimodal
133
134
135
136
137
138
139
140
141
142
143
        self.mm_registry = MULTIMODAL_REGISTRY
        self.supports_mm_inputs = self.mm_registry.supports_multimodal_inputs(
            self.model_config
        )
        if self.supports_mm_inputs:
            self.encoder_runner = EncoderRunner(
                max_num_tokens=self.max_num_tokens,
                hidden_size=self.inputs_embeds_size,
                dtype=self.dtype,
                device=self.device,
            )
144

Woosuk Kwon's avatar
Woosuk Kwon committed
145
146
147
148
        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()

149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        # 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

        # 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

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

Woosuk Kwon's avatar
Woosuk Kwon committed
182
183
184
185
        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,
186
            num_speculative_steps=self.num_speculative_steps,
Woosuk Kwon's avatar
Woosuk Kwon committed
187
188
189
190
191
192
193
194
            vocab_size=self.vocab_size,
            device=self.device,
        )
        self.input_buffers = InputBuffers(
            max_num_reqs=self.max_num_reqs,
            max_num_tokens=self.max_num_tokens,
            device=self.device,
        )
195
196
197
198
        self.sampler = Sampler(
            max_num_reqs=self.max_num_reqs,
            vocab_size=self.vocab_size,
            device=self.device,
199
            req_states=self.req_states,
200
            logprobs_mode=self.model_config.logprobs_mode,
201
            num_speculative_tokens=self.num_speculative_steps + 1,
202
        )
203
        self.prompt_logprobs_worker = PromptLogprobsWorker(self.max_num_reqs)
Woosuk Kwon's avatar
Woosuk Kwon committed
204
205

        # CUDA graphs.
206
        self.cudagraph_manager = CudaGraphManager(
207
208
209
            self.vllm_config,
            self.use_aux_hidden_state_outputs,
            self.device,
210
        )
211
212
213
214
        # 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,
215
            device=self.device,
216
        )
217
218
        # LoRA-related workers.
        self.lora_state = LoraState(max_num_reqs=self.max_num_reqs)
219
        # KV Connector if configured.
220
221
        self.kv_connector: KVConnector = NO_OP_KV_CONNECTOR

222
223
224
225
        # Pooling models.
        self.is_pooling_model = self.model_config.runner_type == "pooling"
        self.pooling_runner: PoolingRunner | None = None

226
227
228
        # For transferring state from execute_model to subsequent sample_tokens call.
        self.execute_model_state: tuple | None = None

229
230
231
232
    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

233
234
235
236
237
238
239
    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
240
241
242
243
244
245
246
247
248
249
250
251
252

    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(
253
                    self.model, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
254
                )
255
256
257
258
259

            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:
260
                self.speculator.load_model(self.model)
Woosuk Kwon's avatar
Woosuk Kwon committed
261
262
263
264
        time_after_load = time.perf_counter()

        self.model_memory_usage = m.consumed_memory
        logger.info(
265
266
            "Model loading took %s GiB and %.6f seconds",
            format_gib(m.consumed_memory),
Woosuk Kwon's avatar
Woosuk Kwon committed
267
268
269
            time_after_load - time_before_load,
        )

270
        prepare_communication_buffer_for_model(self.model)
271
272
        if self.speculator is not None:
            prepare_communication_buffer_for_model(self.speculator)
273

274
275
        # Initialize the components that require the model.
        self.model_state = ModelState(self.vllm_config, self.model, self.device)
276
277
        if self.is_pooling_model:
            self.pooling_runner = PoolingRunner(self.model)
278

Woosuk Kwon's avatar
Woosuk Kwon committed
279
280
281
    def get_model(self) -> nn.Module:
        return self.model

282
283
284
285
286
    @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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
    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,
304
305
306
            cp_size=self.dcp_size,
            cp_rank=self.dcp_rank,
            cp_interleave=self.cp_interleave,
Woosuk Kwon's avatar
Woosuk Kwon committed
307
308
        )

309
        self.attn_backends, self.attn_groups = init_attn_backend(
310
            self.kv_cache_config, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
311
        )
312
        check_attention_cp_compatibility(self.vllm_config)
313
        if self.speculator is not None:
314
315
316
            # HACK(woosuk)
            self.speculator.set_attn(
                self.kv_cache_config,
317
                self.attn_groups,
318
319
                self.block_tables,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
320
321

        self.kv_caches: list[torch.Tensor] = []
322
        kv_caches_dict = init_kv_cache(
Woosuk Kwon's avatar
Woosuk Kwon committed
323
324
325
326
327
328
            self.kv_caches,
            self.compilation_config.static_forward_context,
            self.kv_cache_config,
            self.attn_backends,
            self.device,
        )
329
330
        self.kv_connector = get_kv_connector(self.vllm_config, kv_caches_dict)

Woosuk Kwon's avatar
Woosuk Kwon committed
331
332
    @torch.inference_mode()
    def _dummy_run(
333
        self, num_tokens: int, *args, skip_attn: bool = True, **kwargs
334
    ) -> tuple[torch.Tensor | None, torch.Tensor | None]:
335
        # Create a dummy scheduler output.
Woosuk Kwon's avatar
Woosuk Kwon committed
336
        num_reqs = min(num_tokens, self.max_num_reqs)
337
338
339
340
        num_tokens_per_request = [num_tokens // num_reqs] * num_reqs
        num_tokens_per_request[-1] += num_tokens % num_reqs
        assert sum(num_tokens_per_request) == num_tokens
        num_scheduled_tokens = {
341
            f"_dummy_req_{i}": n for i, n in enumerate(num_tokens_per_request)
342
343
344
345
346
        }
        dummy_scheduler_output = SchedulerOutput.make_empty()
        dummy_scheduler_output.total_num_scheduled_tokens = num_tokens
        dummy_scheduler_output.num_scheduled_tokens = num_scheduled_tokens

347
348
349
        # Disable any use of KVConnector for dummy runs.
        self.kv_connector.set_disabled(True)

350
351
        # For non-first PP ranks, create dummy intermediate_tensors.
        intermediate_tensors = None
352
        if not self.is_first_pp_rank:
353
354
355
356
357
358
            intermediate_tensors = self.model.make_empty_intermediate_tensors(
                batch_size=num_tokens,
                dtype=self.model_config.dtype,
                device=self.device,
            )

359
360
        # Execute the model.
        self.execute_model(
361
362
363
364
            dummy_scheduler_output,
            intermediate_tensors=intermediate_tensors,
            dummy_run=True,
            skip_attn_for_dummy_run=skip_attn,
365
        )
366
        self.kv_connector.set_disabled(False)
367
368

        # Non-last PP ranks don't produce output for sampling.
369
        if not self.is_last_pp_rank:
370
371
            return None, None

372
        assert self.execute_model_state is not None
373
        input_batch, _, _, _, hidden_states, _, _ = self.execute_model_state
374
        self.execute_model_state = None
375
        assert hidden_states is not None  # Last PP rank always has hidden_states
376
        sample_hidden_states = hidden_states[input_batch.logits_indices]
Woosuk Kwon's avatar
Woosuk Kwon committed
377
378
379
        return hidden_states, sample_hidden_states

    @torch.inference_mode()
380
    def _dummy_sampler_run(self, hidden_states: torch.Tensor) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
381
382
        num_reqs = hidden_states.shape[0]
        logits = self.model.compute_logits(hidden_states)
383
384
385
        idx_mapping = torch.arange(num_reqs, dtype=torch.int32, device=self.device)
        idx_mapping_np = np.arange(num_reqs, dtype=np.int32)
        pos = torch.zeros(num_reqs, dtype=torch.int64, device=self.device)
386
387
388
389
        dummy_input_ids = torch.zeros(num_reqs, dtype=torch.int32, device=self.device)
        expanded_local_pos = torch.zeros(
            num_reqs, dtype=torch.int32, device=self.device
        )
390
391
392
        # 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.
393
394
395
396
397
398
399
400
401
        self.sampler(
            logits,
            idx_mapping,
            idx_mapping_np,
            idx_mapping_np,
            pos,
            dummy_input_ids,
            expanded_local_pos,
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
402

403
404
405
406
407
    @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
408
409
410
    @torch.inference_mode()
    def profile_run(self) -> None:
        hidden_states, sample_hidden_states = self._dummy_run(
411
            self.max_num_tokens, skip_attn=True
Woosuk Kwon's avatar
Woosuk Kwon committed
412
        )
413

414
        # Only run sampler/pooler on last PP rank (non-last ranks return None).
415
        if self.is_last_pp_rank:
416
            assert sample_hidden_states is not None
417
418
419
420
            if self.pooling_runner is None:
                self._dummy_sampler_run(sample_hidden_states)
            else:
                self._dummy_pooler_run(hidden_states)
421

422
            if self.speculator is not None:
423
424
425
426
427
428
429
430
431
432
                num_tokens_across_dp = make_num_tokens_across_dp(
                    self.parallel_config.data_parallel_size, self.max_num_tokens
                )
                self.speculator.run_model(
                    self.max_num_tokens,
                    attn_metadata=None,
                    slot_mappings=None,
                    num_tokens_across_dp=num_tokens_across_dp,
                )

Woosuk Kwon's avatar
Woosuk Kwon committed
433
434
435
436
437
        torch.cuda.synchronize()
        del hidden_states, sample_hidden_states
        gc.collect()

    def reset_mm_cache(self) -> None:
438
439
        if self.supports_mm_inputs:
            self.encoder_runner.reset_mm_cache()
440
441

    def reset_encoder_cache(self) -> None:
442
443
        if self.supports_mm_inputs:
            self.encoder_runner.reset_encoder_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
444
445
446
447
448
449
450
451
452
453
454
455
456
457

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

    @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

458
459
460
461
462
463
464
465
        # 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
466
        start_time = time.perf_counter()
467
        gc.collect()
468
        torch.cuda.empty_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
469
470
471
        start_free_gpu_memory = torch.cuda.mem_get_info()[0]

        with self.maybe_setup_dummy_loras(self.lora_config):
472
473
474
            inputs_embeds = None
            if self.supports_mm_inputs:
                inputs_embeds = self.encoder_runner.inputs_embeds
Woosuk Kwon's avatar
Woosuk Kwon committed
475
476
            self.cudagraph_manager.capture(
                model=self.model,
477
                model_state=self.model_state,
Woosuk Kwon's avatar
Woosuk Kwon committed
478
                input_buffers=self.input_buffers,
479
                inputs_embeds=inputs_embeds,
Woosuk Kwon's avatar
Woosuk Kwon committed
480
                block_tables=self.block_tables,
481
                attn_groups=self.attn_groups,
Woosuk Kwon's avatar
Woosuk Kwon committed
482
                kv_cache_config=self.kv_cache_config,
483
                has_lora=self.lora_config is not None,
Woosuk Kwon's avatar
Woosuk Kwon committed
484
            )
485
            if self.speculator is not None:
486
                self.speculator.capture_model()
Woosuk Kwon's avatar
Woosuk Kwon committed
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506

        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

    def warmup_for_prefill(self) -> None:
        # For FlashInfer, we would like to execute a dummy prefill run
        # to trigger JIT compilation.
        if all("FLASHINFER" in b.get_name() for b in self.attn_backends.values()):
            self._dummy_run(self.max_num_tokens, skip_attn=False)
            torch.cuda.synchronize()

507
    def finish_requests(self, scheduler_output: SchedulerOutput) -> None:
508
        finished_req_ids = scheduler_output.finished_req_ids
509
510
511
        preempted_req_ids = scheduler_output.preempted_req_ids
        if preempted_req_ids:
            finished_req_ids = finished_req_ids.union(preempted_req_ids)
512
        for req_id in finished_req_ids:
Woosuk Kwon's avatar
Woosuk Kwon committed
513
            self.req_states.remove_request(req_id)
514
515
            if self.supports_mm_inputs:
                self.encoder_runner.remove_request(req_id)
516
            self.prompt_logprobs_worker.remove_request(req_id)
517
            self.lora_state.remove_request(req_id)
518

519
    def free_states(self, scheduler_output: SchedulerOutput) -> None:
520
521
522
        if self.supports_mm_inputs:
            for mm_hash in scheduler_output.free_encoder_mm_hashes:
                self.encoder_runner.free_encoder_cache(mm_hash)
Woosuk Kwon's avatar
Woosuk Kwon committed
523

524
    def add_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
525
        for new_req_data in scheduler_output.scheduled_new_reqs:
526
527
            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
528
            req_id = new_req_data.req_id
529
            prompt_len = len(new_req_data.prompt_token_ids)
Woosuk Kwon's avatar
Woosuk Kwon committed
530
531
            self.req_states.add_request(
                req_id=req_id,
532
                prompt_len=prompt_len,
533
                all_token_ids=new_req_data.prefill_token_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
534
535
536
                num_computed_tokens=new_req_data.num_computed_tokens,
            )
            req_index = self.req_states.req_id_to_index[req_id]
537

538
539
540
            if self.supports_mm_inputs:
                self.encoder_runner.add_request(req_id, new_req_data.mm_features)

541
            self.model_state.add_request(req_index, new_req_data)
542
543
544
            self.block_tables.append_block_ids(
                req_index, new_req_data.block_ids, overwrite=True
            )
545
            self.lora_state.add_request(req_id, req_index, new_req_data.lora_request)
Woosuk Kwon's avatar
Woosuk Kwon committed
546

547
548
549
550
551
552
553
554
            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
                )

555
556
        if scheduler_output.scheduled_new_reqs:
            self.req_states.apply_staged_writes()
557
            self.sampler.apply_staged_writes()
558
            self.model_state.apply_staged_writes()
559
560

    def update_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
561
        # Add new blocks for the existing requests.
562
563
        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
564
            if req_new_block_ids is not None:
565
                req_index = self.req_states.req_id_to_index[req_id]
566
567
568
                self.block_tables.append_block_ids(
                    req_index, req_new_block_ids, overwrite=False
                )
Woosuk Kwon's avatar
Woosuk Kwon committed
569
570

    def prepare_inputs(
571
        self, scheduler_output: SchedulerOutput, num_tokens_after_padding: int
Woosuk Kwon's avatar
Woosuk Kwon committed
572
573
574
    ) -> InputBatch:
        num_tokens = scheduler_output.total_num_scheduled_tokens
        assert num_tokens > 0
575
576
        num_tokens_per_req = scheduler_output.num_scheduled_tokens
        num_reqs = len(num_tokens_per_req)
Woosuk Kwon's avatar
Woosuk Kwon committed
577
578
579

        # Decode first, then prefill.
        # batch_idx -> req_id
580
581
582
        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
583

584
585
        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)
586
        idx_mapping = async_copy_to_gpu(idx_mapping_np, device=self.device)
Woosuk Kwon's avatar
Woosuk Kwon committed
587

588
        # Get the number of draft tokens for each request.
589
590
        draft_tokens = scheduler_output.scheduled_spec_decode_tokens
        if not draft_tokens:
591
592
593
            # No draft token scheduled (common case).
            total_num_draft_tokens = 0
            total_num_logits = num_reqs
594
            cu_num_logits_np = np.arange(num_reqs + 1, dtype=np.int32)
595
596
597
            cu_num_logits = torch.arange(
                num_reqs + 1, device=self.device, dtype=torch.int32
            )
598
            expanded_idx_mapping = idx_mapping
599
600
601
            expanded_local_pos = torch.zeros(
                num_reqs, dtype=torch.int32, device=self.device
            )
602
603
        else:
            num_draft_tokens = np.array(
604
                [len(draft_tokens.get(req_id, ())) for req_id in req_ids],
605
606
607
608
609
                dtype=np.int32,
            )
            total_num_draft_tokens = int(num_draft_tokens.sum())
            total_num_logits = num_reqs + total_num_draft_tokens

610
611
612
613
            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:])
614
            cu_num_logits = async_copy_to_gpu(cu_num_logits_np, device=self.device)
615

616
            max_expand_len = self.num_speculative_steps + 1
617
            expanded_idx_mapping, expanded_local_pos = expand_idx_mapping(
618
                idx_mapping, total_num_logits, cu_num_logits, max_expand_len
619
620
            )

621
        # Get query_start_loc.
622
623
624
        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])
625
626
        # Pad for full CUDA graph mode.
        # Some attention backends like FA3 require query_start_loc to be non-decreasing.
627
        query_start_loc_np[num_reqs + 1 :] = num_tokens
628
        async_copy_to_gpu(query_start_loc_np, out=self.input_buffers.query_start_loc)
629
630
        query_start_loc_np = query_start_loc_np[: num_reqs + 1]
        query_start_loc = self.input_buffers.query_start_loc[: num_reqs + 1]
631

632
633
634
635
636
637
638
639
640
641
642
        # 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
643

644
645
646
        # Prepare positions and seq_lens.
        prepare_pos_seq_lens(
            idx_mapping,
647
648
            query_start_loc,
            self.req_states.num_computed_tokens.gpu,
649
650
651
652
653
            self.input_buffers.positions,
            self.input_buffers.seq_lens,
        )
        seq_lens = self.input_buffers.seq_lens[:num_reqs]

654
        dcp_local_seq_lens = None
655
656
        if self.use_dcp:
            # Prepare dcp local seq_lens.
657
658
            prepare_dcp_local_seq_lens(
                self.input_buffers.dcp_local_seq_lens,
659
                self.input_buffers.seq_lens,
660
                num_reqs,
661
662
663
                self.dcp_size,
                self.dcp_rank,
                self.cp_interleave,
664
            )
665
            dcp_local_seq_lens = self.input_buffers.dcp_local_seq_lens[:num_reqs]
666

667
        # Some input token ids are directly read from the last sampled tokens
668
669
        # and draft tokens. Also, get the logits indices to sample tokens from.
        logits_indices = combine_sampled_and_draft_tokens(
670
            self.input_buffers.input_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
671
672
            idx_mapping,
            self.req_states.last_sampled_tokens,
673
            query_start_loc,
674
675
            seq_lens,
            self.req_states.prefill_len.gpu,
676
677
678
            self.req_states.draft_tokens,
            cu_num_logits,
            total_num_logits,
Woosuk Kwon's avatar
Woosuk Kwon committed
679
680
681
682
683
684
685
        )

        return InputBatch(
            req_ids=req_ids,
            num_reqs=num_reqs,
            idx_mapping=idx_mapping,
            idx_mapping_np=idx_mapping_np,
686
            expanded_idx_mapping=expanded_idx_mapping,
687
            expanded_local_pos=expanded_local_pos,
Woosuk Kwon's avatar
Woosuk Kwon committed
688
689
690
            num_scheduled_tokens=num_scheduled_tokens,
            num_tokens=num_tokens,
            num_tokens_after_padding=num_tokens_after_padding,
691
            num_draft_tokens=total_num_draft_tokens,
692
            query_start_loc=query_start_loc,
Woosuk Kwon's avatar
Woosuk Kwon committed
693
            query_start_loc_np=query_start_loc_np,
694
            seq_lens=seq_lens,
695
696
697
            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],
698
            inputs_embeds=None,
Woosuk Kwon's avatar
Woosuk Kwon committed
699
            logits_indices=logits_indices,
700
            cu_num_logits=cu_num_logits,
701
            cu_num_logits_np=cu_num_logits_np,
702
            has_structured_output_reqs=scheduler_output.has_structured_output_requests,
Woosuk Kwon's avatar
Woosuk Kwon committed
703
704
        )

705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
    def prepare_attn(
        self, input_batch: InputBatch
    ) -> tuple[tuple[torch.Tensor, ...], torch.Tensor]:
        # Block tables: num_kv_cache_groups x [num_reqs, max_num_blocks]
        block_tables = self.block_tables.gather_block_tables(input_batch.idx_mapping)
        # Compute slot mappings: [num_kv_cache_groups, num_tokens]
        slot_mappings = self.block_tables.compute_slot_mappings(
            input_batch.idx_mapping,
            input_batch.query_start_loc,
            input_batch.positions,
        )
        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

727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
    @torch.inference_mode()
    def get_mm_embeddings(
        self,
        scheduled_encoder_inputs: dict[str, list[int]],
        input_batch: InputBatch,
    ) -> tuple[list[torch.Tensor], torch.Tensor]:
        mm_hashes, mm_kwargs = self.encoder_runner.prepare_mm_inputs(
            scheduled_encoder_inputs
        )
        self.encoder_runner.execute_mm_encoder(self.model, mm_hashes, mm_kwargs)
        mm_embeds, is_mm_embed = self.encoder_runner.gather_mm_embeddings(
            input_batch.req_ids,
            input_batch.num_tokens,
            input_batch.num_scheduled_tokens,
            input_batch.query_start_loc_np,
            self.req_states.prefill_len.np[input_batch.idx_mapping_np],
            self.req_states.num_computed_prefill_tokens[input_batch.idx_mapping_np],
        )
        return mm_embeds, is_mm_embed

Woosuk Kwon's avatar
Woosuk Kwon committed
747
748
749
750
751
    def sample(
        self,
        hidden_states: torch.Tensor,
        input_batch: InputBatch,
        grammar_output: GrammarOutput | None,
752
    ) -> tuple[SamplerOutput, torch.Tensor, torch.Tensor]:
Woosuk Kwon's avatar
Woosuk Kwon committed
753
        sample_hidden_states = hidden_states[input_batch.logits_indices]
754
        sample_pos = input_batch.positions[input_batch.logits_indices]
755
        input_ids = input_batch.input_ids[input_batch.logits_indices]
Woosuk Kwon's avatar
Woosuk Kwon committed
756
757
758
        logits = self.model.compute_logits(sample_hidden_states)
        if grammar_output is not None:
            # Apply grammar bitmask to the logits in-place.
759
760
761
762
763
764
            self.structured_outputs_worker.apply_grammar_bitmask(
                logits,
                input_batch,
                grammar_output.structured_output_request_ids,
                grammar_output.grammar_bitmask,
            )
765

766
        # Sample tokens and compute logprobs (if needed).
767
768
769
770
        sampler_output = self.sampler(
            logits,
            input_batch.expanded_idx_mapping,
            input_batch.idx_mapping_np,
771
            input_batch.cu_num_logits_np,
772
            sample_pos,
773
774
            input_ids,
            input_batch.expanded_local_pos,
775
        )
776
777
778

        if input_batch.num_draft_tokens == 0:
            # No draft tokens (common case).
779
780
781
            num_sampled = torch.ones(
                input_batch.num_reqs, dtype=torch.int32, device=self.device
            )
782
        else:
783
            # Rejection sampling for spec decoding.
784
785
786
787
788
789
790
            sampled_tokens, num_sampled = rejection_sample(
                sampler_output.sampled_token_ids,
                input_ids,
                input_batch.cu_num_logits,
                self.num_speculative_steps,
            )
            sampler_output.sampled_token_ids = sampled_tokens
791
792
793
794
795
796
797
798
799
800

        # 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(
            num_sampled,
            input_batch.seq_lens,
            input_batch.cu_num_logits,
            input_batch.idx_mapping,
            self.req_states.prefill_len.gpu,
        )
801
        return sampler_output, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
802
803
804
805

    def postprocess(
        self,
        input_batch: InputBatch,
806
807
        sampled_tokens: torch.Tensor,
        num_sampled: torch.Tensor,
808
        num_rejected: torch.Tensor,
809
810
    ) -> None:
        # Update the number of computed tokens.
811
        post_update(
812
            input_batch.idx_mapping,
813
            self.req_states.num_computed_tokens.gpu,
814
            self.req_states.last_sampled_tokens,
815
            self.sampler.penalties_state.output_bin_counts,
816
817
            sampled_tokens,
            num_sampled,
818
            num_rejected,
819
            input_batch.query_start_loc,
820
821
            self.req_states.all_token_ids.gpu,
            self.req_states.total_len.gpu,
Woosuk Kwon's avatar
Woosuk Kwon committed
822
        )
823
824

        # Update the number of computed prefill tokens.
Woosuk Kwon's avatar
Woosuk Kwon committed
825
        idx_mapping_np = input_batch.idx_mapping_np
826
        computed_prefill = self.req_states.num_computed_prefill_tokens
827
828
829
        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
830
831
832
833
834
835
        )

    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: SchedulerOutput,
836
        intermediate_tensors: IntermediateTensors | None = None,
Woosuk Kwon's avatar
Woosuk Kwon committed
837
        dummy_run: bool = False,
838
        skip_attn_for_dummy_run: bool = False,
839
    ) -> ModelRunnerOutput | IntermediateTensors | None:
840
841
842
843
844
845
846
847
848
        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.
849
850
                empty_output = self.kv_connector.no_forward(scheduler_output)
                return empty_output
Woosuk Kwon's avatar
Woosuk Kwon committed
851

852
853
854
855
856
857
858
        # Get local cudagraph mode and size.
        local_cudagraph_mode, local_cudagraph_size = (
            self.cudagraph_manager.get_cudagraph_runtime_mode(
                num_reqs=len(scheduler_output.num_scheduled_tokens),
                num_tokens=scheduler_output.total_num_scheduled_tokens,
                max_query_len=max(scheduler_output.num_scheduled_tokens.values()),
            )
859
        )
860
861
862

        # DP sync: num_tokens + cudagraph_size + cudagraph_mode
        num_tokens_after_padding, num_tokens_across_dp, synced_cudagraph_mode = (
863
            get_cudagraph_and_dp_padding(
864
                scheduler_output.total_num_scheduled_tokens,
865
866
                local_cudagraph_size,
                local_cudagraph_mode.value,
867
868
                self.parallel_config.data_parallel_size,
                self.parallel_config.data_parallel_rank,
869
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
870
        )
871
        cudagraph_runtime_mode = CUDAGraphMode(synced_cudagraph_mode)
872
873
        if num_tokens_after_padding == 0:
            # All DP ranks have zero tokens to run.
874
875
            empty_output = self.kv_connector.no_forward(scheduler_output)
            return empty_output
876
877
878
879
880

        if not dummy_run:
            # Common case.
            # Prepare all the inputs and copy to the input buffers.
            input_batch = self.prepare_inputs(
881
                scheduler_output, num_tokens_after_padding
882
            )
883
884
            block_tables, slot_mappings = self.prepare_attn(input_batch)

885
886
            if self.lora_config:
                # Activate LoRA adapters.
887
                lora_inputs = self.lora_state.make_lora_inputs(
888
889
890
                    input_batch.req_ids,
                    input_batch.idx_mapping_np,
                    input_batch.num_scheduled_tokens,
Woosuk Kwon's avatar
Woosuk Kwon committed
891
                )
892
                self._set_active_loras(*lora_inputs)
893

894
            # Only first PP rank prepares multimodal embeddings.
895
            if self.supports_mm_inputs and self.is_first_pp_rank:
896
897
898
899
900
901
902
903
904
                mm_embeds, is_mm_embed = self.get_mm_embeddings(
                    scheduler_output.scheduled_encoder_inputs, input_batch
                )
                inputs_embeds = self.encoder_runner.get_inputs_embeds(
                    self.model, input_batch.input_ids, mm_embeds, is_mm_embed
                )
                input_batch.inputs_embeds = inputs_embeds[
                    : input_batch.num_tokens_after_padding
                ]
905
        else:
906
            # No actual tokens to run. A dummy run for DP or memory profiling.
907
908
909
910
911
912
913
            num_reqs = min(num_tokens_after_padding, self.max_num_reqs)
            input_batch = InputBatch.make_dummy(
                num_reqs=num_reqs,
                num_tokens=num_tokens_after_padding,
                input_buffers=self.input_buffers,
                device=self.device,
            )
914
            if not skip_attn_for_dummy_run:
915
916
917
918
                block_tables, slot_mappings = self.prepare_dummy_attn(input_batch)
            else:
                block_tables = None
                slot_mappings = None
919
            # FIXME(woosuk): Fix warmup for LoRA.
Woosuk Kwon's avatar
Woosuk Kwon committed
920

921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
        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,
                block_tables,
                slot_mappings,
                self.attn_groups,
                self.kv_cache_config,
            )

937
938
939
940
941
942
943
944
945
946
947
948
949
950
        model_inputs = {
            "input_ids": input_batch.input_ids,
            "positions": input_batch.positions,
            "inputs_embeds": input_batch.inputs_embeds,
            # 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
951
        # Run model.
952
953
        if cudagraph_runtime_mode == CUDAGraphMode.FULL:
            # Use explicit cudagraph replay for FULL mode.
Woosuk Kwon's avatar
Woosuk Kwon committed
954
955
            # NOTE(woosuk): Here, we don't need to pass the input tensors,
            # because they are already copied to the CUDA graph input buffers.
956
            self.kv_connector.pre_forward(scheduler_output)
957
            model_output = self.cudagraph_manager.run_fullgraph(
Woosuk Kwon's avatar
Woosuk Kwon committed
958
959
                input_batch.num_tokens_after_padding
            )
960
961
962
963
964
            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
965
        else:
966
967
968
969
970
971
            # 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
972
            with set_forward_context(
973
                attn_metadata,
Woosuk Kwon's avatar
Woosuk Kwon committed
974
975
                self.vllm_config,
                num_tokens=input_batch.num_tokens_after_padding,
976
                cudagraph_runtime_mode=cudagraph_runtime_mode,
Woosuk Kwon's avatar
Woosuk Kwon committed
977
                num_tokens_across_dp=num_tokens_across_dp,
978
                batch_descriptor=batch_descriptor,
979
                slot_mapping=slot_mappings_by_layer,
Woosuk Kwon's avatar
Woosuk Kwon committed
980
            ):
981
                self.kv_connector.pre_forward(scheduler_output)
982
                model_output = self.model(**model_inputs)
983
984
985
986
987
                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
988

989
        kv_connector_output = self.kv_connector.post_forward(scheduler_output)
990
991
992
993
994
995
996
997
998
        self.execute_model_state = (
            input_batch,
            model_inputs,
            attn_metadata,
            slot_mappings_by_layer,
            hidden_states,
            aux_hidden_states,
            kv_connector_output,
        )
999

1000
        if not self.is_last_pp_rank:
1001
1002
1003
1004
1005
            # 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.
1006
        assert isinstance(hidden_states, torch.Tensor)
Woosuk Kwon's avatar
Woosuk Kwon committed
1007
1008
1009
1010
        return None

    @torch.inference_mode()
    def sample_tokens(
1011
        self, grammar_output: GrammarOutput | None
1012
    ) -> AsyncOutput | ModelRunnerOutput | None:
1013
1014
1015
        if self.execute_model_state is None:
            # The prior execute_model call must have failed.
            return None
1016
1017
1018
1019
1020
1021
1022
1023
1024
        (
            input_batch,
            model_inputs,
            attn_metadata,
            slot_mappings_by_layer,
            hidden_states,
            aux_hidden_states,
            kv_connector_output,
        ) = self.execute_model_state
1025
        self.execute_model_state = None
Woosuk Kwon's avatar
Woosuk Kwon committed
1026

1027
        if not self.is_last_pp_rank:
1028
1029
1030
1031
            # 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(
1032
                input_batch.num_reqs, max_sample_len=self.num_speculative_steps + 1
1033
            )
1034
            self.postprocess(input_batch, sampled, num_sampled, num_rejected)
1035
1036
1037
            return None

        # Last rank: sample tokens
1038
        sampler_output, num_sampled, num_rejected = self.sample(
1039
            hidden_states, input_batch, grammar_output
Woosuk Kwon's avatar
Woosuk Kwon committed
1040
        )
1041
1042

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

1046
1047
1048
1049
        prompt_logprobs_dict = self.prompt_logprobs_worker.compute_prompt_logprobs(
            self.model.compute_logits,
            hidden_states,
            input_batch,
1050
            self.req_states.all_token_ids.gpu,
1051
            self.req_states.num_computed_tokens.gpu,
1052
            self.req_states.prompt_len.np,
1053
1054
1055
            self.req_states.prefill_len.np,
            self.req_states.num_computed_prefill_tokens,
        )
1056
1057
1058
1059
1060
1061
1062
1063

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

        if self.use_async_scheduling:
            return async_output
        return async_output.get_output()
1104
1105
1106

    def take_draft_token_ids(self) -> DraftTokenIds | None:
        return self.draft_tokens_handler.get_draft_tokens()
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161

    @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

        input_batch, _, _, _, hidden_states, _, kv_connector_output = (
            self.execute_model_state
        )
        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
        )