model_runner.py 39.3 KB
Newer Older
Woosuk Kwon's avatar
Woosuk Kwon committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
import gc
import time
from copy import deepcopy
from typing import Any

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

from vllm.config import VllmConfig
from vllm.config.compilation import CUDAGraphMode
14
from vllm.distributed.parallel_state import prepare_communication_buffer_for_model
Woosuk Kwon's avatar
Woosuk Kwon committed
15
16
17
from vllm.forward_context import set_forward_context
from vllm.logger import init_logger
from vllm.model_executor.model_loader import get_model_loader
18
from vllm.multimodal import MULTIMODAL_REGISTRY
19
from vllm.utils.mem_utils import DeviceMemoryProfiler, format_gib
Woosuk Kwon's avatar
Woosuk Kwon committed
20
21
22
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
23
from vllm.v1.outputs import DraftTokenIds, ModelRunnerOutput
24
from vllm.v1.worker.gpu.async_utils import AsyncOutput
Woosuk Kwon's avatar
Woosuk Kwon committed
25
26
from vllm.v1.worker.gpu.attn_utils import (
    build_attn_metadata,
27
    build_slot_mappings_by_layer,
Woosuk Kwon's avatar
Woosuk Kwon committed
28
29
30
31
32
    get_kv_cache_spec,
    init_attn_backend,
    init_kv_cache,
)
from vllm.v1.worker.gpu.block_table import BlockTables
33
from vllm.v1.worker.gpu.buffer_utils import async_copy_to_gpu
Woosuk Kwon's avatar
Woosuk Kwon committed
34
from vllm.v1.worker.gpu.cudagraph_utils import CudaGraphManager
35
from vllm.v1.worker.gpu.dp_utils import (
36
    get_cudagraph_and_dp_padding,
37
38
    make_num_tokens_across_dp,
)
Woosuk Kwon's avatar
Woosuk Kwon committed
39
40
41
from vllm.v1.worker.gpu.input_batch import (
    InputBatch,
    InputBuffers,
42
    combine_sampled_and_draft_tokens,
43
    expand_idx_mapping,
44
    get_num_sampled_and_rejected,
45
    post_update,
46
47
    prepare_pos_seq_lens,
    prepare_prefill_inputs,
Woosuk Kwon's avatar
Woosuk Kwon committed
48
)
49
50
51
52
53
from vllm.v1.worker.gpu.kv_connector import (
    NO_OP_KV_CONNECTOR,
    KVConnector,
    get_kv_connector,
)
54
from vllm.v1.worker.gpu.lora_utils import LoraState
55
from vllm.v1.worker.gpu.mm.encoder_runner import EncoderRunner
56
from vllm.v1.worker.gpu.mm.mrope_utils import MRopeState
57
from vllm.v1.worker.gpu.sample.output import SamplerOutput
58
from vllm.v1.worker.gpu.sample.prompt_logprob import PromptLogprobsWorker
59
from vllm.v1.worker.gpu.sample.sampler import Sampler
60
from vllm.v1.worker.gpu.spec_decode import init_speculator
61
from vllm.v1.worker.gpu.spec_decode.rejection_sample import rejection_sample
62
from vllm.v1.worker.gpu.spec_decode.utils import DraftTokensHandler
63
from vllm.v1.worker.gpu.states import RequestState
64
from vllm.v1.worker.gpu.structured_outputs import StructuredOutputsWorker
Woosuk Kwon's avatar
Woosuk Kwon committed
65
66
67
68
69
from vllm.v1.worker.lora_model_runner_mixin import LoRAModelRunnerMixin

logger = init_logger(__name__)


70
class GPUModelRunner(LoRAModelRunnerMixin):
Woosuk Kwon's avatar
Woosuk Kwon committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
    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.is_pooling_model = False

        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
101
        self.inputs_embeds_size = self.model_config.get_inputs_embeds_size()
Woosuk Kwon's avatar
Woosuk Kwon committed
102

103
        # Multimodal
104
105
106
107
108
109
110
111
112
113
114
        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,
            )
115
116
117
118
        self.uses_mrope = self.model_config.uses_mrope
        if self.uses_mrope:
            self.mrope_states = MRopeState(
                max_num_reqs=self.max_num_reqs,
119
                max_num_tokens=self.max_num_tokens,
120
121
122
123
                max_model_len=self.max_model_len,
                device=self.device,
            )

Woosuk Kwon's avatar
Woosuk Kwon committed
124
125
126
127
        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()

128
129
130
        if self.speculative_config is not None:
            self.do_spec_decode = True
            self.num_speculative_steps = self.speculative_config.num_speculative_tokens
131
            self.speculator = init_speculator(self.vllm_config, self.device)
132
133
134
        else:
            self.do_spec_decode = False
            self.num_speculative_steps = 0
135
            self.speculator = None
136

Woosuk Kwon's avatar
Woosuk Kwon committed
137
138
139
140
        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,
141
            num_speculative_steps=self.num_speculative_steps,
Woosuk Kwon's avatar
Woosuk Kwon committed
142
143
144
145
146
147
148
149
            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,
        )
150
151
152
153
154
        self.sampler = Sampler(
            max_num_reqs=self.max_num_reqs,
            vocab_size=self.vocab_size,
            device=self.device,
            logprobs_mode=self.model_config.logprobs_mode,
155
            num_speculative_tokens=self.num_speculative_steps + 1,
156
        )
157
        self.prompt_logprobs_worker = PromptLogprobsWorker(self.max_num_reqs)
Woosuk Kwon's avatar
Woosuk Kwon committed
158
159

        # CUDA graphs.
160
161
162
        self.cudagraph_manager = CudaGraphManager(
            self.vllm_config, self.uses_mrope, self.device
        )
163
164
165
166
        # 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,
167
            device=self.device,
168
        )
169
170
        # LoRA-related workers.
        self.lora_state = LoraState(max_num_reqs=self.max_num_reqs)
171

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

        # KV Connector if configured.
176
177
        self.kv_connector: KVConnector = NO_OP_KV_CONNECTOR

178
179
180
181
    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

182
183
    @staticmethod
    def get_supported_tasks() -> tuple[str]:
Woosuk Kwon's avatar
Woosuk Kwon committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
        return ("generate",)

    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(
198
                    self.model, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
199
                )
200
201
            if self.do_spec_decode:
                self.speculator.load_model(self.model)
Woosuk Kwon's avatar
Woosuk Kwon committed
202
203
204
205
        time_after_load = time.perf_counter()

        self.model_memory_usage = m.consumed_memory
        logger.info(
206
207
            "Model loading took %s GiB and %.6f seconds",
            format_gib(m.consumed_memory),
Woosuk Kwon's avatar
Woosuk Kwon committed
208
209
210
            time_after_load - time_before_load,
        )

211
212
213
214
215
216
        prepare_communication_buffer_for_model(self.model)
        if self.do_spec_decode:
            speculator_model = getattr(self.speculator, "model", None)
            if speculator_model is not None:
                prepare_communication_buffer_for_model(speculator_model)

Woosuk Kwon's avatar
Woosuk Kwon committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
    def get_model(self) -> nn.Module:
        return self.model

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

        self.attn_backends, self.attn_metadata_builders = init_attn_backend(
240
            self.kv_cache_config, self.vllm_config, self.device
Woosuk Kwon's avatar
Woosuk Kwon committed
241
        )
242
243
244
245
246
247
248
        if self.do_spec_decode:
            # HACK(woosuk)
            self.speculator.set_attn(
                self.kv_cache_config,
                self.attn_metadata_builders,
                self.block_tables,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
249
250

        self.kv_caches: list[torch.Tensor] = []
251
        kv_caches_dict = init_kv_cache(
Woosuk Kwon's avatar
Woosuk Kwon committed
252
253
254
255
256
257
            self.kv_caches,
            self.compilation_config.static_forward_context,
            self.kv_cache_config,
            self.attn_backends,
            self.device,
        )
258
259
        self.kv_connector = get_kv_connector(self.vllm_config, kv_caches_dict)

Woosuk Kwon's avatar
Woosuk Kwon committed
260
261
262
263
264
265
266
267
        # Attention groups are not supported.
        self.attn_groups = []  # type: ignore

    def prepare_dummy_attn_metadata(self, input_batch: InputBatch) -> None:
        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
        )
268
269
270
        slot_mappings_by_layer = build_slot_mappings_by_layer(
            slot_mappings, self.kv_cache_config
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
271
272
273
274
        attn_metadata = build_attn_metadata(
            attn_metadata_builders=self.attn_metadata_builders,
            num_reqs=input_batch.num_reqs,
            num_tokens=input_batch.num_tokens,
275
276
            query_start_loc_gpu=input_batch.query_start_loc,
            query_start_loc_cpu=torch.from_numpy(input_batch.query_start_loc_np),
277
            max_query_len=input_batch.num_scheduled_tokens.max().item(),
278
            seq_lens=input_batch.seq_lens,
279
            max_seq_len=self.max_model_len,
Woosuk Kwon's avatar
Woosuk Kwon committed
280
281
282
283
284
            block_tables=block_tables,
            slot_mappings=slot_mappings,
            kv_cache_config=self.kv_cache_config,
        )
        input_batch.attn_metadata = attn_metadata
285
        input_batch.slot_mappings = slot_mappings_by_layer
Woosuk Kwon's avatar
Woosuk Kwon committed
286
287
288

    @torch.inference_mode()
    def _dummy_run(
289
        self, num_tokens: int, *args, skip_attn: bool = True, **kwargs
Woosuk Kwon's avatar
Woosuk Kwon committed
290
    ) -> tuple[torch.Tensor, torch.Tensor]:
291
        # Create a dummy scheduler output.
Woosuk Kwon's avatar
Woosuk Kwon committed
292
        num_reqs = min(num_tokens, self.max_num_reqs)
293
294
295
296
        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 = {
297
            f"_dummy_req_{i}": n for i, n in enumerate(num_tokens_per_request)
298
299
300
301
302
        }
        dummy_scheduler_output = SchedulerOutput.make_empty()
        dummy_scheduler_output.total_num_scheduled_tokens = num_tokens
        dummy_scheduler_output.num_scheduled_tokens = num_scheduled_tokens

303
304
305
        # Disable any use of KVConnector for dummy runs.
        self.kv_connector.set_disabled(True)

306
307
308
309
        # Execute the model.
        self.execute_model(
            dummy_scheduler_output, dummy_run=True, skip_attn_for_dummy_run=skip_attn
        )
310
        self.kv_connector.set_disabled(False)
311
        assert self.execute_model_state is not None
312
        hidden_states, input_batch, _ = self.execute_model_state
313
        sample_hidden_states = hidden_states[input_batch.logits_indices]
Woosuk Kwon's avatar
Woosuk Kwon committed
314
315
316
        return hidden_states, sample_hidden_states

    @torch.inference_mode()
317
    def _dummy_sampler_run(self, hidden_states: torch.Tensor) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
318
319
        num_reqs = hidden_states.shape[0]
        logits = self.model.compute_logits(hidden_states)
320
321
322
        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)
323
324
325
326
        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
        )
327
328
329
        # 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.
330
331
332
333
334
335
336
337
338
        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
339
340
341
342

    @torch.inference_mode()
    def profile_run(self) -> None:
        hidden_states, sample_hidden_states = self._dummy_run(
343
            self.max_num_tokens, skip_attn=True
Woosuk Kwon's avatar
Woosuk Kwon committed
344
345
        )
        self._dummy_sampler_run(sample_hidden_states)
346
        if self.do_spec_decode:
347
            num_tokens_across_dp = make_num_tokens_across_dp(
348
                self.parallel_config.data_parallel_size, self.max_num_tokens
349
350
351
352
            )
            self.speculator.run_model(
                self.max_num_tokens,
                attn_metadata=None,
353
                slot_mappings=None,
354
355
                num_tokens_across_dp=num_tokens_across_dp,
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
356
357
358
359
360
        torch.cuda.synchronize()
        del hidden_states, sample_hidden_states
        gc.collect()

    def reset_mm_cache(self) -> None:
361
362
        if self.supports_mm_inputs:
            self.encoder_runner.reset_mm_cache()
363
364

    def reset_encoder_cache(self) -> None:
365
366
        if self.supports_mm_inputs:
            self.encoder_runner.reset_encoder_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381

    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

        start_time = time.perf_counter()
382
        gc.collect()
383
        torch.cuda.empty_cache()
Woosuk Kwon's avatar
Woosuk Kwon committed
384
385
386
        start_free_gpu_memory = torch.cuda.mem_get_info()[0]

        with self.maybe_setup_dummy_loras(self.lora_config):
387
388
389
            mrope_positions = None
            if self.uses_mrope:
                mrope_positions = self.mrope_states.mrope_positions
390
391
392
            inputs_embeds = None
            if self.supports_mm_inputs:
                inputs_embeds = self.encoder_runner.inputs_embeds
Woosuk Kwon's avatar
Woosuk Kwon committed
393
394
395
            self.cudagraph_manager.capture(
                model=self.model,
                input_buffers=self.input_buffers,
396
                mrope_positions=mrope_positions,
397
                inputs_embeds=inputs_embeds,
Woosuk Kwon's avatar
Woosuk Kwon committed
398
399
400
401
                block_tables=self.block_tables,
                attn_metadata_builders=self.attn_metadata_builders,
                kv_cache_config=self.kv_cache_config,
            )
402
403
            if self.do_spec_decode:
                self.speculator.capture_model()
Woosuk Kwon's avatar
Woosuk Kwon committed
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423

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

424
    def finish_requests(self, scheduler_output: SchedulerOutput) -> None:
425
        finished_req_ids = scheduler_output.finished_req_ids
426
427
428
        preempted_req_ids = scheduler_output.preempted_req_ids
        if preempted_req_ids:
            finished_req_ids = finished_req_ids.union(preempted_req_ids)
429
        for req_id in finished_req_ids:
Woosuk Kwon's avatar
Woosuk Kwon committed
430
            self.req_states.remove_request(req_id)
431
432
            if self.supports_mm_inputs:
                self.encoder_runner.remove_request(req_id)
433
            self.prompt_logprobs_worker.remove_request(req_id)
434
            self.lora_state.remove_request(req_id)
435

436
    def free_states(self, scheduler_output: SchedulerOutput) -> None:
437
438
439
        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
440

441
    def add_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
442
        for new_req_data in scheduler_output.scheduled_new_reqs:
443
444
445
            assert new_req_data.prompt_token_ids is not None
            assert new_req_data.prefill_token_ids is not None
            assert new_req_data.sampling_params is not None
Woosuk Kwon's avatar
Woosuk Kwon committed
446
            req_id = new_req_data.req_id
447
            prompt_len = len(new_req_data.prompt_token_ids)
Woosuk Kwon's avatar
Woosuk Kwon committed
448
449
            self.req_states.add_request(
                req_id=req_id,
450
                prompt_len=prompt_len,
Woosuk Kwon's avatar
Woosuk Kwon committed
451
452
453
454
                prefill_token_ids=new_req_data.prefill_token_ids,
                num_computed_tokens=new_req_data.num_computed_tokens,
            )
            req_index = self.req_states.req_id_to_index[req_id]
455

456
457
458
            if self.supports_mm_inputs:
                self.encoder_runner.add_request(req_id, new_req_data.mm_features)

459
460
461
462
463
464
            # Pre-compute M-RoPE positions for prefill.
            if self.uses_mrope:
                self.mrope_states.init_prefill_mrope_positions(
                    req_index,
                    self.model,  # type: ignore
                    new_req_data.prefill_token_ids,
465
                    mm_features=new_req_data.mm_features,
466
467
                )

468
469
470
            self.block_tables.append_block_ids(
                req_index, new_req_data.block_ids, overwrite=True
            )
471
472
473
            self.sampler.add_request(
                req_index, prompt_len, new_req_data.sampling_params
            )
474
475
476
            self.prompt_logprobs_worker.add_request(
                req_id, req_index, new_req_data.sampling_params
            )
477
            self.lora_state.add_request(req_id, req_index, new_req_data.lora_request)
Woosuk Kwon's avatar
Woosuk Kwon committed
478

479
480
481
482
483
484
485
486
487
488
489
        if scheduler_output.scheduled_new_reqs:
            self.req_states.apply_staged_writes()
            self.sampler.apply_staged_writes(
                self.req_states.prefill_token_ids.gpu,
                self.req_states.prefill_len.np,
                self.req_states.prompt_len,
            )
            if self.uses_mrope:
                self.mrope_states.apply_staged_writes()

    def update_requests(self, scheduler_output: SchedulerOutput) -> None:
Woosuk Kwon's avatar
Woosuk Kwon committed
490
        # Add new blocks for the existing requests.
491
492
        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
493
            if req_new_block_ids is not None:
494
                req_index = self.req_states.req_id_to_index[req_id]
495
496
497
                self.block_tables.append_block_ids(
                    req_index, req_new_block_ids, overwrite=False
                )
Woosuk Kwon's avatar
Woosuk Kwon committed
498
499

    def prepare_inputs(
500
        self, scheduler_output: SchedulerOutput, num_tokens_after_padding: int
Woosuk Kwon's avatar
Woosuk Kwon committed
501
502
503
    ) -> InputBatch:
        num_tokens = scheduler_output.total_num_scheduled_tokens
        assert num_tokens > 0
504
505
        num_tokens_per_req = scheduler_output.num_scheduled_tokens
        num_reqs = len(num_tokens_per_req)
Woosuk Kwon's avatar
Woosuk Kwon committed
506
507
508

        # Decode first, then prefill.
        # batch_idx -> req_id
509
510
511
        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
512

513
514
        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)
515
        idx_mapping = async_copy_to_gpu(idx_mapping_np, device=self.device)
Woosuk Kwon's avatar
Woosuk Kwon committed
516

517
        # Get the number of draft tokens for each request.
518
519
        draft_tokens = scheduler_output.scheduled_spec_decode_tokens
        if not draft_tokens:
520
521
522
            # No draft token scheduled (common case).
            total_num_draft_tokens = 0
            total_num_logits = num_reqs
523
            cu_num_logits_np = np.arange(num_reqs + 1, dtype=np.int32)
524
525
526
            cu_num_logits = torch.arange(
                num_reqs + 1, device=self.device, dtype=torch.int32
            )
527
            expanded_idx_mapping = idx_mapping
528
529
530
            expanded_local_pos = torch.zeros(
                num_reqs, dtype=torch.int32, device=self.device
            )
531
532
        else:
            num_draft_tokens = np.array(
533
                [len(draft_tokens.get(req_id, ())) for req_id in req_ids],
534
535
536
537
538
                dtype=np.int32,
            )
            total_num_draft_tokens = int(num_draft_tokens.sum())
            total_num_logits = num_reqs + total_num_draft_tokens

539
540
541
542
            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:])
543
            cu_num_logits = async_copy_to_gpu(cu_num_logits_np, device=self.device)
544

545
            max_expand_len = self.num_speculative_steps + 1
546
            expanded_idx_mapping, expanded_local_pos = expand_idx_mapping(
547
                idx_mapping, total_num_logits, cu_num_logits, max_expand_len
548
549
            )

Woosuk Kwon's avatar
Woosuk Kwon committed
550
551
552
        # Block tables: num_kv_cache_groups x [num_reqs, max_num_blocks]
        block_tables = self.block_tables.gather_block_tables(idx_mapping)

553
        # Get query_start_loc.
554
555
556
        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])
557
558
        # Pad for full CUDA graph mode.
        # Some attention backends like FA3 require query_start_loc to be non-decreasing.
559
        query_start_loc_np[num_reqs + 1 :] = num_tokens
560
561
        async_copy_to_gpu(query_start_loc_np, out=self.input_buffers.query_start_loc)

562
563
564
        query_start_loc_np = query_start_loc_np[: num_reqs + 1]
        query_start_loc_cpu = torch.from_numpy(query_start_loc_np)
        query_start_loc = self.input_buffers.query_start_loc[: num_reqs + 1]
565
        max_query_len = num_scheduled_tokens.max().item()
566

567
        # Get prefill tokens.
568
        prepare_prefill_inputs(
569
570
571
            self.input_buffers.input_ids,
            self.req_states.next_prefill_tokens,
            idx_mapping,
572
            query_start_loc,
573
574
            self.req_states.prefill_token_ids.gpu,
            self.req_states.prefill_len.gpu,
575
            self.req_states.num_computed_tokens.gpu,
Woosuk Kwon's avatar
Woosuk Kwon committed
576
577
        )

578
579
580
        # Prepare positions and seq_lens.
        prepare_pos_seq_lens(
            idx_mapping,
581
582
            query_start_loc,
            self.req_states.num_computed_tokens.gpu,
583
584
585
586
587
            self.input_buffers.positions,
            self.input_buffers.seq_lens,
        )
        seq_lens = self.input_buffers.seq_lens[:num_reqs]

588
589
590
591
592
593
594
595
596
        # Prepare M-RoPE positions.
        if self.uses_mrope:
            self.mrope_states.prepare_mrope_positions(
                idx_mapping,
                query_start_loc,
                self.req_states.prefill_len.gpu,
                self.req_states.num_computed_tokens.gpu,
            )

597
        # Some input token ids are directly read from the last sampled tokens
598
599
        # and draft tokens. Also, get the logits indices to sample tokens from.
        logits_indices = combine_sampled_and_draft_tokens(
600
            self.input_buffers.input_ids,
Woosuk Kwon's avatar
Woosuk Kwon committed
601
602
            idx_mapping,
            self.req_states.last_sampled_tokens,
603
            query_start_loc,
604
605
            seq_lens,
            self.req_states.prefill_len.gpu,
606
607
608
            self.req_states.draft_tokens,
            cu_num_logits,
            total_num_logits,
Woosuk Kwon's avatar
Woosuk Kwon committed
609
610
611
612
        )

        # Compute slot mappings: [num_kv_cache_groups, num_tokens]
        slot_mappings = self.block_tables.compute_slot_mappings(
613
614
615
            idx_mapping,
            query_start_loc,
            self.input_buffers.positions[:num_tokens],
Woosuk Kwon's avatar
Woosuk Kwon committed
616
        )
617
618
619
620
        # Layer name -> slot mapping.
        slot_mappings_by_layer = build_slot_mappings_by_layer(
            slot_mappings, self.kv_cache_config
        )
Woosuk Kwon's avatar
Woosuk Kwon committed
621
622
623
624
625
626

        # Layer name -> attention metadata.
        attn_metadata = build_attn_metadata(
            attn_metadata_builders=self.attn_metadata_builders,
            num_reqs=num_reqs,
            num_tokens=num_tokens,
627
            query_start_loc_gpu=query_start_loc,
628
            query_start_loc_cpu=query_start_loc_cpu,
629
            max_query_len=max_query_len,
Woosuk Kwon's avatar
Woosuk Kwon committed
630
            seq_lens=self.input_buffers.seq_lens,
631
            max_seq_len=self.max_model_len,
Woosuk Kwon's avatar
Woosuk Kwon committed
632
633
634
635
636
            block_tables=block_tables,
            slot_mappings=slot_mappings,
            kv_cache_config=self.kv_cache_config,
        )

637
        input_ids = self.input_buffers.input_ids[:num_tokens_after_padding]
638
        positions = self.input_buffers.positions[:num_tokens_after_padding]
639
640
        mrope_positions = None
        if self.uses_mrope:
641
642
            mrope_positions = self.mrope_states.mrope_positions
            mrope_positions = mrope_positions[:, :num_tokens_after_padding]
Woosuk Kwon's avatar
Woosuk Kwon committed
643
644
645
646
647
        return InputBatch(
            req_ids=req_ids,
            num_reqs=num_reqs,
            idx_mapping=idx_mapping,
            idx_mapping_np=idx_mapping_np,
648
            expanded_idx_mapping=expanded_idx_mapping,
649
            expanded_local_pos=expanded_local_pos,
Woosuk Kwon's avatar
Woosuk Kwon committed
650
651
652
            num_scheduled_tokens=num_scheduled_tokens,
            num_tokens=num_tokens,
            num_tokens_after_padding=num_tokens_after_padding,
653
            num_draft_tokens=total_num_draft_tokens,
654
            query_start_loc=query_start_loc,
Woosuk Kwon's avatar
Woosuk Kwon committed
655
            query_start_loc_np=query_start_loc_np,
656
            seq_lens=seq_lens,
Woosuk Kwon's avatar
Woosuk Kwon committed
657
658
            input_ids=input_ids,
            positions=positions,
659
            mrope_positions=mrope_positions,
660
            inputs_embeds=None,
Woosuk Kwon's avatar
Woosuk Kwon committed
661
            attn_metadata=attn_metadata,
662
            slot_mappings=slot_mappings_by_layer,
Woosuk Kwon's avatar
Woosuk Kwon committed
663
            logits_indices=logits_indices,
664
            cu_num_logits=cu_num_logits,
665
            cu_num_logits_np=cu_num_logits_np,
666
            has_structured_output_reqs=scheduler_output.has_structured_output_requests,
Woosuk Kwon's avatar
Woosuk Kwon committed
667
668
        )

669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
    @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
689
690
691
692
693
    def sample(
        self,
        hidden_states: torch.Tensor,
        input_batch: InputBatch,
        grammar_output: GrammarOutput | None,
694
    ) -> tuple[SamplerOutput, torch.Tensor, torch.Tensor]:
Woosuk Kwon's avatar
Woosuk Kwon committed
695
        sample_hidden_states = hidden_states[input_batch.logits_indices]
696
        sample_pos = input_batch.positions[input_batch.logits_indices]
697
        input_ids = input_batch.input_ids[input_batch.logits_indices]
Woosuk Kwon's avatar
Woosuk Kwon committed
698
699
700
        logits = self.model.compute_logits(sample_hidden_states)
        if grammar_output is not None:
            # Apply grammar bitmask to the logits in-place.
701
702
703
704
705
706
            self.structured_outputs_worker.apply_grammar_bitmask(
                logits,
                input_batch,
                grammar_output.structured_output_request_ids,
                grammar_output.grammar_bitmask,
            )
707

708
        # Sample tokens and compute logprobs (if needed).
709
710
711
712
        sampler_output = self.sampler(
            logits,
            input_batch.expanded_idx_mapping,
            input_batch.idx_mapping_np,
713
            input_batch.cu_num_logits_np,
714
            sample_pos,
715
716
            input_ids,
            input_batch.expanded_local_pos,
717
        )
718
719
720

        if input_batch.num_draft_tokens == 0:
            # No draft tokens (common case).
721
722
723
            num_sampled = torch.ones(
                input_batch.num_reqs, dtype=torch.int32, device=self.device
            )
724
        else:
725
            # Rejection sampling for spec decoding.
726
727
728
729
730
731
732
            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
733
734
735
736
737
738
739
740
741
742

        # 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,
        )
743
        return sampler_output, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
744
745
746
747

    def postprocess(
        self,
        input_batch: InputBatch,
748
749
        sampled_tokens: torch.Tensor,
        num_sampled: torch.Tensor,
750
        num_rejected: torch.Tensor,
751
752
    ) -> None:
        # Update the number of computed tokens.
753
        post_update(
754
            input_batch.idx_mapping,
755
            self.req_states.num_computed_tokens.gpu,
756
            self.req_states.last_sampled_tokens,
757
            self.sampler.penalties_state.output_bin_counts,
758
759
            sampled_tokens,
            num_sampled,
760
            num_rejected,
761
            input_batch.query_start_loc,
Woosuk Kwon's avatar
Woosuk Kwon committed
762
        )
763
764

        # Update the number of computed prefill tokens.
Woosuk Kwon's avatar
Woosuk Kwon committed
765
        idx_mapping_np = input_batch.idx_mapping_np
766
        computed_prefill = self.req_states.num_computed_prefill_tokens
767
768
769
        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
770
771
        )

772
773
774
775
776
777
778
    @torch.inference_mode()
    def propose_draft(
        self,
        input_batch: InputBatch,
        last_hidden_states: torch.Tensor,
        aux_hidden_states: list[torch.Tensor] | None,
        num_sampled: torch.Tensor,
779
        num_rejected: torch.Tensor,
780
781
782
783
784
785
786
    ) -> torch.Tensor:
        assert self.speculator is not None
        draft_tokens = self.speculator.propose(
            input_batch,
            last_hidden_states,
            aux_hidden_states,
            num_sampled,
787
            num_rejected,
788
789
            self.req_states.last_sampled_tokens,
            self.req_states.next_prefill_tokens,
790
791
            self.sampler.sampling_states.temperature.gpu,
            self.sampler.sampling_states.seeds.gpu,
792
793
794
        )
        return draft_tokens

Woosuk Kwon's avatar
Woosuk Kwon committed
795
796
797
798
799
800
    @torch.inference_mode()
    def execute_model(
        self,
        scheduler_output: SchedulerOutput,
        intermediate_tensors: Any | None = None,
        dummy_run: bool = False,
801
        skip_attn_for_dummy_run: bool = False,
Woosuk Kwon's avatar
Woosuk Kwon committed
802
803
    ) -> ModelRunnerOutput | None:
        assert intermediate_tensors is None
804
805
806
807
808
809
810
811
812
        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.
813
814
                empty_output = self.kv_connector.no_forward(scheduler_output)
                return empty_output
Woosuk Kwon's avatar
Woosuk Kwon committed
815

816
817
818
819
820
821
822
        # Get the CUDA graph size. None means no CUDA graph is used.
        cudagraph_size = self.cudagraph_manager.get_cudagraph_size(
            scheduler_output.total_num_scheduled_tokens,
            scheduler_output.num_scheduled_tokens.values(),
        )
        use_cudagraph, num_tokens_after_padding, num_tokens_across_dp = (
            get_cudagraph_and_dp_padding(
823
                scheduler_output.total_num_scheduled_tokens,
824
825
826
                cudagraph_size,
                self.parallel_config.data_parallel_size,
                self.parallel_config.data_parallel_rank,
827
            )
Woosuk Kwon's avatar
Woosuk Kwon committed
828
        )
829
830
        if num_tokens_after_padding == 0:
            # All DP ranks have zero tokens to run.
831
832
            empty_output = self.kv_connector.no_forward(scheduler_output)
            return empty_output
833
834
835
836
837

        if not dummy_run:
            # Common case.
            # Prepare all the inputs and copy to the input buffers.
            input_batch = self.prepare_inputs(
838
                scheduler_output, num_tokens_after_padding
839
840
841
            )
            if self.lora_config:
                # Activate LoRA adapters.
842
                lora_inputs = self.lora_state.make_lora_inputs(
843
844
845
                    input_batch.req_ids,
                    input_batch.idx_mapping_np,
                    input_batch.num_scheduled_tokens,
Woosuk Kwon's avatar
Woosuk Kwon committed
846
                )
847
                self._set_active_loras(*lora_inputs)
848
849
850
851
852
853
854
855
856
857
858
859

            if self.supports_mm_inputs:
                # Execute the multimodal encoder.
                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
                ]
860
        else:
861
            # No actual tokens to run. A dummy run for DP or memory profiling.
862
863
864
865
866
867
868
            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,
            )
869
870
871
872
            if self.uses_mrope:
                input_batch.mrope_positions = self.mrope_states.mrope_positions[
                    :, :num_tokens_after_padding
                ]
873
874
875
            if not skip_attn_for_dummy_run:
                self.prepare_dummy_attn_metadata(input_batch)
            # FIXME(woosuk): Fix warmup for LoRA.
Woosuk Kwon's avatar
Woosuk Kwon committed
876
877

        # Run model.
878
        if use_cudagraph:
Woosuk Kwon's avatar
Woosuk Kwon committed
879
880
881
            # Run CUDA graph.
            # NOTE(woosuk): Here, we don't need to pass the input tensors,
            # because they are already copied to the CUDA graph input buffers.
882
            self.kv_connector.pre_forward(scheduler_output)
Woosuk Kwon's avatar
Woosuk Kwon committed
883
884
885
886
887
            hidden_states = self.cudagraph_manager.run(
                input_batch.num_tokens_after_padding
            )
        else:
            # Run PyTorch model in eager mode.
888
889
890
            positions = input_batch.positions
            if self.uses_mrope:
                assert input_batch.mrope_positions is not None
891
                positions = input_batch.mrope_positions
Woosuk Kwon's avatar
Woosuk Kwon committed
892
893
894
895
            with set_forward_context(
                input_batch.attn_metadata,
                self.vllm_config,
                num_tokens=input_batch.num_tokens_after_padding,
896
897
                # TODO(woosuk): Support piecewise CUDA graph.
                cudagraph_runtime_mode=CUDAGraphMode.NONE,
Woosuk Kwon's avatar
Woosuk Kwon committed
898
                num_tokens_across_dp=num_tokens_across_dp,
899
                slot_mapping=input_batch.slot_mappings,
Woosuk Kwon's avatar
Woosuk Kwon committed
900
            ):
901
                self.kv_connector.pre_forward(scheduler_output)
Woosuk Kwon's avatar
Woosuk Kwon committed
902
903
                hidden_states = self.model(
                    input_ids=input_batch.input_ids,
904
                    positions=positions,
905
                    inputs_embeds=input_batch.inputs_embeds,
Woosuk Kwon's avatar
Woosuk Kwon committed
906
907
                )

908
909
        kv_connector_output = self.kv_connector.post_forward(scheduler_output)
        self.execute_model_state = hidden_states, input_batch, kv_connector_output
Woosuk Kwon's avatar
Woosuk Kwon committed
910
911
912
913
        return None

    @torch.inference_mode()
    def sample_tokens(
914
        self, grammar_output: GrammarOutput | None
Woosuk Kwon's avatar
Woosuk Kwon committed
915
916
    ) -> AsyncOutput | ModelRunnerOutput:
        assert self.execute_model_state is not None
917
        hidden_states, input_batch, kv_connector_output = self.execute_model_state
Woosuk Kwon's avatar
Woosuk Kwon committed
918
919
        self.execute_model_state = None  # type: ignore

920
        sampler_output, num_sampled, num_rejected = self.sample(
921
            hidden_states, input_batch, grammar_output
Woosuk Kwon's avatar
Woosuk Kwon committed
922
        )
923
924
925
926
927
928
929
930
931
932
        prompt_logprobs_dict = self.prompt_logprobs_worker.compute_prompt_logprobs(
            self.model.compute_logits,
            hidden_states,
            input_batch,
            self.req_states.prefill_token_ids.gpu,
            self.req_states.num_computed_tokens.gpu,
            self.req_states.prompt_len,
            self.req_states.prefill_len.np,
            self.req_states.num_computed_prefill_tokens,
        )
933
934
935
936
937
938
939
940

        # 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
941
            prompt_logprobs_dict=prompt_logprobs_dict,  # type: ignore[arg-type]
942
            kv_connector_output=kv_connector_output,
943
944
945
946
        )
        async_output = AsyncOutput(
            model_runner_output=model_runner_output,
            sampler_output=sampler_output,
947
            num_sampled_tokens=num_sampled,
948
949
950
951
952
953
954
955
956
957
            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(
958
            input_batch, sampler_output.sampled_token_ids, num_sampled, num_rejected
Woosuk Kwon's avatar
Woosuk Kwon committed
959
        )
960
        if self.do_spec_decode:
961
            draft_tokens = self.propose_draft(
962
963
964
                input_batch,
                hidden_states,
                None,  # aux_hidden_states
965
966
                num_sampled,
                num_rejected,
967
            )
968
            self.req_states.draft_tokens[input_batch.idx_mapping] = draft_tokens
969
            self.draft_tokens_handler.set_draft_tokens(input_batch, draft_tokens)
970
971
972
973

        if self.use_async_scheduling:
            return async_output
        return async_output.get_output()
974
975
976

    def take_draft_token_ids(self) -> DraftTokenIds | None:
        return self.draft_tokens_handler.get_draft_tokens()