model_runner.py 102 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342
  1. # SPDX-License-Identifier: Apache-2.0
  2. # SPDX-FileCopyrightText: Copyright contributors to the vLLM project
  3. """NOTE: Coding style guide for this file:
  4. This model runner is shared by all models: text and multimodal, generative
  5. and embedding, public and private. As a result, this file must only contain
  6. code that is common to every model. Model-specific behavior belongs in the
  7. appropriate model-specific files.
  8. In other words:
  9. * Be paranoid about changing this file. It should remain stable.
  10. * Be even more paranoid about adding new lines. It should remain minimal.
  11. Even for shared features (for example, different parallelism modes), keep the
  12. complexity out of this path. The less common the feature, the more it should be
  13. hidden. Prefer utility functions defined elsewhere and call them from here,
  14. instead of embedding feature-specific logic directly.
  15. """
  16. import functools
  17. import gc
  18. import time
  19. from contextlib import AbstractContextManager
  20. from copy import deepcopy
  21. from typing import Any, NamedTuple
  22. import numpy as np
  23. import torch
  24. from vllm.v1.worker.gpu.spec_decode import draft_trunc
  25. import torch.nn as nn
  26. import vllm.envs as envs
  27. from vllm.compilation.counter import compilation_counter
  28. from vllm.compilation.cuda_graph import CUDAGraphStat
  29. from vllm.config import VllmConfig
  30. from vllm.config.compilation import CUDAGraphMode
  31. from vllm.distributed.aux_output_connector.worker import (
  32. AuxOutputWorkerConnector,
  33. get_aux_output_connector,
  34. )
  35. from vllm.distributed.parallel_state import get_dcp_group, get_pp_group
  36. from vllm.forward_context import BatchDescriptor, set_forward_context
  37. from vllm.logger import init_logger
  38. from vllm.model_executor.layers.fused_moe.all2all_utils import get_ep_all2all_manager
  39. from vllm.model_executor.layers.mamba.ops.ssu_dispatch import (
  40. initialize_mamba_ssu_backend,
  41. )
  42. from vllm.model_executor.model_loader import get_model_loader
  43. from vllm.model_executor.models.interfaces import requires_raw_input_tokens
  44. from vllm.model_executor.offloader import (
  45. create_offloader,
  46. get_offloader,
  47. set_offloader,
  48. )
  49. from vllm.model_executor.warmup.jit_warmup import JitWarmupRegistry
  50. from vllm.multimodal import MULTIMODAL_REGISTRY
  51. from vllm.multimodal.encoder_budget import (
  52. MultiModalBudget,
  53. )
  54. from vllm.platforms import current_platform
  55. from vllm.sequence import IntermediateTensors
  56. from vllm.tasks import SupportedTask
  57. from vllm.utils.gc_utils import freeze_gc_for_cudagraph_capture
  58. from vllm.utils.mem_utils import DeviceMemoryProfiler, format_gib
  59. from vllm.utils.torch_utils import STR_DTYPE_TO_TORCH_DTYPE, async_tensor_h2d
  60. from vllm.v1.core.sched.output import GrammarOutput, SchedulerOutput
  61. from vllm.v1.kv_cache_interface import (
  62. KVCacheConfig,
  63. MambaSpec,
  64. UniformTypeKVCacheSpecs,
  65. )
  66. from vllm.v1.outputs import (
  67. DraftTokenIds,
  68. ECConnectorOutput,
  69. ModelRunnerOutput,
  70. )
  71. from vllm.v1.watermarking import create_watermarker
  72. from vllm.v1.watermarking.gpu_sampler import GPUWatermarkSampler
  73. from vllm.v1.watermarking.spec_decode import (
  74. create_speculative_target_watermarker,
  75. speculative_target_watermark_key,
  76. )
  77. from vllm.v1.worker.block_table import get_block_table_width
  78. from vllm.v1.worker.cp_utils import check_attention_cp_compatibility
  79. from vllm.v1.worker.gpu import pcp_manager as pcp
  80. from vllm.v1.worker.gpu.async_utils import (
  81. AsyncOutput,
  82. AsyncPoolingOutput,
  83. StepTimingCollector,
  84. )
  85. from vllm.v1.worker.gpu.attn_utils import (
  86. FastPrefillHelper,
  87. build_slot_mappings_by_layer,
  88. get_kv_cache_spec,
  89. init_attn_backend,
  90. init_kv_cache,
  91. )
  92. from vllm.v1.worker.gpu.block_table import BlockTables
  93. from vllm.v1.worker.gpu.buffer_utils import set_default_max_concurrency
  94. from vllm.v1.worker.gpu.cp_utils import prepare_dcp_local_seq_lens
  95. from vllm.v1.worker.gpu.cudagraph_utils import (
  96. BatchExecutionDescriptor,
  97. ModelCudaGraphManager,
  98. has_compiled_submodule,
  99. make_cudagraph_stats,
  100. )
  101. from vllm.v1.worker.gpu.cudagraph_utils import (
  102. profile_cudagraph_memory as _profile_cudagraph_memory,
  103. )
  104. from vllm.v1.worker.gpu.dp_utils import DPSyncState, dispatch_cg_and_sync_dp
  105. from vllm.v1.worker.gpu.ec_connector import get_ec_connector
  106. from vllm.v1.worker.gpu.eplb_utils import EPLBController, step_eplb_after
  107. from vllm.v1.worker.gpu.input_batch import (
  108. InputBatch,
  109. InputBuffers,
  110. combine_sampled_and_draft_tokens,
  111. expand_idx_mapping,
  112. post_update,
  113. post_update_num_computed_tokens,
  114. prepare_pos_seq_lens,
  115. prepare_prefill_inputs,
  116. set_dummy_context,
  117. )
  118. from vllm.v1.worker.gpu.kv_connector import (
  119. NO_OP_KV_CONNECTOR,
  120. KVConnector,
  121. get_kv_connector,
  122. )
  123. from vllm.v1.worker.gpu.lora_utils import (
  124. LoraState,
  125. create_lora_capture_hook,
  126. get_lora_capture_cases,
  127. get_num_active_loras_for_dispatch,
  128. )
  129. from vllm.v1.worker.gpu.mm.encoder_cache import EncoderCache
  130. from vllm.v1.worker.gpu.mm.lora import set_active_mm_loras
  131. from vllm.v1.worker.gpu.model_states import init_model_state
  132. from vllm.v1.worker.gpu.pool.pooling_runner import PoolingRunner
  133. from vllm.v1.worker.gpu.pp_utils import PPHandler
  134. from vllm.v1.worker.gpu.sample.batch_shard import (
  135. BatchSharder,
  136. all_to_all_logits,
  137. gather_sampler_output,
  138. )
  139. from vllm.v1.worker.gpu.sample.logits_processor import build_custom_logits_processors
  140. from vllm.v1.worker.gpu.sample.output import SamplerOutput
  141. from vllm.v1.worker.gpu.sample.prompt_logprob import PromptLogprobsWorker
  142. from vllm.v1.worker.gpu.sample.sampler import Sampler
  143. from vllm.v1.worker.gpu.shutdown import free_before_shutdown
  144. from vllm.v1.worker.gpu.spec_decode import init_speculator
  145. from vllm.v1.worker.gpu.spec_decode.adaptive_verification import (
  146. AdaptiveVerificationManager,
  147. maybe_create_adaptive_verification_manager,
  148. resolve_adaptive_cudagraph_mode,
  149. )
  150. from vllm.v1.worker.gpu.spec_decode.eagle.eagle3_utils import (
  151. set_eagle3_aux_hidden_state_layers,
  152. verify_supports_aux_hidden_states_over_pp,
  153. )
  154. from vllm.v1.worker.gpu.spec_decode.rejection_sampler import (
  155. RejectionSampler,
  156. get_max_chunk_logits,
  157. )
  158. from vllm.v1.worker.gpu.spec_decode.speculator import DraftModelSpeculator
  159. from vllm.v1.worker.gpu.spec_decode.utils import DraftTokensHandler
  160. from vllm.v1.worker.gpu.states import RequestState
  161. from vllm.v1.worker.gpu.structured_outputs import StructuredOutputsWorker
  162. from vllm.v1.worker.gpu.ubatch_utils import (
  163. UBatchRunner,
  164. UBatchState,
  165. maybe_build_ubatch_runner,
  166. )
  167. from vllm.v1.worker.lora_model_runner_mixin import LoRAModelRunnerMixin
  168. from vllm.v1.worker.utils import (
  169. KVBlockZeroer,
  170. clear_layer_kv_caches,
  171. copy_kv_cache_blocks_inplace,
  172. get_uniform_decode_token_count,
  173. )
  174. from vllm.v1.worker.workspace import lock_workspace, use_workspace_lane
  175. logger = init_logger(__name__)
  176. class GPUModelRunner(LoRAModelRunnerMixin):
  177. def __init__(self, vllm_config: VllmConfig, device: torch.device):
  178. self.vllm_config = vllm_config
  179. self.model_config = vllm_config.model_config
  180. self.cache_config = vllm_config.cache_config
  181. self.compilation_config = vllm_config.compilation_config
  182. self.lora_config = vllm_config.lora_config
  183. self.load_config = vllm_config.load_config
  184. self.parallel_config = vllm_config.parallel_config
  185. self.scheduler_config = vllm_config.scheduler_config
  186. self.speculative_config = vllm_config.speculative_config
  187. self._draft_workspace_lane = int(
  188. self.speculative_config is not None and self.speculative_config.use_dspark()
  189. )
  190. self.observability_config = vllm_config.observability_config
  191. self.jit_warmup_registry = JitWarmupRegistry(vllm_config)
  192. self.device = device
  193. self.dtype = self.model_config.dtype
  194. self.kv_cache_dtype = self.dtype
  195. if self.cache_config.cache_dtype != "auto":
  196. # Quantized KV cache.
  197. self.kv_cache_dtype = STR_DTYPE_TO_TORCH_DTYPE[
  198. self.cache_config.cache_dtype
  199. ]
  200. # Lazily initialized in _init_kv_zero_meta() when the KV cache needs
  201. # zeroing (e.g. hybrid models with fp8 KV cache).
  202. self.kv_block_zeroer: KVBlockZeroer | None = None
  203. self.vocab_size = self.model_config.get_vocab_size()
  204. self.max_model_len = self.model_config.max_model_len
  205. self.max_num_tokens = self.scheduler_config.max_num_batched_tokens
  206. self.max_num_reqs = self.scheduler_config.max_num_seqs
  207. self.is_encoder_decoder = self.model_config.is_encoder_decoder
  208. self.output_copy_stream = torch.cuda.Stream(self.device)
  209. # Pipeline parallelism.
  210. self.use_pp = self.parallel_config.pipeline_parallel_size > 1
  211. self.is_first_pp_rank = get_pp_group().is_first_rank
  212. self.is_last_pp_rank = get_pp_group().is_last_rank
  213. # Size the UVA buffer pools to the max number of concurrent in-flight
  214. # steps. Must run before any pooled buffer is constructed
  215. set_default_max_concurrency(vllm_config.max_concurrent_batches)
  216. # PP broadcast/recv helper. Runs the collective on a side stream.
  217. self.pp_handler: PPHandler | None = None
  218. # Persistent buffer for intermediate tensors (non-first PP ranks).
  219. self.intermediate_tensors: IntermediateTensors | None = None
  220. # Data parallelism.
  221. self.dp_size = self.parallel_config.data_parallel_size
  222. self.dp_rank = self.parallel_config.data_parallel_rank
  223. # Dual batch overlap. Created in initialize_kv_cache(), once everything
  224. # it runs the microbatched forward with exists.
  225. self.ubatch_runner: UBatchRunner | None = None
  226. # Detect EP all2all peer faults to prevent emitting corrupted output.
  227. # Only meaningful for MoE + DP with an FT-capable all2all backend.
  228. self.check_ep_fault = False
  229. if self.dp_size > 1 and self.model_config.is_moe:
  230. self.check_ep_fault = get_ep_all2all_manager().support_fault_tolerance
  231. # Decode context parallelism.
  232. self.dcp_size = self.parallel_config.decode_context_parallel_size
  233. self.use_dcp = self.dcp_size > 1
  234. self.dcp_rank = get_dcp_group().rank_in_group if self.use_dcp else 0
  235. self.cp_interleave = self.parallel_config.cp_kv_cache_interleave_size
  236. # Multimodal
  237. self.mm_registry = MULTIMODAL_REGISTRY
  238. self.supports_mm_inputs = self.model_config.supports_multimodal_inputs
  239. self.uses_inputs_embeds = (
  240. self.supports_mm_inputs or self.model_config.enable_prompt_embeds
  241. )
  242. self.encoder_cache = None
  243. if self.supports_mm_inputs and self.is_first_pp_rank:
  244. self.encoder_cache = EncoderCache()
  245. self.ec_connector = get_ec_connector(vllm_config, self.encoder_cache)
  246. # Speculative decoding.
  247. self.speculator = None
  248. self.use_aux_hidden_state_outputs = False
  249. self.num_speculative_steps = vllm_config.num_speculative_tokens
  250. if self.speculative_config is not None:
  251. if self.is_last_pp_rank:
  252. self.speculator = init_speculator(self.vllm_config, self.device)
  253. if self.speculative_config.method in (
  254. "eagle3",
  255. "dflash",
  256. "dspark",
  257. "extract_hidden_states",
  258. ):
  259. # Drafting may require auxiliary hidden states from target model outputs
  260. self.use_aux_hidden_state_outputs = True
  261. # Draft tokens propagation - for spec-dec + struct outputs.
  262. self.draft_tokens_handler = DraftTokensHandler(self.device)
  263. self.pcp_manager: pcp.PCPManager | None = None
  264. # Pooling models.
  265. self.is_pooling_model = self.model_config.runner_type == "pooling"
  266. self.pooling_runner: PoolingRunner | None = None
  267. num_prefill_lookahead = max(1, vllm_config.num_prefill_lookahead_tokens)
  268. self.step_timing = StepTimingCollector()
  269. # General request states.
  270. self.req_states = RequestState(
  271. max_num_reqs=self.max_num_reqs,
  272. max_model_len=self.max_model_len,
  273. max_num_batched_tokens=self.max_num_tokens,
  274. num_speculative_steps=self.num_speculative_steps,
  275. vocab_size=self.vocab_size,
  276. device=self.device,
  277. num_prefill_lookahead=num_prefill_lookahead,
  278. )
  279. self.adaptive_verification: AdaptiveVerificationManager | None = None
  280. self.input_buffers = InputBuffers(
  281. max_num_reqs=self.max_num_reqs,
  282. max_num_tokens=self.max_num_tokens,
  283. device=self.device,
  284. )
  285. self.fast_prefill: FastPrefillHelper | None = None
  286. if self.use_pp:
  287. self.pp_handler = PPHandler(
  288. max_num_reqs=self.max_num_reqs,
  289. num_speculative_steps=self.num_speculative_steps,
  290. device=self.device,
  291. )
  292. # Samplers and decode_query_len created in load_model() after
  293. # model_state exists (num_new_sampled_tokens_per_step from ModelState).
  294. self.sampler: Sampler | None = None
  295. self.rejection_sampler: RejectionSampler | None = None
  296. self.batch_sharder: BatchSharder | None = None
  297. self.prompt_logprobs_worker: PromptLogprobsWorker | None = None
  298. self.structured_outputs_worker: StructuredOutputsWorker | None = None
  299. self.cudagraph_manager: ModelCudaGraphManager | None = None
  300. # LoRA-related workers.
  301. self.lora_state = LoraState(max_num_reqs=self.max_num_reqs)
  302. self.lora_capture_cases = [0]
  303. if self.lora_config:
  304. self.lora_capture_cases = get_lora_capture_cases(
  305. self.lora_config, self.compilation_config
  306. )
  307. # KV Connector if configured.
  308. self.kv_connector: KVConnector = NO_OP_KV_CONNECTOR
  309. # For transferring state from execute_model to subsequent sample_tokens call.
  310. self.execute_model_state: ExecuteModelState | None = None
  311. # Expert parallelism load balancer.
  312. self.eplb = EPLBController(self.parallel_config, self.device)
  313. # The AuxOutput Connector owns R3 capture, copying, and storage.
  314. self.aux_output_connector: AuxOutputWorkerConnector | None = None
  315. set_offloader(create_offloader(self.vllm_config.offload_config))
  316. def update_max_model_len(self, max_model_len: int) -> None:
  317. self.max_model_len = max_model_len
  318. self.req_states.max_model_len = max_model_len
  319. def get_supported_tasks(self) -> tuple[SupportedTask, ...]:
  320. tasks: list[SupportedTask] = []
  321. if self.model_config.runner_type == "generate":
  322. tasks.extend(self.model_state.get_supported_generation_tasks())
  323. if self.is_pooling_model:
  324. # Do not rely on pooling_runner here, since this information is needed
  325. # on the first PP rank, while pooling_runner is only initialized
  326. # on the last PP rank.
  327. tasks.extend(PoolingRunner.get_supported_tasks(self.model))
  328. return tuple(tasks)
  329. def load_model(self, load_dummy_weights: bool = False, *args, **kwargs) -> None:
  330. time_before_load = time.perf_counter()
  331. if load_dummy_weights:
  332. self.load_config.load_format = "dummy"
  333. self.eplb.prepare_load()
  334. eplb_models_added = False
  335. with DeviceMemoryProfiler() as m:
  336. model_loader = get_model_loader(self.vllm_config.load_config)
  337. logger.info_once("Loading model from scratch...")
  338. # Capture warmup providers selected while constructing the model.
  339. with self.jit_warmup_registry.activate():
  340. self.model = model_loader.load_model(
  341. vllm_config=self.vllm_config,
  342. model_config=self.vllm_config.model_config,
  343. )
  344. if self.lora_config:
  345. self.model = self.load_lora_model(
  346. self.model, self.vllm_config, self.device
  347. )
  348. if self.use_aux_hidden_state_outputs:
  349. assert self.speculative_config is not None
  350. set_eagle3_aux_hidden_state_layers(self.model, self.speculative_config)
  351. if self.use_pp:
  352. assert self.speculative_config.method is not None
  353. verify_supports_aux_hidden_states_over_pp(
  354. self.model, self.speculative_config.method
  355. )
  356. assert self.pp_handler is not None
  357. self.pp_handler.configure_aux_hidden_state_relay(self.model)
  358. if isinstance(self.speculator, DraftModelSpeculator):
  359. with use_workspace_lane(self._draft_workspace_lane):
  360. self.speculator.load_model(self.model)
  361. eplb_models_added = self.eplb.maybe_register_speculator(
  362. self.speculator, self.speculative_config, load_dummy_weights
  363. )
  364. time_after_load = time.perf_counter()
  365. self.model_memory_usage = m.consumed_memory
  366. logger.info(
  367. "Model loading took %s GiB memory and %.6f seconds",
  368. format_gib(m.consumed_memory),
  369. time_after_load - time_before_load,
  370. )
  371. # Initialize the components that require the model.
  372. self.model_state = init_model_state(
  373. self.vllm_config, self.model, self.encoder_cache, self.device
  374. )
  375. self.decode_query_len = (
  376. self.num_speculative_steps
  377. + self.model_state.num_new_sampled_tokens_per_step
  378. )
  379. if self.parallel_config.enable_batch_sharded_sampling:
  380. if hasattr(self.model, "compute_logits_local"):
  381. self.batch_sharder = BatchSharder(
  382. max_num_reqs=self.max_num_reqs,
  383. max_num_logits_per_req=self.decode_query_len,
  384. device=self.device,
  385. )
  386. logger.info("Batch-sharded sampling enabled.")
  387. else:
  388. logger.warning_once(
  389. "Disabling batch-sharded sampling: %s does not implement "
  390. "compute_logits_local",
  391. type(self.model).__name__,
  392. )
  393. # Initialize samplers. Model states may override via custom_sampler().
  394. config_processors = self.model_config.logits_processors or ()
  395. custom_logits_processors = build_custom_logits_processors(
  396. self.vllm_config, self.req_states, self.is_pooling_model, config_processors
  397. )
  398. if self.is_last_pp_rank and not self.is_pooling_model:
  399. # V2 bypasses TopKTopPSampler, which registers native warmups.
  400. # ROCm only: on CUDA these warmups add ~2 min to every engine start.
  401. if current_platform.is_rocm():
  402. from vllm.v1.sample.ops.topk_topp_sampler import (
  403. register_top_k_top_p_warmups,
  404. )
  405. with self.jit_warmup_registry.activate():
  406. register_top_k_top_p_warmups()
  407. sampler_kwargs: dict[str, Any] = {
  408. "vllm_config": self.vllm_config,
  409. "max_num_reqs": self.max_num_reqs,
  410. "vocab_size": self.vocab_size,
  411. "device": self.device,
  412. "req_states": self.req_states,
  413. "logprobs_mode": self.model_config.logprobs_mode,
  414. "num_speculative_tokens": self.decode_query_len,
  415. "use_fp64_gumbel": self.model_config.use_fp64_gumbel,
  416. "enable_trace_replay": self.model_config.enable_trace_replay,
  417. "return_sampling_mask": self.model_config.return_sampling_mask,
  418. "custom_logits_processors": custom_logits_processors,
  419. }
  420. if self.vllm_config.watermark_config is None:
  421. self.sampler = Sampler(**sampler_kwargs)
  422. else:
  423. wm_config = self.vllm_config.watermark_config
  424. watermarker = create_watermarker(wm_config)
  425. if self.speculative_config is not None:
  426. watermarker = create_speculative_target_watermarker(watermarker)
  427. self.sampler = GPUWatermarkSampler(
  428. watermarker,
  429. deduplicate_contexts=wm_config.deduplicate_contexts,
  430. deduplicate_contexts_max_history=(
  431. wm_config.deduplicate_contexts_max_history
  432. ),
  433. **sampler_kwargs,
  434. )
  435. custom = self.model_state.custom_sampler(self.sampler)
  436. if custom:
  437. self.vllm_config._check_watermarking_unsupported(custom_sampler=True)
  438. self.sampler, self.rejection_sampler = custom
  439. elif self.speculative_config is not None:
  440. self.rejection_sampler = RejectionSampler(
  441. self.sampler,
  442. self.speculative_config,
  443. self.device,
  444. watermark_key=speculative_target_watermark_key(
  445. self.vllm_config.watermark_config
  446. ),
  447. )
  448. self.prompt_logprobs_worker = PromptLogprobsWorker(
  449. self.max_num_reqs, logprobs_mode=self.model_config.logprobs_mode
  450. )
  451. self.structured_outputs_worker = StructuredOutputsWorker(
  452. max_num_logits=self.max_num_reqs * self.decode_query_len,
  453. vocab_size=self.vocab_size,
  454. device=self.device,
  455. mask_stride=self.decode_query_len,
  456. num_bonus_tokens=self.model_state.num_new_sampled_tokens_per_step,
  457. )
  458. if self.is_pooling_model and self.is_last_pp_rank:
  459. self.pooling_runner = PoolingRunner(self.model, self.vllm_config)
  460. eplb_models_added |= self.eplb.maybe_register_model(
  461. self.model, self.model_config, load_dummy_weights
  462. )
  463. self.eplb.maybe_start_async_loop(eplb_models_added)
  464. if not self.is_first_pp_rank:
  465. # For non-first PP ranks, create intermediate tensors sized
  466. # for the max capture size so they can be sliced per batch.
  467. # Save as persistent member so runtime can copy received data
  468. # into the same addresses that the CUDA graphs captured.
  469. self.intermediate_tensors = self.model.make_empty_intermediate_tensors(
  470. batch_size=self.max_num_tokens,
  471. dtype=self.model_config.dtype,
  472. device=self.device,
  473. )
  474. get_offloader().post_init()
  475. def get_model(self) -> nn.Module:
  476. return self.model
  477. def get_draft_model(self) -> nn.Module | None:
  478. speculator = self.speculator
  479. if not isinstance(speculator, DraftModelSpeculator):
  480. return None
  481. return speculator.model
  482. def reload_weights(self, *args, **kwargs) -> None:
  483. # TODO(Wentao): Use full version instead of import when fully migrated to v2
  484. from vllm.v1.worker.gpu_model_runner import GPUModelRunner as GPUModelRunnerV1
  485. GPUModelRunnerV1.reload_weights(self, *args, **kwargs) # type: ignore[arg-type]
  486. def update_config(self, *args, **kwargs) -> None:
  487. # TODO(Wentao): Use full version instead of import when fully migrated to v2
  488. from vllm.v1.worker.gpu_model_runner import GPUModelRunner as GPUModelRunnerV1
  489. GPUModelRunnerV1.update_config(self, *args, **kwargs) # type: ignore[arg-type]
  490. # v2 reads config via self.vllm_config (e.g. in load_model), so keep it
  491. # in sync with the attributes the v1 helper just replaced.
  492. self.vllm_config.model_config = self.model_config
  493. self.vllm_config.load_config = self.load_config
  494. @functools.cached_property
  495. def main_stream(self) -> torch.cuda.Stream:
  496. # Cache the default CUDA stream to avoid lookup overhead.
  497. return torch.cuda.current_stream(self.device)
  498. def get_encoder_timing_stats(self) -> dict[str, dict[str, float | int]]:
  499. encoder_runner = getattr(self.model_state, "encoder_runner", None)
  500. if encoder_runner is None:
  501. return {}
  502. return encoder_runner.get_encoder_timing_stats()
  503. def get_kv_cache_spec(self):
  504. return get_kv_cache_spec(self.vllm_config)
  505. def initialize_kv_cache(
  506. self,
  507. kv_cache_config: KVCacheConfig,
  508. is_profiling: bool = False,
  509. kv_cache_allocation_context: AbstractContextManager | None = None,
  510. ) -> None:
  511. # GPUWorker finalizes the PD interleave before KV cache initialization.
  512. self.cp_interleave = self.parallel_config.cp_kv_cache_interleave_size
  513. kv_cache_config = deepcopy(kv_cache_config)
  514. self.kv_cache_config = kv_cache_config
  515. block_table_max_model_len = self.max_model_len
  516. if self.is_encoder_decoder:
  517. # Cross-attention block tables need to index encoder tokens, which
  518. # can exceed the decoder's max_model_len.
  519. block_table_max_model_len = max(
  520. block_table_max_model_len,
  521. self.scheduler_config.max_num_encoder_input_tokens,
  522. getattr(self.model_config.hf_config, "max_source_positions", 0),
  523. )
  524. block_sizes = []
  525. max_num_blocks_per_group = []
  526. slot_mapping_enabled = []
  527. for kv_cache_group in kv_cache_config.kv_cache_groups:
  528. spec = kv_cache_group.kv_cache_spec
  529. block_sizes.append(spec.block_size)
  530. layer_spec = (
  531. spec.first_spec if isinstance(spec, UniformTypeKVCacheSpecs) else spec
  532. )
  533. slot_mapping_enabled.append(layer_spec.uses_slot_mapping)
  534. # Let each cache type account for CP. Attention KV is DCP-sharded,
  535. # while Mamba/GDN recurrent state is replicated across DCP ranks.
  536. max_num_blocks = spec.max_num_blocks_per_req(
  537. self.vllm_config, block_table_max_model_len
  538. )
  539. # Preserve each cache type's alignment requirements after applying
  540. # its topology-aware block-table width.
  541. max_num_blocks = get_block_table_width(
  542. max_num_blocks,
  543. spec.block_size,
  544. token_alignment=spec.block_table_token_alignment,
  545. )
  546. max_num_blocks_per_group.append(max_num_blocks)
  547. target_attn_layer_names = None
  548. if isinstance(self.speculator, DraftModelSpeculator):
  549. # Adaptive verification validates target attention separately.
  550. target_attn_layer_names = {
  551. layer_name
  552. for group in self.kv_cache_config.kv_cache_groups
  553. for layer_name in group.layer_names
  554. } - self.speculator.draft_attn_layer_names
  555. draft_attn_layer_names = None
  556. if isinstance(self.speculator, DraftModelSpeculator):
  557. draft_attn_layer_names = self.speculator.draft_attn_layer_names
  558. # Metadata builders select attention kernels that need JIT warmup.
  559. with self.jit_warmup_registry.activate():
  560. (
  561. self.attn_groups,
  562. attn_cg_support,
  563. self.kernel_block_sizes,
  564. ) = init_attn_backend(
  565. self.kv_cache_config,
  566. self.vllm_config,
  567. self.device,
  568. draft_layer_names=draft_attn_layer_names,
  569. )
  570. additional_attn_cg_support = self.model_state.get_additional_cg_support()
  571. attn_cg_support = attn_cg_support.narrow(*additional_attn_cg_support)
  572. # The speculator clears the flag at load time when the checkpoint has
  573. # no confidence head, so it holds the effective value.
  574. self.adaptive_verification = maybe_create_adaptive_verification_manager(
  575. enable_adaptive_verification=getattr(
  576. self.speculator, "enable_adaptive_verification", False
  577. ),
  578. attn_groups=self.attn_groups,
  579. attn_cg_support=attn_cg_support,
  580. req_states=self.req_states,
  581. query_start_loc=self.input_buffers.query_start_loc,
  582. num_bonus_tokens=self.model_state.num_new_sampled_tokens_per_step,
  583. max_total_logits=get_max_chunk_logits(self.vocab_size),
  584. vllm_config=self.vllm_config,
  585. target_layer_names=target_attn_layer_names,
  586. additional_attn_cg_support=additional_attn_cg_support,
  587. )
  588. self.block_tables = BlockTables(
  589. block_sizes=block_sizes,
  590. max_num_reqs=self.max_num_reqs,
  591. max_num_batched_tokens=self.max_num_tokens,
  592. max_num_blocks_per_group=max_num_blocks_per_group,
  593. device=self.device,
  594. kernel_block_sizes=self.kernel_block_sizes,
  595. slot_mapping_enabled=slot_mapping_enabled,
  596. cp_size=self.dcp_size,
  597. cp_rank=self.dcp_rank,
  598. cp_interleave=self.cp_interleave,
  599. )
  600. self.pcp_manager = pcp.maybe_build_pcp_manager(
  601. self.vllm_config,
  602. self.device,
  603. self.supports_mm_inputs,
  604. self.block_tables,
  605. cls=self.pcp_manager_cls,
  606. )
  607. self.ubatch_runner = maybe_build_ubatch_runner(
  608. self.vllm_config,
  609. self.device,
  610. self.model_state,
  611. self.attn_groups,
  612. self.kv_cache_config,
  613. self.max_num_reqs,
  614. )
  615. if self.speculator is not None:
  616. self.speculator.pcp_manager = self.pcp_manager
  617. initialize_mamba_ssu_backend(
  618. self.vllm_config.mamba_config,
  619. self.kv_cache_config,
  620. use_replayssm=self.cache_config.use_replayssm,
  621. )
  622. piecewise_capture_available = bool(
  623. envs.VLLM_USE_BREAKABLE_CUDAGRAPH or has_compiled_submodule(self.model)
  624. )
  625. if self.adaptive_verification is not None:
  626. self.compilation_config.cudagraph_mode = resolve_adaptive_cudagraph_mode(
  627. self.compilation_config.cudagraph_mode,
  628. piecewise_capture_available=piecewise_capture_available,
  629. )
  630. cudagraph_mode = self.compilation_config.resolve_cudagraph_mode_and_sizes(
  631. attn_cg_support.min_cg_support,
  632. attn_cg_support.min_cg_attn_backend,
  633. self.decode_query_len,
  634. use_v2_model_runner=True,
  635. tensor_parallel_size=self.parallel_config.tensor_parallel_size,
  636. kv_cache_config=self.kv_cache_config,
  637. max_num_reqs=self.max_num_reqs,
  638. is_profiling=is_profiling,
  639. piecewise_capture_available=piecewise_capture_available,
  640. )
  641. self.cudagraph_manager = ModelCudaGraphManager(
  642. self.vllm_config,
  643. self.device,
  644. cudagraph_mode,
  645. decode_query_len=self.decode_query_len,
  646. lora_capture_cases=self.lora_capture_cases,
  647. varlen_decode=self.adaptive_verification is not None,
  648. ubatch_runner=self.ubatch_runner,
  649. )
  650. if self.cache_config.kv_sharing_fast_prefill and self.pcp_manager is None:
  651. self.fast_prefill = FastPrefillHelper(
  652. self.cudagraph_manager, self.max_num_tokens
  653. )
  654. check_attention_cp_compatibility(self.vllm_config, target_attn_layer_names)
  655. if isinstance(self.speculator, DraftModelSpeculator):
  656. # HACK(woosuk)
  657. self.speculator.set_attn(
  658. self.model_state,
  659. self.kv_cache_config,
  660. self.block_tables,
  661. self.input_buffers,
  662. self.attn_groups,
  663. )
  664. if self.speculator is not None:
  665. # After set_attn, so the speculator can size its cudagraph mode
  666. # to its own attention support.
  667. self.speculator.init_cudagraph_manager(cudagraph_mode)
  668. # Capture warmup providers that depend on allocated KV-cache strides.
  669. with self.jit_warmup_registry.activate():
  670. kv_caches_dict = init_kv_cache(
  671. self.compilation_config.static_forward_context,
  672. self.kv_cache_config,
  673. self.device,
  674. self.kernel_block_sizes,
  675. self.vllm_config,
  676. kv_cache_allocation_context=kv_cache_allocation_context,
  677. block_tables=self.block_tables,
  678. )
  679. self.kv_caches = [
  680. cache for cache in kv_caches_dict.values() if cache.device == self.device
  681. ]
  682. if is_profiling:
  683. self.kv_connector = NO_OP_KV_CONNECTOR
  684. else:
  685. self.kv_connector = get_kv_connector(self.vllm_config, kv_caches_dict)
  686. # AuxOutput connector requires resolved kv_cache_config.
  687. if self.vllm_config.aux_output_config.enabled:
  688. self.aux_output_connector = get_aux_output_connector(
  689. self.model, self.vllm_config, kv_cache_config
  690. )
  691. def _init_kv_zero_meta(self) -> None:
  692. """Build KV-block zeroing metadata; invoked from gpu_worker."""
  693. self.kv_block_zeroer = KVBlockZeroer(
  694. self.device,
  695. attn_groups_iter=(g for groups in self.attn_groups for g in groups),
  696. kernel_block_sizes=self.kernel_block_sizes,
  697. static_forward_context=self.compilation_config.static_forward_context,
  698. num_blocks=self.kv_cache_config.num_blocks,
  699. )
  700. @torch.inference_mode()
  701. @step_eplb_after(is_dummy=True)
  702. def _dummy_run(
  703. self,
  704. num_tokens: int,
  705. *args,
  706. skip_attn: bool = False,
  707. uniform_decode: bool = False,
  708. context_len: int = 0,
  709. skip_eplb: bool = False,
  710. is_profile: bool = False,
  711. valid_dummy_state_slots: bool = False,
  712. **kwargs,
  713. ) -> tuple[torch.Tensor | None, torch.Tensor | None]:
  714. if skip_attn and not is_profile:
  715. raise ValueError(
  716. "skip_attn must only be True for initial memory profiling."
  717. )
  718. # Create a dummy scheduler output.
  719. num_reqs = min(num_tokens, self.max_num_reqs)
  720. if uniform_decode:
  721. # HACK(lucas): for now since the worker is shared between MRV1 and MRV2,
  722. # and for spec-decode with MTP we want to make sure the dummy runs use
  723. # 1+num_speculative_tokens we use max here, this will likely be eventually
  724. # changed in the worker: https://github.com/vllm-project/vllm/pull/35243
  725. num_tokens = max(num_tokens, self.decode_query_len)
  726. num_reqs = num_tokens // self.decode_query_len
  727. assert num_tokens % self.decode_query_len == 0
  728. elif self.speculator is not None:
  729. num_reqs = min(
  730. num_reqs, self.max_num_tokens // self.speculator.num_query_per_req
  731. )
  732. # Distribute the remainder evenly so no dummy request exceeds
  733. # ceil(num_tokens / num_reqs) <= max_model_len tokens.
  734. num_tokens_per_request = [
  735. num_tokens // num_reqs + (i >= num_reqs - num_tokens % num_reqs)
  736. for i in range(num_reqs)
  737. ]
  738. assert sum(num_tokens_per_request) == num_tokens
  739. num_scheduled_tokens = {
  740. f"_dummy_req_{i}": n for i, n in enumerate(num_tokens_per_request)
  741. }
  742. dummy_scheduler_output = SchedulerOutput.make_empty()
  743. dummy_scheduler_output.total_num_scheduled_tokens = num_tokens
  744. dummy_scheduler_output.num_scheduled_tokens = num_scheduled_tokens
  745. # Disable any use of KVConnector for dummy runs.
  746. self.kv_connector.set_disabled(True)
  747. # Get the intermediate tensors for the dummy run.
  748. intermediate_tensors = None
  749. if not self.is_first_pp_rank:
  750. assert self.intermediate_tensors is not None
  751. intermediate_tensors = self.intermediate_tensors[:num_tokens]
  752. max_loras = self.lora_config.max_loras if self.lora_config is not None else 0
  753. with self.maybe_dummy_run_with_lora(
  754. self.lora_config,
  755. num_scheduled_tokens=np.array(num_tokens_per_request, dtype=np.int32),
  756. num_sampled_tokens=None,
  757. remove_lora=True,
  758. num_active_loras=max_loras,
  759. ):
  760. # Execute the model.
  761. self.execute_model(
  762. dummy_scheduler_output,
  763. intermediate_tensors=intermediate_tensors,
  764. dummy_run=True,
  765. skip_attn_for_dummy_run=skip_attn,
  766. is_profile=is_profile,
  767. context_len=context_len,
  768. valid_dummy_state_slots=valid_dummy_state_slots,
  769. )
  770. self.kv_connector.set_disabled(False)
  771. # Non-last PP ranks don't produce output for sampling.
  772. if not self.is_last_pp_rank:
  773. return None, None
  774. assert self.execute_model_state is not None
  775. input_batch = self.execute_model_state.input_batch
  776. attn_metadata = self.execute_model_state.attn_metadata
  777. slot_mappings_by_layer = self.execute_model_state.slot_mappings_by_layer
  778. hidden_states = self.execute_model_state.hidden_states
  779. aux_hidden_states = self.execute_model_state.aux_hidden_states
  780. dp_sync = self.execute_model_state.dp_sync
  781. self.execute_model_state = None
  782. self.step_timing.forward_end()
  783. # dummy run the eagle speculator's propose to ensure DP/EP sync.
  784. if self.speculator is not None:
  785. assert self.sampler is not None
  786. self.step_timing.drafter_start()
  787. mm_inputs: tuple[list[torch.Tensor], torch.Tensor] | None = None
  788. if self.speculator.supports_mm_inputs:
  789. all_false = torch.zeros(
  790. input_batch.num_tokens, dtype=torch.bool, device="cpu"
  791. )
  792. mm_inputs = [], all_false
  793. # Let the target override the hidden state fed to the drafter
  794. # (e.g. DeepSeek V4 MTP needs the pre-hc_head residual). The
  795. # target returns a persistent buffer sized at max_num_batched_tokens;
  796. # slice to the active token count that propose() expects.
  797. spec_hidden_states = hidden_states
  798. if hasattr(self.model, "get_mtp_target_hidden_states"):
  799. pre_hc_hidden_states = self.model.get_mtp_target_hidden_states()
  800. spec_hidden_states = pre_hc_hidden_states[: hidden_states.shape[0]] # type: ignore[union-attr]
  801. if isinstance(self.sampler, GPUWatermarkSampler):
  802. self.speculator.prepare_watermarking(
  803. self.sampler._get_contexts(input_batch.idx_mapping),
  804. self.sampler.watermarking.gpu[input_batch.idx_mapping],
  805. )
  806. with use_workspace_lane(self._draft_workspace_lane):
  807. self.speculator.propose(
  808. input_batch=input_batch,
  809. attn_metadata=attn_metadata,
  810. slot_mappings=slot_mappings_by_layer,
  811. last_hidden_states=spec_hidden_states,
  812. aux_hidden_states=aux_hidden_states,
  813. num_sampled=torch.ones(
  814. input_batch.num_reqs, dtype=torch.int32, device=self.device
  815. ),
  816. num_rejected=torch.zeros(
  817. input_batch.num_reqs, dtype=torch.int32, device=self.device
  818. ),
  819. last_sampled=self.req_states.last_sampled_tokens,
  820. next_prefill_tokens=self.req_states.next_prefill_tokens,
  821. temperature=self.sampler.sampling_states.temperature.gpu,
  822. seeds=self.sampler.sampling_states.seeds.gpu,
  823. dp_sync=dp_sync,
  824. dummy_run=True,
  825. skip_attn_for_dummy_run=skip_attn,
  826. mm_inputs=mm_inputs,
  827. is_profile=is_profile,
  828. )
  829. self.step_timing.drafter_end()
  830. assert hidden_states is not None # Last PP rank always has hidden_states
  831. sample_hidden_states = hidden_states[input_batch.logits_indices]
  832. return hidden_states, sample_hidden_states
  833. @torch.inference_mode()
  834. def _dummy_sampler_run(self, hidden_states: torch.Tensor) -> None:
  835. num_reqs = hidden_states.shape[0]
  836. logits = self.model.compute_logits(hidden_states)
  837. dummy_input_batch = InputBatch.make_dummy(
  838. num_reqs, num_reqs, self.input_buffers
  839. )
  840. # NOTE(woosuk): During the initial memory profiling, the sampler may skip
  841. # top_k, top_p, and logprobs, using less GPU memory than what is possible
  842. # during actual execution.
  843. assert self.sampler is not None
  844. self.sampler(logits, dummy_input_batch)
  845. @torch.inference_mode()
  846. def _dummy_pooler_run(self, hidden_states: torch.Tensor) -> None:
  847. assert self.pooling_runner is not None
  848. self.pooling_runner.dummy_pooler_run(hidden_states)
  849. @torch.inference_mode()
  850. def profile_run(self) -> None:
  851. if self.supports_mm_inputs and self.is_first_pp_rank:
  852. mm_config = self.model_config.multimodal_config
  853. if mm_config is not None and not mm_config.skip_mm_profiling:
  854. mm_budget = MultiModalBudget(
  855. self.vllm_config, self.mm_registry, enable_cache=False
  856. )
  857. dummy_mm_inputs = mm_budget.get_dummy_encoder_profile_inputs()
  858. self.model_state.encoder_runner.profile_encoder_cache(
  859. dummy_mm_inputs, mm_budget
  860. )
  861. hidden_states, sample_hidden_states = self._dummy_run(
  862. self.max_num_tokens, skip_attn=True, is_profile=True
  863. )
  864. # Only run sampler/pooler on last PP rank (non-last ranks return None).
  865. if self.is_last_pp_rank:
  866. assert sample_hidden_states is not None
  867. if self.pooling_runner is None:
  868. self._dummy_sampler_run(sample_hidden_states)
  869. else:
  870. self._dummy_pooler_run(hidden_states)
  871. torch.accelerator.synchronize()
  872. del hidden_states, sample_hidden_states
  873. self.reset_encoder_cache()
  874. gc.collect()
  875. def reset_mm_cache(self) -> None:
  876. if self.encoder_cache is not None:
  877. self.encoder_cache.reset_mm_cache()
  878. def reset_encoder_cache(self) -> None:
  879. if self.encoder_cache is not None:
  880. self.encoder_cache.reset_encoder_cache()
  881. if self.pooling_runner is not None:
  882. self.pooling_runner.clear()
  883. @torch.inference_mode()
  884. def profile_cudagraph_memory(self) -> int:
  885. """Estimate the GPU memory required to capture CUDA graphs."""
  886. return _profile_cudagraph_memory(self)
  887. def needs_cudagraph_capture(self) -> bool:
  888. """Whether capture_model() has any CUDA graphs left to capture."""
  889. return (
  890. self.model_state.supports_mm_inputs
  891. and self.model_state.encoder_runner.has_cudagraph()
  892. ) or (
  893. self.cudagraph_manager is not None
  894. and self.cudagraph_manager.needs_capture()
  895. )
  896. @torch.inference_mode()
  897. def capture_model(self, *, profile_only: bool = False) -> int:
  898. assert self.cudagraph_manager is not None
  899. capture_encoder = (
  900. self.model_state.supports_mm_inputs
  901. and self.model_state.encoder_runner.has_cudagraph()
  902. )
  903. capture_decoder = self.cudagraph_manager.needs_capture()
  904. if not capture_encoder and not capture_decoder:
  905. logger.warning(
  906. "Skipping encoder and decoder CUDA graph capture. To enable "
  907. "encoder capture, ensure `cudagraph_mm_encoder` is enabled; "
  908. "to enable decoder capture, ensure `cudagraph_mode` is not `NONE`."
  909. )
  910. return 0
  911. compilation_counter.num_gpu_runner_capture_triggers += 1
  912. start_time = time.perf_counter()
  913. with freeze_gc_for_cudagraph_capture():
  914. torch.accelerator.empty_cache()
  915. start_free_gpu_memory = torch.accelerator.get_memory_info()[0]
  916. with self.maybe_setup_dummy_loras(self.lora_config):
  917. if capture_encoder:
  918. self.model_state.encoder_runner.capture()
  919. if capture_decoder:
  920. input_buffers = self.input_buffers
  921. if self.pcp_manager is not None:
  922. input_buffers = self.pcp_manager.input_buffers
  923. self.cudagraph_manager.capture(
  924. self.model,
  925. self.model_state,
  926. input_buffers,
  927. self.intermediate_tensors,
  928. self.block_tables,
  929. self.attn_groups,
  930. self.kv_cache_config,
  931. pcp_manager=self.pcp_manager,
  932. has_lora=self.lora_config is not None,
  933. use_aux_hidden_state_outputs=self.use_aux_hidden_state_outputs,
  934. lora_capture_hook=create_lora_capture_hook(
  935. self.lora_config, self
  936. ),
  937. )
  938. if self.speculator is not None:
  939. with use_workspace_lane(self._draft_workspace_lane):
  940. self.speculator.capture()
  941. if self.adaptive_verification is not None:
  942. with self.step_timing.collect() as timings:
  943. for batch in self.adaptive_verification.batches_to_profile(
  944. self.cudagraph_manager.captured_token_counts()
  945. ):
  946. self._dummy_run(**batch)
  947. self.adaptive_verification.set_initial_cost_curves(timings)
  948. self.kv_connector.reset_capture_state()
  949. end_free_gpu_memory = torch.accelerator.get_memory_info()[0]
  950. if not profile_only:
  951. # Lock workspace to prevent resizing during execution. A resize after
  952. # capture frees the static cuda graph buffer.
  953. lock_workspace()
  954. end_time = time.perf_counter()
  955. elapsed_time = end_time - start_time
  956. cuda_graph_size = start_free_gpu_memory - end_free_gpu_memory
  957. # This usually takes 5~20 seconds.
  958. logger.info(
  959. "Graph capturing finished in %.0f secs, took %.2f GiB",
  960. elapsed_time,
  961. cuda_graph_size / (1 << 30),
  962. )
  963. return cuda_graph_size
  964. def _remove_request(self, req_id: str) -> bool:
  965. # Call model_state.remove_request *before* req_states.remove_request
  966. # so the model_state can still look up the slot index.
  967. self.model_state.remove_request(req_id)
  968. req_idx = self.req_states.remove_request(req_id)
  969. if req_idx is None:
  970. return False
  971. if self.pooling_runner is not None:
  972. self.pooling_runner.remove_request(req_idx)
  973. if self.pp_handler is not None:
  974. self.pp_handler.on_req_idx_freed(req_idx)
  975. if self.encoder_cache is not None:
  976. self.encoder_cache.remove_request(req_id)
  977. if self.prompt_logprobs_worker is not None:
  978. self.prompt_logprobs_worker.remove_request(req_id)
  979. self.lora_state.remove_request(req_id)
  980. return True
  981. def finish_requests(self, scheduler_output: SchedulerOutput) -> None:
  982. finished_req_ids = scheduler_output.finished_req_ids
  983. if self.pooling_runner is not None:
  984. # Preempted docs keep their query-use reservation until rescheduled.
  985. self.pooling_runner.on_requests_finished(finished_req_ids)
  986. preempted_req_ids = scheduler_output.preempted_req_ids
  987. if preempted_req_ids:
  988. finished_req_ids = finished_req_ids.union(preempted_req_ids)
  989. # Sorted so every TP rank frees request slots in the same order.
  990. # Features like batch-sharded sampling derive rank request ownership
  991. # from the slot index.
  992. for req_id in sorted(finished_req_ids):
  993. self._remove_request(req_id)
  994. def free_states(self, scheduler_output: SchedulerOutput) -> None:
  995. if self.encoder_cache is not None:
  996. for mm_hash in scheduler_output.free_encoder_mm_hashes:
  997. self.encoder_cache.free_encoder_cache(mm_hash)
  998. def update_pp_decode_requests(self):
  999. # For non-last PP ranks, update decode requests with sampler output from
  1000. # the prior step in which they were scheduled (pp_size steps ago).
  1001. if self.pp_handler is not None:
  1002. outputs = self.pp_handler.get_prev_sampled_outputs(
  1003. self.req_states.draft_tokens
  1004. )
  1005. if outputs is not None:
  1006. self.postprocess_sampled(**outputs)
  1007. def add_requests(self, scheduler_output: SchedulerOutput) -> None:
  1008. for new_req_data in scheduler_output.scheduled_new_reqs:
  1009. assert new_req_data.prefill_token_ids is not None
  1010. req_id = new_req_data.req_id
  1011. # Streaming input update: request already exists from a prior
  1012. # chunk. Remove old state so it can be cleanly re-added below
  1013. # with the updated prompt_token_ids and mm_features.
  1014. self._remove_request(req_id)
  1015. prompt_len = new_req_data.prompt_len
  1016. sampling_params = new_req_data.sampling_params
  1017. self.req_states.add_request(
  1018. req_id=req_id,
  1019. prompt_len=prompt_len,
  1020. all_token_ids=new_req_data.prefill_token_ids,
  1021. num_computed_tokens=new_req_data.num_computed_tokens,
  1022. max_tokens=sampling_params.max_tokens if sampling_params else 1, # type: ignore[arg-type]
  1023. )
  1024. req_index = self.req_states.req_id_to_index[req_id]
  1025. if self.adaptive_verification is not None:
  1026. self.adaptive_verification.add_request(req_index)
  1027. if self.pooling_runner is not None:
  1028. assert new_req_data.pooling_params is not None
  1029. self.pooling_runner.add_request(
  1030. req_id,
  1031. req_index,
  1032. new_req_data.pooling_params,
  1033. new_req_data.prompt_token_ids,
  1034. )
  1035. if self.encoder_cache is not None:
  1036. self.encoder_cache.add_request(req_id, new_req_data.mm_features)
  1037. self.model_state.add_request(req_index, new_req_data)
  1038. self.block_tables.append_block_ids(
  1039. req_index, new_req_data.block_ids, overwrite=True
  1040. )
  1041. self.lora_state.add_request(req_id, req_index, new_req_data.lora_request)
  1042. if self.is_last_pp_rank and new_req_data.sampling_params is not None:
  1043. assert self.sampler is not None
  1044. self.sampler.add_request(req_index, new_req_data.sampling_params)
  1045. assert self.prompt_logprobs_worker is not None
  1046. self.prompt_logprobs_worker.add_request(
  1047. req_id, req_index, new_req_data.sampling_params
  1048. )
  1049. if scheduler_output.scheduled_new_reqs:
  1050. self.req_states.apply_staged_writes()
  1051. self.model_state.apply_staged_writes()
  1052. if self.sampler is not None:
  1053. self.sampler.apply_staged_writes()
  1054. def update_requests(self, scheduler_output: SchedulerOutput) -> None:
  1055. # Add new blocks and update num_computed_tokens for the existing requests.
  1056. reqs = scheduler_output.scheduled_cached_reqs
  1057. table_updates = scheduler_output.block_table_updates or {}
  1058. for req_id, block_ids in table_updates.items():
  1059. if (idx := self.req_states.req_id_to_index.get(req_id)) is not None:
  1060. self.block_tables.append_block_ids(idx, block_ids, overwrite=True)
  1061. num_computed_tokens_np = self.req_states.num_computed_tokens_np
  1062. for req_id, num_computed_tokens, req_new_block_ids in zip(
  1063. reqs.req_ids, reqs.num_computed_tokens, reqs.new_block_ids
  1064. ):
  1065. req_index = self.req_states.req_id_to_index[req_id]
  1066. num_computed_tokens_np[req_index] = num_computed_tokens
  1067. if req_new_block_ids is not None and req_id not in table_updates:
  1068. self.block_tables.append_block_ids(
  1069. req_index, req_new_block_ids, overwrite=False
  1070. )
  1071. # Update CPU num_computed_prefill_tokens.
  1072. np.minimum(
  1073. self.req_states.num_computed_tokens_np,
  1074. self.req_states.prefill_len.np,
  1075. out=self.req_states.num_computed_prefill_tokens,
  1076. )
  1077. # Zero GPU memory for freshly allocated cache blocks to prevent
  1078. # stale NaN/data from corrupting attention or SSM computation.
  1079. if scheduler_output.new_block_ids_to_zero:
  1080. assert self.kv_block_zeroer is not None
  1081. self.kv_block_zeroer.zero_block_ids(scheduler_output.new_block_ids_to_zero)
  1082. # Apply copy-on-write block copies for partial prefix-cache hits, after
  1083. # zeroing new blocks and before the forward pass reads them.
  1084. if scheduler_output.kv_cache_block_copies:
  1085. copy_kv_cache_blocks_inplace(
  1086. self.kv_caches,
  1087. self.kv_cache_config.num_blocks,
  1088. scheduler_output.kv_cache_block_copies,
  1089. )
  1090. def gather_batch_req_state(
  1091. self, scheduler_output: SchedulerOutput, dummy_run: bool
  1092. ) -> tuple["BatchReqState | None", int | None]:
  1093. """Gather CPU request state for the scheduled batch, in batch order.
  1094. Returns (batch_state, uniform_decode_token_count)
  1095. """
  1096. num_tokens_per_req = scheduler_output.num_scheduled_tokens
  1097. num_reqs = len(num_tokens_per_req)
  1098. num_toks = scheduler_output.total_num_scheduled_tokens
  1099. max_query_len = max(scheduler_output.num_scheduled_tokens.values())
  1100. if dummy_run:
  1101. # Dummy batches are uniform by construction.
  1102. return None, get_uniform_decode_token_count(
  1103. num_reqs, num_toks, max_query_len, has_prefill=False
  1104. )
  1105. draft_tokens = scheduler_output.scheduled_spec_decode_tokens
  1106. # batch_idx -> req_id
  1107. req_ids = sort_batch_req_ids(
  1108. num_tokens_per_req, draft_tokens, self.decode_query_len
  1109. )
  1110. numtoks_iter = map(num_tokens_per_req.__getitem__, req_ids)
  1111. num_scheduled_tokens = np.fromiter(numtoks_iter, dtype=np.int32, count=num_reqs)
  1112. idx_mapping_iter = map(self.req_states.req_id_to_index.__getitem__, req_ids)
  1113. idx_mapping_np = np.fromiter(idx_mapping_iter, dtype=np.intp, count=num_reqs)
  1114. prefill_len_np = self.req_states.prefill_len.np[idx_mapping_np]
  1115. num_computed_prefill_tokens_np = self.req_states.num_computed_prefill_tokens[
  1116. idx_mapping_np
  1117. ]
  1118. is_prefilling_np = num_computed_prefill_tokens_np < prefill_len_np
  1119. if self.adaptive_verification is not None and draft_tokens:
  1120. num_toks = self.adaptive_verification.get_num_tokens(
  1121. num_tokens_per_req, draft_tokens
  1122. )
  1123. batch_state = BatchReqState(
  1124. req_ids=req_ids,
  1125. num_scheduled_tokens=num_scheduled_tokens,
  1126. num_tokens=num_toks,
  1127. idx_mapping_np=idx_mapping_np,
  1128. prefill_len_np=prefill_len_np,
  1129. num_computed_prefill_tokens_np=num_computed_prefill_tokens_np,
  1130. is_prefilling_np=is_prefilling_np,
  1131. has_prefill=bool(is_prefilling_np.any()),
  1132. )
  1133. return batch_state, get_uniform_decode_token_count(
  1134. num_reqs, num_toks, max_query_len, batch_state.has_prefill
  1135. )
  1136. def prepare_inputs(
  1137. self,
  1138. scheduler_output: SchedulerOutput,
  1139. batch_req_state: "BatchReqState",
  1140. batch_desc: BatchExecutionDescriptor,
  1141. num_active_loras: int,
  1142. ) -> InputBatch:
  1143. num_tokens = batch_req_state.num_tokens
  1144. num_tokens_after_padding = max(num_tokens, batch_desc.num_tokens)
  1145. assert num_tokens > 0
  1146. is_padding = self.input_buffers.is_padding[:num_tokens_after_padding]
  1147. if envs.VLLM_MOE_SKIP_PADDING:
  1148. is_padding[:num_tokens].fill_(False)
  1149. is_padding[num_tokens:].fill_(True)
  1150. req_ids = batch_req_state.req_ids
  1151. num_scheduled_tokens_np = batch_req_state.num_scheduled_tokens
  1152. idx_mapping_np = batch_req_state.idx_mapping_np
  1153. idx_mapping = async_tensor_h2d(
  1154. idx_mapping_np, device=self.device, dtype=torch.int32
  1155. )
  1156. num_reqs = len(req_ids)
  1157. # Get the number of draft tokens for each request.
  1158. draft_tokens = scheduler_output.scheduled_spec_decode_tokens
  1159. num_draft_tokens_per_req = None
  1160. if not draft_tokens and self.model_state.num_new_sampled_tokens_per_step == 1:
  1161. # No draft token scheduled (common case).
  1162. total_num_draft_tokens = 0
  1163. total_num_logits = num_reqs
  1164. cu_num_logits_np = np.arange(num_reqs + 1, dtype=np.int32)
  1165. cu_num_logits = torch.arange(
  1166. num_reqs + 1, device=self.device, dtype=torch.int32
  1167. )
  1168. expanded_idx_mapping = idx_mapping
  1169. expanded_local_pos = torch.zeros(
  1170. num_reqs, dtype=torch.int32, device=self.device
  1171. )
  1172. else:
  1173. num_draft_tokens_per_req = np.fromiter(
  1174. (len(draft_tokens.get(req_id, ())) for req_id in req_ids),
  1175. dtype=np.int32,
  1176. count=num_reqs,
  1177. )
  1178. num_bonus_tokens = self.model_state.num_new_sampled_tokens_per_step
  1179. total_num_draft_tokens = int(num_draft_tokens_per_req.sum())
  1180. total_num_logits = num_reqs * num_bonus_tokens + total_num_draft_tokens
  1181. num_logits = num_draft_tokens_per_req + num_bonus_tokens
  1182. # combine_sampled_and_draft_tokens places a request's logits rows
  1183. # at [query_end - num_logits, query_end). Fewer query rows than
  1184. # that would silently select the preceding request's hidden states.
  1185. assert (num_scheduled_tokens_np >= num_logits).all()
  1186. cu_num_logits_np = np.empty(num_reqs + 1, dtype=np.int32)
  1187. cu_num_logits_np[0] = 0
  1188. np.cumsum(num_logits, out=cu_num_logits_np[1:])
  1189. cu_num_logits = async_tensor_h2d(cu_num_logits_np, device=self.device)
  1190. # The general branch also serves a no-draft batch with k != 1, and
  1191. # compact_batch's budget is only primed when drafts are scheduled.
  1192. adaptive_verification = self.adaptive_verification if draft_tokens else None
  1193. num_scheduled_tokens_upper_bound = num_scheduled_tokens_np
  1194. if adaptive_verification is not None:
  1195. # num_scheduled_tokens represents the draft budget evenly distributed across
  1196. # all verification requests, `reallocate_drafts` will unevenly assign the
  1197. # draft budget to requests on the GPU side only.
  1198. num_scheduled_tokens_np, cu_num_logits_np = (
  1199. adaptive_verification.compact_batch(
  1200. num_draft_tokens_per_req,
  1201. num_scheduled_tokens_np,
  1202. cu_num_logits_np,
  1203. )
  1204. )
  1205. # Get query_start_loc.
  1206. # num_reqs_padded is None for PIECEWISE graphs (no request padding needed)
  1207. num_reqs_padded = batch_desc.num_reqs or num_reqs
  1208. query_start_loc_np = np.empty(self.max_num_reqs + 1, dtype=np.int32)
  1209. query_start_loc_np[0] = 0
  1210. np.cumsum(num_scheduled_tokens_np, out=query_start_loc_np[1 : num_reqs + 1])
  1211. # Pad for full CUDA graph mode.
  1212. # Some attention backends like FA3 require query_start_loc to be non-decreasing.
  1213. query_start_loc_np[num_reqs + 1 :] = num_tokens
  1214. query_start_loc = self.input_buffers.query_start_loc
  1215. async_tensor_h2d(query_start_loc_np, out=query_start_loc)
  1216. if adaptive_verification is not None:
  1217. cu_num_logits, query_start_loc, total_num_draft_tokens = (
  1218. adaptive_verification.reallocate_drafts(req_ids, idx_mapping)
  1219. )
  1220. total_num_logits = num_reqs * num_bonus_tokens + total_num_draft_tokens
  1221. if num_draft_tokens_per_req is not None:
  1222. expanded_idx_mapping, expanded_local_pos = expand_idx_mapping(
  1223. idx_mapping, total_num_logits, cu_num_logits, self.decode_query_len
  1224. )
  1225. query_start_loc_np = query_start_loc_np[: num_reqs_padded + 1]
  1226. query_start_loc = query_start_loc[: num_reqs_padded + 1]
  1227. # Get prefill tokens if any.
  1228. if batch_req_state.has_prefill:
  1229. prepare_prefill_inputs(
  1230. self.input_buffers.input_ids,
  1231. self.req_states.next_prefill_tokens,
  1232. idx_mapping,
  1233. query_start_loc,
  1234. self.req_states.all_token_ids.gpu,
  1235. self.req_states.prefill_len.gpu,
  1236. self.req_states.num_computed_tokens.gpu,
  1237. )
  1238. # Prepare positions and seq_lens.
  1239. prepare_pos_seq_lens(
  1240. idx_mapping,
  1241. query_start_loc,
  1242. self.req_states.num_computed_tokens.gpu,
  1243. self.input_buffers.positions,
  1244. self.input_buffers.seq_lens,
  1245. )
  1246. seq_lens = self.input_buffers.seq_lens[:num_reqs_padded]
  1247. # Some input token ids are directly read from the last sampled tokens
  1248. # and draft tokens. Also, get the logits indices to sample tokens from.
  1249. logits_indices = combine_sampled_and_draft_tokens(
  1250. self.input_buffers.input_ids,
  1251. idx_mapping,
  1252. self.req_states.last_sampled_tokens,
  1253. query_start_loc,
  1254. seq_lens,
  1255. self.req_states.prefill_len.gpu,
  1256. self.req_states.draft_tokens,
  1257. cu_num_logits,
  1258. total_num_logits,
  1259. self.model_state.num_new_sampled_tokens_per_step,
  1260. )
  1261. if draft_trunc.ENABLED and envs.VLLM_MOE_SKIP_PADDING:
  1262. est = getattr(self.speculator, "acceptance_estimator", None)
  1263. draft_trunc.mark_dead(is_padding, query_start_loc, cu_num_logits, num_reqs,
  1264. self.req_states.draft_tokens.shape[-1],
  1265. est.predictions if est is not None else None, idx_mapping)
  1266. fast_prefill = None
  1267. if self.fast_prefill is not None:
  1268. fast_prefill = self.fast_prefill.prepare(
  1269. logits_indices,
  1270. num_reqs,
  1271. cu_num_logits_np,
  1272. batch_req_state.has_prefill,
  1273. batch_desc,
  1274. num_active_loras=num_active_loras,
  1275. )
  1276. # CPU upper bound on seq_lens; padded entries left at zero.
  1277. num_computed_tokens_np = self.req_states.num_computed_tokens_np[idx_mapping_np]
  1278. seq_lens_cpu_upper_bound_np = np.zeros(num_reqs_padded, dtype=np.int32)
  1279. np.add(
  1280. num_computed_tokens_np,
  1281. num_scheduled_tokens_upper_bound,
  1282. out=seq_lens_cpu_upper_bound_np[:num_reqs],
  1283. )
  1284. seq_lens_cpu_upper_bound = torch.from_numpy(seq_lens_cpu_upper_bound_np)
  1285. prompt_lens = None
  1286. if self.model_config.rswa_window is not None:
  1287. # prompt_lens is only used in R-SWA case.
  1288. prompt_lens = self.req_states.prompt_len.gpu[idx_mapping]
  1289. input_batch = InputBatch(
  1290. req_ids=req_ids,
  1291. num_reqs=num_reqs,
  1292. num_reqs_after_padding=num_reqs_padded,
  1293. idx_mapping=idx_mapping,
  1294. idx_mapping_np=idx_mapping_np,
  1295. expanded_idx_mapping=expanded_idx_mapping,
  1296. expanded_local_pos=expanded_local_pos,
  1297. num_scheduled_tokens=num_scheduled_tokens_upper_bound,
  1298. num_tokens=num_tokens,
  1299. num_tokens_after_padding=num_tokens_after_padding,
  1300. num_draft_tokens=total_num_draft_tokens,
  1301. num_draft_tokens_per_req=num_draft_tokens_per_req,
  1302. query_start_loc=query_start_loc,
  1303. query_start_loc_np=query_start_loc_np,
  1304. seq_lens=seq_lens,
  1305. seq_lens_cpu_upper_bound=seq_lens_cpu_upper_bound,
  1306. dcp_local_seq_lens=None,
  1307. num_computed_tokens_np=num_computed_tokens_np,
  1308. prefill_len_np=batch_req_state.prefill_len_np,
  1309. num_computed_prefill_tokens_np=batch_req_state.num_computed_prefill_tokens_np,
  1310. is_prefilling_np=batch_req_state.is_prefilling_np,
  1311. has_prefill=batch_req_state.has_prefill,
  1312. input_ids=self.input_buffers.input_ids[:num_tokens_after_padding],
  1313. positions=self.input_buffers.positions[:num_tokens_after_padding],
  1314. is_padding=is_padding,
  1315. logits_indices=logits_indices,
  1316. cu_num_logits=cu_num_logits,
  1317. cu_num_logits_np=cu_num_logits_np,
  1318. has_structured_output_reqs=scheduler_output.has_structured_output_requests,
  1319. prompt_lens=prompt_lens,
  1320. fast_prefill=fast_prefill,
  1321. max_query_len=(
  1322. int(num_scheduled_tokens_upper_bound.max())
  1323. if adaptive_verification is not None
  1324. else None
  1325. ),
  1326. )
  1327. if self.pcp_manager is not None:
  1328. input_batch = self.pcp_manager.partition_batch(input_batch, batch_desc)
  1329. return input_batch
  1330. def prepare_attn(
  1331. self, input_batch: InputBatch
  1332. ) -> tuple[tuple[torch.Tensor, ...], torch.Tensor]:
  1333. if self.pcp_manager is not None:
  1334. return self.pcp_manager.prepare_attn(input_batch)
  1335. # Block tables: num_kv_cache_groups x [num_reqs_padded, max_num_blocks].
  1336. block_tables = self.block_tables.gather_block_tables(
  1337. input_batch.idx_mapping, num_reqs_padded=input_batch.num_reqs_after_padding
  1338. )
  1339. # Slot mappings: [num_kv_cache_groups, num_tokens_padded].
  1340. # Kernel pads beyond num_tokens with PAD_SLOT_ID.
  1341. slot_mappings = self.block_tables.compute_slot_mappings(
  1342. input_batch.idx_mapping,
  1343. input_batch.query_start_loc,
  1344. input_batch.positions,
  1345. num_tokens_padded=input_batch.num_tokens_after_padding,
  1346. )
  1347. return block_tables, slot_mappings
  1348. def prepare_dummy_attn(
  1349. self, input_batch: InputBatch, valid_state_slots: bool = False
  1350. ) -> tuple[tuple[torch.Tensor, ...], torch.Tensor]:
  1351. block_table_provider = self.pcp_manager or self.block_tables
  1352. block_tables = block_table_provider.get_dummy_block_tables(input_batch.num_reqs)
  1353. if valid_state_slots:
  1354. state_slots = torch.arange(
  1355. 1, input_batch.num_reqs + 1, dtype=torch.int32, device=self.device
  1356. )
  1357. for block_table in block_tables:
  1358. block_table[:, 0].copy_(state_slots)
  1359. slot_mappings = block_table_provider.get_dummy_slot_mappings(
  1360. input_batch.num_tokens
  1361. )
  1362. return block_tables, slot_mappings
  1363. def sample(
  1364. self,
  1365. hidden_states: torch.Tensor,
  1366. input_batch: InputBatch,
  1367. grammar_output: GrammarOutput | None,
  1368. ) -> tuple[SamplerOutput, torch.Tensor, torch.Tensor]:
  1369. shard_metadata = None
  1370. global_input_batch = input_batch
  1371. if self.batch_sharder is not None:
  1372. # Shard the inputs along the batch dimension to sample in parallel
  1373. # across TP ranks.
  1374. input_batch, sorted_logits_indices, grammar_output, shard_metadata = (
  1375. self.batch_sharder.shard_sampler_inputs(input_batch, grammar_output)
  1376. )
  1377. # The hidden states must be gathered in rank-owner-sorted order
  1378. # before computing the partial-vocab logits, so that the all-to-all
  1379. # produces full-vocab logits for just the locally-owned requests.
  1380. sample_hidden_states = hidden_states[sorted_logits_indices]
  1381. local_logits = self.model.compute_logits_local(sample_hidden_states)
  1382. logits = all_to_all_logits(local_logits, shard_metadata)
  1383. logits = logits[:, : self.vocab_size]
  1384. else:
  1385. sample_hidden_states = hidden_states[input_batch.logits_indices]
  1386. logits = self.model.compute_logits(sample_hidden_states)
  1387. # A diffusion prefill has no logit rows even when a bitmask row
  1388. # arrived for it.
  1389. if grammar_output is not None and logits.shape[0] > 0:
  1390. # Apply grammar bitmask to the logits in-place.
  1391. assert self.structured_outputs_worker is not None
  1392. self.structured_outputs_worker.apply_grammar_bitmask(
  1393. logits,
  1394. input_batch,
  1395. grammar_output.structured_output_request_ids,
  1396. grammar_output.grammar_bitmask,
  1397. )
  1398. sampler_output: SamplerOutput | None
  1399. if input_batch.num_reqs == 0:
  1400. # This rank owns no requests this step. It contributes an
  1401. # all-padding block to the gather below.
  1402. sampler_output = None
  1403. elif input_batch.num_draft_tokens == 0 or self.rejection_sampler is None:
  1404. assert self.sampler is not None
  1405. sampler_output = self.sampler(logits, input_batch)
  1406. else:
  1407. # Rejection sampling for spec decoding.
  1408. assert self.rejection_sampler is not None
  1409. assert self.speculator is not None
  1410. sampler_output = self.rejection_sampler(
  1411. logits,
  1412. input_batch,
  1413. # Draft logits are needed for probabilistic rejection sampling.
  1414. self.speculator.draft_logits,
  1415. )
  1416. if shard_metadata is not None:
  1417. # Gather the sharded sampler outputs from the TP ranks into a single
  1418. # sampler output.
  1419. assert self.sampler is not None
  1420. sampler_output = gather_sampler_output(
  1421. sampler_output,
  1422. shard_metadata,
  1423. device=self.device,
  1424. global_batch=global_input_batch,
  1425. local_batch=input_batch,
  1426. gather_num_nans=self.sampler.compute_nans,
  1427. logprobs_dims=self.sampler.get_logprobs_dims(
  1428. global_input_batch.idx_mapping_np,
  1429. # Rejection sampler does not return logprob token ids.
  1430. include_token_ids=(
  1431. global_input_batch.num_draft_tokens == 0
  1432. or self.rejection_sampler is None
  1433. ),
  1434. ),
  1435. )
  1436. assert sampler_output is not None
  1437. return sampler_output, sampler_output.num_sampled, sampler_output.num_rejected
  1438. def postprocess_sampled(
  1439. self,
  1440. idx_mapping: torch.Tensor, # May include -1 for masked entries
  1441. sampled_tokens: torch.Tensor,
  1442. num_sampled: torch.Tensor,
  1443. num_rejected: torch.Tensor,
  1444. query_start_loc: torch.Tensor | None = None,
  1445. ) -> None:
  1446. # Update the number of computed tokens.
  1447. output_bin_counts = None
  1448. if self.is_last_pp_rank:
  1449. assert self.sampler is not None
  1450. output_bin_counts = self.sampler.penalties_state.output_bin_counts
  1451. post_update(
  1452. idx_mapping,
  1453. self.req_states.num_computed_tokens.gpu,
  1454. self.req_states.last_sampled_tokens,
  1455. output_bin_counts,
  1456. sampled_tokens,
  1457. num_sampled,
  1458. num_rejected,
  1459. query_start_loc,
  1460. self.req_states.all_token_ids.gpu,
  1461. self.req_states.total_len.gpu,
  1462. )
  1463. self.model_state.postprocess_state(
  1464. idx_mapping, num_sampled, self.req_states.num_computed_tokens.gpu
  1465. )
  1466. def _merge_ec_connector_no_forward(
  1467. self, scheduler_output: SchedulerOutput, output: ModelRunnerOutput
  1468. ) -> ModelRunnerOutput:
  1469. """Let the EC connector send/recv on a step with no work to run."""
  1470. return ModelRunnerOutput.with_ec_conn_output(
  1471. output,
  1472. self.ec_connector.no_forward(scheduler_output).ec_connector_output,
  1473. )
  1474. @torch.inference_mode()
  1475. def execute_model(
  1476. self,
  1477. scheduler_output: SchedulerOutput,
  1478. intermediate_tensors: IntermediateTensors | None = None,
  1479. dummy_run: bool = False,
  1480. skip_attn_for_dummy_run: bool = False,
  1481. is_profile: bool = False,
  1482. context_len: int = 0,
  1483. valid_dummy_state_slots: bool = False,
  1484. ) -> ModelRunnerOutput | IntermediateTensors | None:
  1485. if not dummy_run:
  1486. # Update the request states.
  1487. self.update_pp_decode_requests()
  1488. self.finish_requests(scheduler_output)
  1489. self.free_states(scheduler_output)
  1490. self.add_requests(scheduler_output)
  1491. self.update_requests(scheduler_output)
  1492. self.block_tables.apply_staged_writes()
  1493. if self.aux_output_connector is not None:
  1494. # Register this step before the GPU forward.
  1495. self.aux_output_connector.begin_step(
  1496. scheduler_output.aux_output_connector_metadata
  1497. )
  1498. if scheduler_output.total_num_scheduled_tokens == 0:
  1499. # No need to run the model.
  1500. empty_output = self.kv_connector.no_forward(scheduler_output)
  1501. return self._merge_ec_connector_no_forward(
  1502. scheduler_output, empty_output
  1503. )
  1504. # Get batch descriptor and sync across DP ranks.
  1505. num_reqs = len(scheduler_output.num_scheduled_tokens)
  1506. num_toks = scheduler_output.total_num_scheduled_tokens
  1507. max_query_len = max(scheduler_output.num_scheduled_tokens.values())
  1508. batch_req_state, uniform_tok_count = self.gather_batch_req_state(
  1509. scheduler_output, dummy_run
  1510. )
  1511. if batch_req_state is not None:
  1512. num_toks = batch_req_state.num_tokens
  1513. if self.pcp_manager is not None:
  1514. num_toks = self.pcp_manager.get_num_tokens_for_dispatch(
  1515. batch_req_state.num_scheduled_tokens,
  1516. batch_req_state.is_prefilling_np,
  1517. )
  1518. num_active_loras = 0
  1519. if self.lora_config:
  1520. req_ids = list(scheduler_output.num_scheduled_tokens.keys())
  1521. num_active_loras = get_num_active_loras_for_dispatch(
  1522. self.lora_config, self.lora_state, req_ids, dummy_run
  1523. )
  1524. skip_compiled = False
  1525. if self.is_encoder_decoder and scheduler_output.scheduled_encoder_inputs:
  1526. # Encoder-decoder models such as Whisper should run eager/non-compiled
  1527. # when encoder inputs are scheduled, because this step updates
  1528. # cross-attention cache with dynamic encoder outputs.
  1529. skip_compiled = True
  1530. batch_desc, dp_sync = dispatch_cg_and_sync_dp(
  1531. self.cudagraph_manager,
  1532. num_reqs,
  1533. num_toks,
  1534. uniform_tok_count,
  1535. self.dp_size,
  1536. self.dp_rank,
  1537. max_query_len=max_query_len,
  1538. need_eager=is_profile or skip_compiled,
  1539. num_active_loras=num_active_loras,
  1540. parallel_config=self.parallel_config,
  1541. allow_ubatching=(
  1542. self.ubatch_runner is not None and not skip_attn_for_dummy_run
  1543. ),
  1544. uniform_decode=uniform_tok_count == self.decode_query_len,
  1545. )
  1546. if batch_desc.num_tokens == 0:
  1547. # All DP ranks have zero tokens to run.
  1548. empty_output = self.kv_connector.no_forward(scheduler_output)
  1549. return self._merge_ec_connector_no_forward(scheduler_output, empty_output)
  1550. cudagraph_stats = None
  1551. if not dummy_run:
  1552. # Common case.
  1553. # Prepare all the inputs and copy to the input buffers.
  1554. if self.observability_config.cudagraph_metrics:
  1555. cudagraph_stats = make_cudagraph_stats(batch_desc, num_toks)
  1556. assert batch_req_state is not None
  1557. input_batch = self.prepare_inputs(
  1558. scheduler_output, batch_req_state, batch_desc, num_active_loras
  1559. )
  1560. block_tables, slot_mappings = self.prepare_attn(input_batch)
  1561. # Mamba "align" pre-copy: migrate recurrent state across block
  1562. # boundaries before the forward. Runs only on real batches, and
  1563. # before model_state.prepare_attn gathers num_accepted_tokens so the
  1564. # boundary reset is visible to the attention metadata.
  1565. self.model_state.preprocess_state(
  1566. input_batch,
  1567. block_tables,
  1568. self.kv_cache_config,
  1569. self.req_states.num_computed_tokens.gpu,
  1570. )
  1571. if self.lora_config:
  1572. # Activate LoRA adapters.
  1573. lora_inputs = self.lora_state.make_lora_inputs(
  1574. input_batch.req_ids,
  1575. input_batch.idx_mapping_np,
  1576. input_batch.num_scheduled_tokens,
  1577. )
  1578. self._set_active_loras(*lora_inputs)
  1579. else:
  1580. # No actual tokens to run. A dummy run for DP or memory profiling.
  1581. dummy_num_reqs = batch_desc.num_reqs or num_reqs
  1582. input_batch = InputBatch.make_dummy(
  1583. dummy_num_reqs,
  1584. batch_desc.num_tokens,
  1585. self.input_buffers,
  1586. max_query_len=batch_desc.max_query_len,
  1587. # Profiling and warmup must route the dummy tokens to experts
  1588. # so MoE memory is measured and MoE kernels are exercised.
  1589. is_padding=not is_profile,
  1590. )
  1591. if self.pcp_manager is not None:
  1592. input_batch = self.pcp_manager.prepare_inputs_to_capture(input_batch)
  1593. if skip_attn_for_dummy_run:
  1594. assert batch_desc.cg_mode != CUDAGraphMode.FULL, (
  1595. "Attention metadata must be prepared for dummy runs when using "
  1596. "FULL cudagraph mode."
  1597. )
  1598. block_tables, slot_mappings = None, None
  1599. else:
  1600. block_tables, slot_mappings = self.prepare_dummy_attn(
  1601. input_batch, valid_dummy_state_slots
  1602. )
  1603. if context_len:
  1604. set_dummy_context(
  1605. input_batch,
  1606. self.block_tables,
  1607. context_len,
  1608. self.kv_cache_config.num_blocks,
  1609. self.max_model_len,
  1610. input_block_tables=block_tables,
  1611. )
  1612. if self.dcp_size > 1 and not (dummy_run and skip_attn_for_dummy_run):
  1613. input_buffers = self.input_buffers
  1614. if self.pcp_manager is not None:
  1615. input_buffers = self.pcp_manager.input_buffers
  1616. input_batch.dcp_local_seq_lens = prepare_dcp_local_seq_lens(
  1617. input_buffers.dcp_local_seq_lens,
  1618. input_batch.seq_lens,
  1619. input_batch.num_reqs,
  1620. self.dcp_size,
  1621. self.dcp_rank,
  1622. self.cp_interleave,
  1623. num_reqs_padded=input_batch.num_reqs_after_padding,
  1624. )
  1625. attn_metadata = None
  1626. slot_mappings_by_layer = None
  1627. ubatch_state: UBatchState | None = None
  1628. if batch_desc.num_ubatches > 1:
  1629. assert self.ubatch_runner is not None
  1630. assert block_tables is not None and slot_mappings is not None
  1631. ubatch_state = self.ubatch_runner.prepare(
  1632. input_batch,
  1633. block_tables,
  1634. slot_mappings,
  1635. cg_mode=batch_desc.cg_mode,
  1636. for_capture=dummy_run and batch_desc.cg_mode == CUDAGraphMode.FULL,
  1637. )
  1638. elif not (dummy_run and skip_attn_for_dummy_run):
  1639. assert slot_mappings is not None
  1640. slot_mappings_by_layer = build_slot_mappings_by_layer(
  1641. slot_mappings, self.kv_cache_config
  1642. )
  1643. assert block_tables is not None
  1644. attn_groups = self.attn_groups
  1645. if dummy_run and is_profile:
  1646. # Mamba layers take a cheap warmup path with no metadata;
  1647. # attention metadata is still built so those kernels tune.
  1648. attn_groups = [
  1649. [g for g in groups if not isinstance(g.kv_cache_spec, MambaSpec)]
  1650. for groups in attn_groups
  1651. ]
  1652. attn_metadata = self.model_state.prepare_attn(
  1653. input_batch,
  1654. batch_desc.cg_mode,
  1655. block_tables,
  1656. slot_mappings,
  1657. attn_groups,
  1658. self.kv_cache_config,
  1659. # FULL replay reads capture-time metadata buffers. Re-stage them
  1660. # from the zeroed dummy block tables instead of retaining state
  1661. # indices from the previous real batch.
  1662. for_capture=dummy_run and batch_desc.cg_mode == CUDAGraphMode.FULL,
  1663. )
  1664. input_ids = input_batch.input_ids
  1665. inputs_embeds = None
  1666. ec_connector_output = None
  1667. if self.uses_inputs_embeds and self.is_first_pp_rank:
  1668. # Prepare inputs_embeds (MM encoder outputs and/or prompt_embeds
  1669. # overlay). Only first PP rank prepares them.
  1670. if dummy_run:
  1671. # Obtain embeddings of correct shape for compiled model.
  1672. inputs_embeds = self.model_state.dummy_inputs_embeds(
  1673. input_batch.num_tokens_after_padding
  1674. )
  1675. else:
  1676. scheduled_encoder_inputs = scheduler_output.scheduled_encoder_inputs
  1677. if self.supports_mm_inputs and self.lora_config is not None:
  1678. set_active_mm_loras(
  1679. model=self.model,
  1680. lora_manager=self.lora_manager,
  1681. encoder_cache=self.encoder_cache,
  1682. req_id_to_index=self.req_states.req_id_to_index,
  1683. lora_state=self.lora_state,
  1684. scheduled_encoder_inputs=scheduled_encoder_inputs,
  1685. )
  1686. with self.ec_connector.maybe_get_output(
  1687. scheduler_output
  1688. ) as ec_connector_output:
  1689. inputs_embeds = self.model_state.prepare_inputs_embeds(
  1690. scheduled_encoder_inputs, input_batch, self.req_states
  1691. )
  1692. if inputs_embeds is not None and not requires_raw_input_tokens(self.model):
  1693. input_ids = None
  1694. model_inputs = {
  1695. "input_ids": input_ids,
  1696. "positions": input_batch.positions,
  1697. "inputs_embeds": inputs_embeds,
  1698. "intermediate_tensors": None,
  1699. # NOTE: Values returned by `prepare_inputs` will override the default
  1700. # values above.
  1701. **self.model_state.prepare_inputs(input_batch, self.req_states),
  1702. }
  1703. if not self.is_first_pp_rank:
  1704. # Update for non-first PP ranks.
  1705. model_inputs["input_ids"] = None
  1706. model_inputs["inputs_embeds"] = None
  1707. # Prepare the intermediate tensors.
  1708. assert intermediate_tensors is not None
  1709. assert self.intermediate_tensors is not None
  1710. n = input_batch.num_tokens_after_padding
  1711. new_tensors = {
  1712. k: v[:n]
  1713. if dummy_run
  1714. else v[:n].copy_(intermediate_tensors.tensors[k][:n])
  1715. for k, v in self.intermediate_tensors.tensors.items()
  1716. }
  1717. model_inputs["intermediate_tensors"] = IntermediateTensors(new_tensors)
  1718. del intermediate_tensors
  1719. # Update the EPLB meta.
  1720. ubatch_slices = ubatch_state.slices if ubatch_state is not None else None
  1721. self.eplb.prepare_forward(
  1722. self.model_config, input_batch.num_tokens, ubatch_slices
  1723. )
  1724. self.step_timing.record_batch(
  1725. input_batch, batch_desc.cg_mode == CUDAGraphMode.FULL
  1726. )
  1727. self.step_timing.forward_start()
  1728. connector_kwargs = dict(
  1729. scheduler_output=scheduler_output,
  1730. request_state_indices=input_batch.idx_mapping,
  1731. request_ids=input_batch.req_ids,
  1732. num_tokens=input_batch.num_tokens,
  1733. )
  1734. # Run model.
  1735. if batch_desc.cg_mode == CUDAGraphMode.FULL:
  1736. # Use explicit cudagraph replay for FULL mode.
  1737. # NOTE(woosuk): Here, we don't need to pass the input tensors,
  1738. # because they are already copied to the CUDA graph input buffers.
  1739. assert self.cudagraph_manager is not None
  1740. self.kv_connector.pre_forward(
  1741. **connector_kwargs, attn_metadata=attn_metadata
  1742. )
  1743. model_output = self.cudagraph_manager.run_fullgraph(batch_desc)
  1744. else:
  1745. # For piecewise and eager mode, just call model().
  1746. batch_descriptor = BatchDescriptor(
  1747. num_tokens=input_batch.num_tokens_after_padding,
  1748. has_lora=self.lora_config is not None,
  1749. num_active_loras=batch_desc.num_active_loras,
  1750. )
  1751. with set_forward_context(
  1752. attn_metadata,
  1753. self.vllm_config,
  1754. num_tokens=input_batch.num_tokens_after_padding,
  1755. cudagraph_runtime_mode=batch_desc.cg_mode,
  1756. num_tokens_across_dp=(
  1757. dp_sync.num_tokens_across_dp if dp_sync is not None else None
  1758. ),
  1759. batch_descriptor=batch_descriptor,
  1760. ubatch_slices=ubatch_slices,
  1761. slot_mapping=slot_mappings_by_layer,
  1762. skip_compiled=skip_compiled,
  1763. is_padding=input_batch.is_padding,
  1764. ):
  1765. self.kv_connector.pre_forward(**connector_kwargs)
  1766. if ubatch_state is not None:
  1767. assert self.ubatch_runner is not None
  1768. model_output = self.ubatch_runner.run(
  1769. self.model, model_inputs, ubatch_state
  1770. )
  1771. elif batch_desc.cg_mode == CUDAGraphMode.PIECEWISE:
  1772. # Run the PIECEWISE graph (compiled PW cudagraph or breakable
  1773. # cudagraph, chosen inside run_pw_graph). cg_mode is only
  1774. # PIECEWISE after the cudagraph manager exists.
  1775. assert self.cudagraph_manager is not None
  1776. model_output = self.cudagraph_manager.run_pw_graph(
  1777. self.model, model_inputs
  1778. )
  1779. else:
  1780. # Eager (NONE): call the raw model directly.
  1781. model_output = self.model(**model_inputs)
  1782. self.kv_connector.finish_forward()
  1783. if self.is_last_pp_rank:
  1784. if self.use_aux_hidden_state_outputs:
  1785. assert isinstance(model_output, tuple)
  1786. hidden_states, aux_hidden_states = model_output
  1787. else:
  1788. assert isinstance(model_output, torch.Tensor)
  1789. hidden_states = model_output
  1790. aux_hidden_states = None
  1791. output_intermediate_tensors = None
  1792. else:
  1793. assert isinstance(model_output, IntermediateTensors)
  1794. hidden_states = None
  1795. aux_hidden_states = None
  1796. output_intermediate_tensors = model_output
  1797. finished_req_ids = scheduler_output.finished_req_ids
  1798. self.execute_model_state = ExecuteModelState(
  1799. input_batch=input_batch,
  1800. attn_metadata=attn_metadata,
  1801. slot_mappings_by_layer=slot_mappings_by_layer,
  1802. hidden_states=hidden_states,
  1803. aux_hidden_states=aux_hidden_states,
  1804. dp_sync=dp_sync,
  1805. finished_req_ids=finished_req_ids,
  1806. ec_connector_output=ec_connector_output,
  1807. cudagraph_stats=cudagraph_stats,
  1808. )
  1809. if not self.is_last_pp_rank:
  1810. # Non-last PP rank: return IntermediateTensors for sending.
  1811. assert output_intermediate_tensors is not None
  1812. assert self.pp_handler is not None
  1813. return self.pp_handler.relay_aux_hidden_states(
  1814. model_inputs["intermediate_tensors"], output_intermediate_tensors
  1815. )
  1816. return None
  1817. @torch.inference_mode()
  1818. @step_eplb_after()
  1819. def sample_tokens(
  1820. self, grammar_output: GrammarOutput | None
  1821. ) -> AsyncOutput | ModelRunnerOutput | None:
  1822. if self.execute_model_state is None:
  1823. # The prior execute_model call must have failed.
  1824. return None
  1825. input_batch = self.execute_model_state.input_batch
  1826. attn_metadata = self.execute_model_state.attn_metadata
  1827. slot_mappings_by_layer = self.execute_model_state.slot_mappings_by_layer
  1828. hidden_states = self.execute_model_state.hidden_states
  1829. aux_hidden_states = self.execute_model_state.aux_hidden_states
  1830. dp_sync = self.execute_model_state.dp_sync
  1831. finished_req_ids = self.execute_model_state.finished_req_ids
  1832. ec_connector_output = self.execute_model_state.ec_connector_output
  1833. cudagraph_stats = self.execute_model_state.cudagraph_stats
  1834. self.execute_model_state = None
  1835. if not self.is_last_pp_rank:
  1836. # Non-last PP rank: hidden_states is None because this rank produced
  1837. # IntermediateTensors instead of final hidden states. Receive the
  1838. # sampled tokens broadcast from the last rank and update local state.
  1839. assert self.pp_handler is not None
  1840. all_decode_next = self.pp_handler.receive(input_batch)
  1841. # Optimistically update num_computed_tokens for entire batch here.
  1842. # Will be adjusted for rejections if necessary in update_requests.
  1843. self.postprocess_num_computed_tokens(input_batch)
  1844. if not all_decode_next:
  1845. # Might contain non-final prefill chunks, which will be scheduled
  1846. # in the immediate next step (rather than in pp_size steps).
  1847. self.model_state.postprocess_state(input_batch.idx_mapping, 0)
  1848. # Post-step KV connector related operations.
  1849. kv_connector_output = self.kv_connector.post_forward(finished_req_ids)
  1850. # The first PP rank holds the encoder cache, so pass its EC output on.
  1851. output = ModelRunnerOutput.with_kv_conn_output_only(kv_connector_output)
  1852. return ModelRunnerOutput.with_ec_conn_output(output, ec_connector_output)
  1853. # Last rank: sample tokens
  1854. assert hidden_states is not None
  1855. draft_hidden_states = hidden_states
  1856. if self.pcp_manager is not None:
  1857. hidden_states, aux_hidden_states, input_batch = (
  1858. self.pcp_manager.restore_for_sampling(hidden_states, aux_hidden_states)
  1859. )
  1860. sampler_output, num_sampled, num_rejected = self.sample(
  1861. hidden_states, input_batch, grammar_output
  1862. )
  1863. if self.pp_handler is not None:
  1864. # Broadcast to non-last PP ranks (handles spec decode multi-token).
  1865. self.pp_handler.broadcast(
  1866. sampler_output.sampled_token_ids,
  1867. num_sampled,
  1868. num_rejected,
  1869. input_batch,
  1870. )
  1871. assert self.prompt_logprobs_worker is not None
  1872. prompt_logprobs_dict = self.prompt_logprobs_worker.compute_prompt_logprobs(
  1873. self.model.compute_logits,
  1874. hidden_states,
  1875. input_batch,
  1876. self.req_states.all_token_ids.gpu,
  1877. self.req_states.num_computed_tokens.gpu,
  1878. self.req_states.prompt_len.np,
  1879. )
  1880. # Prepare the model runner output.
  1881. model_runner_output = ModelRunnerOutput(
  1882. req_ids=input_batch.req_ids,
  1883. # NOTE(woosuk): req_id_to_index is unused in this model runner.
  1884. # Only for compatibility with the existing model runner and scheduler.
  1885. req_id_to_index={req_id: i for i, req_id in enumerate(input_batch.req_ids)},
  1886. sampled_token_ids=None, # type: ignore
  1887. prompt_logprobs_dict=prompt_logprobs_dict, # type: ignore[arg-type]
  1888. cudagraph_stats=cudagraph_stats,
  1889. )
  1890. pending_aux_output = None
  1891. if self.aux_output_connector is not None:
  1892. pending_aux_output = self.aux_output_connector.prepare_output(input_batch)
  1893. # Start async output copy here so that it can overlap with speculator proposal.
  1894. async_output = AsyncOutput(
  1895. model_runner_output=model_runner_output,
  1896. sampler_output=sampler_output,
  1897. num_sampled_tokens=num_sampled,
  1898. main_stream=self.main_stream,
  1899. copy_stream=self.output_copy_stream,
  1900. check_ep_fault=self.check_ep_fault,
  1901. pending_aux_output=pending_aux_output,
  1902. )
  1903. mm_inputs: tuple[list[torch.Tensor], torch.Tensor] | None = None
  1904. # The encoder runner exists only on the first PP rank, so later ranks
  1905. # have no cached embeddings to gather.
  1906. if (
  1907. self.speculator is not None
  1908. and self.speculator.supports_mm_inputs
  1909. and self.model_state.supports_mm_inputs
  1910. ):
  1911. # Get cached multimodal embeddings for draft forward.
  1912. # NOTE: This is done here because postprocess updates
  1913. # num_computed_prefill_tokens.
  1914. # The EAGLE/MTP drafter reads one position ahead of the target.
  1915. # TODO(TheEpicDolphin): Gather MM embeddings for all speculative
  1916. # steps during multi-module MTP.
  1917. mm_inputs = self.model_state.gather_mm_embeddings(
  1918. input_batch, draft_lookahead=1
  1919. )
  1920. # Postprocess results and update request states.
  1921. # NOTE: This is intentionally done after creating the AsyncOutput,
  1922. # ensuring that `copy_event` is recorded before calling postprocess.
  1923. # This sequencing may slightly reduce latency as async D2H copy does not
  1924. # need to wait for the postprocess to finish.
  1925. self.postprocess_sampled(
  1926. input_batch.idx_mapping,
  1927. sampler_output.sampled_token_ids,
  1928. num_sampled,
  1929. num_rejected,
  1930. input_batch.query_start_loc,
  1931. )
  1932. if self.speculator is not None:
  1933. assert self.sampler is not None
  1934. if isinstance(self.speculator, DraftModelSpeculator) and draft_trunc.graded():
  1935. self.speculator.observe_verification(
  1936. input_batch.idx_mapping, num_sampled, num_rejected
  1937. )
  1938. if draft_trunc.LOG:
  1939. draft_trunc.log_step(
  1940. self.speculator.draft_token_confidence_probs[input_batch.idx_mapping],
  1941. input_batch.cu_num_logits, num_sampled,
  1942. getattr(self.speculator, "acceptance_estimator", None), input_batch.idx_mapping,
  1943. )
  1944. # Let the target override the hidden state fed to the drafter
  1945. # (e.g. DeepSeek V4 MTP needs the pre-hc_head residual). The
  1946. # target returns a persistent buffer sized at max_num_batched_tokens;
  1947. # slice to the active token count that propose() expects.
  1948. spec_hidden_states = draft_hidden_states
  1949. if hasattr(self.model, "get_mtp_target_hidden_states"):
  1950. pre_hc_hidden_states = self.model.get_mtp_target_hidden_states()
  1951. spec_hidden_states = pre_hc_hidden_states[: draft_hidden_states.size(0)]
  1952. if isinstance(self.sampler, GPUWatermarkSampler):
  1953. self.speculator.prepare_watermarking(
  1954. self.sampler._get_contexts(input_batch.idx_mapping),
  1955. self.sampler.watermarking.gpu[input_batch.idx_mapping],
  1956. )
  1957. with use_workspace_lane(self._draft_workspace_lane):
  1958. draft_tokens = self.speculator.propose(
  1959. input_batch,
  1960. attn_metadata,
  1961. slot_mappings_by_layer,
  1962. spec_hidden_states,
  1963. aux_hidden_states,
  1964. num_sampled,
  1965. num_rejected,
  1966. self.req_states.last_sampled_tokens,
  1967. self.req_states.next_prefill_tokens,
  1968. self.sampler.sampling_states.temperature.gpu,
  1969. self.sampler.sampling_states.seeds.gpu,
  1970. dp_sync=dp_sync,
  1971. mm_inputs=mm_inputs,
  1972. )
  1973. self.req_states.draft_tokens[input_batch.idx_mapping] = draft_tokens
  1974. if self.adaptive_verification is not None:
  1975. self.adaptive_verification.record_confidences(
  1976. self.speculator.draft_token_confidence_probs, input_batch
  1977. )
  1978. if self.num_speculative_steps > 0:
  1979. # Spec-decode and diffusion LLMs both use draft tokens but the latter does
  1980. # not have a speculator (i.e. self.speculator is None)
  1981. self.draft_tokens_handler.set_draft_tokens(
  1982. input_batch,
  1983. self.req_states.draft_tokens[input_batch.idx_mapping],
  1984. )
  1985. if self.pp_handler is not None:
  1986. self.pp_handler.broadcast_drafts(
  1987. self.req_states.draft_tokens, input_batch
  1988. )
  1989. # Post-step KV connector related operations.
  1990. kv_connector_output = self.kv_connector.post_forward(finished_req_ids)
  1991. model_runner_output.kv_connector_output = kv_connector_output
  1992. model_runner_output.ec_connector_output = ec_connector_output
  1993. return async_output
  1994. def take_draft_token_ids(self) -> DraftTokenIds | None:
  1995. return self.draft_tokens_handler.get_draft_tokens()
  1996. @torch.inference_mode()
  1997. @step_eplb_after()
  1998. def pool(self) -> AsyncPoolingOutput | ModelRunnerOutput | None:
  1999. if self.execute_model_state is None:
  2000. # The prior execute_model call must have failed.
  2001. return None
  2002. input_batch = self.execute_model_state.input_batch
  2003. hidden_states = self.execute_model_state.hidden_states
  2004. finished_req_ids = self.execute_model_state.finished_req_ids
  2005. ec_connector_output = self.execute_model_state.ec_connector_output
  2006. self.execute_model_state = None
  2007. # Post-step KV connector related operations.
  2008. kv_connector_output = self.kv_connector.post_forward(finished_req_ids)
  2009. if not self.is_last_pp_rank:
  2010. self.postprocess_num_computed_tokens(input_batch)
  2011. output = ModelRunnerOutput.with_kv_conn_output_only(kv_connector_output)
  2012. return ModelRunnerOutput.with_ec_conn_output(output, ec_connector_output)
  2013. assert self.pooling_runner is not None
  2014. pooler_output, finished_mask = self.pooling_runner.pool(
  2015. hidden_states, input_batch, self.req_states
  2016. )
  2017. # Build the model runner output.
  2018. model_runner_output = ModelRunnerOutput(
  2019. req_ids=input_batch.req_ids,
  2020. req_id_to_index={req_id: i for i, req_id in enumerate(input_batch.req_ids)},
  2021. kv_connector_output=kv_connector_output,
  2022. ec_connector_output=ec_connector_output,
  2023. )
  2024. async_output = AsyncPoolingOutput(
  2025. model_runner_output=model_runner_output,
  2026. pooler_output=pooler_output,
  2027. finished_mask=finished_mask,
  2028. main_stream=self.main_stream,
  2029. copy_stream=self.output_copy_stream,
  2030. )
  2031. self.postprocess_num_computed_tokens(input_batch)
  2032. return async_output
  2033. def postprocess_num_computed_tokens(self, input_batch: InputBatch) -> None:
  2034. # Update the number of computed tokens.
  2035. post_update_num_computed_tokens(
  2036. input_batch.idx_mapping,
  2037. self.req_states.num_computed_tokens.gpu,
  2038. input_batch.query_start_loc,
  2039. )
  2040. def shutdown(self) -> None:
  2041. """Release GPU tensors (model weights, KV caches, workspace) so that
  2042. memory is reclaimable when running in the same process."""
  2043. torch.accelerator.synchronize()
  2044. if self.aux_output_connector is not None:
  2045. self.aux_output_connector.close()
  2046. set_offloader(None)
  2047. self.cudagraph_manager = None
  2048. self.fast_prefill = None
  2049. self.pooling_runner = None
  2050. if hasattr(self, "kv_caches"):
  2051. self.kv_caches.clear()
  2052. if hasattr(self, "attn_groups"):
  2053. self.attn_groups.clear()
  2054. if hasattr(self, "kv_cache_config"):
  2055. del self.kv_cache_config
  2056. if hasattr(self, "model_state") and self.model_state.supports_mm_inputs:
  2057. self.model_state.encoder_runner.clear()
  2058. free_before_shutdown(self.vllm_config)
  2059. if hasattr(self, "model_state"):
  2060. del self.model_state
  2061. # Detach the layer-level KV/state cache tensors before dropping the
  2062. # models; the model objects can outlive this runner.
  2063. speculator = getattr(self, "speculator", None)
  2064. if speculator is not None:
  2065. if draft_model := getattr(speculator, "model", None):
  2066. clear_layer_kv_caches(draft_model.modules())
  2067. self.speculator = None
  2068. if hasattr(self, "model"):
  2069. clear_layer_kv_caches(self.model.modules())
  2070. del self.model
  2071. gc.collect()
  2072. torch.accelerator.empty_cache()
  2073. logger.debug("Cleaned up model weights, KV caches, and workspace")
  2074. ########### EPLB methods start ###########
  2075. @property
  2076. def eplb_state(self):
  2077. return self.eplb.state
  2078. @eplb_state.setter
  2079. def eplb_state(self, state) -> None:
  2080. self.eplb.state = state
  2081. @property
  2082. def eep_eplb_suppressed(self) -> bool:
  2083. return self.eplb.suppressed
  2084. @eep_eplb_suppressed.setter
  2085. def eep_eplb_suppressed(self, suppressed: bool) -> None:
  2086. self.eplb.suppressed = suppressed
  2087. def setup_eplb_from_mapping(
  2088. self, expanded_physical_to_logical: torch.Tensor
  2089. ) -> None:
  2090. self.eplb.setup_from_mapping(
  2091. self.model, self.model_config, expanded_physical_to_logical
  2092. )
  2093. ########### EPLB methods end ###########
  2094. # Out-of-tree hardware runners can select a PCP manager class.
  2095. @property
  2096. def pcp_manager_cls(self) -> type[pcp.PCPManager]:
  2097. return pcp.PCPManager
  2098. class ExecuteModelState(NamedTuple):
  2099. input_batch: InputBatch
  2100. attn_metadata: dict[str, Any] | None
  2101. slot_mappings_by_layer: dict[str, torch.Tensor] | None
  2102. hidden_states: torch.Tensor | None
  2103. aux_hidden_states: list[torch.Tensor] | None
  2104. dp_sync: DPSyncState | None
  2105. finished_req_ids: set[str]
  2106. ec_connector_output: ECConnectorOutput | None
  2107. cudagraph_stats: CUDAGraphStat | None
  2108. class BatchReqState(NamedTuple):
  2109. """CPU request state for a scheduled batch, in batch (sorted) order."""
  2110. req_ids: list[str]
  2111. num_scheduled_tokens: np.ndarray # [num_reqs]
  2112. # May be less than scheduler_output.total_num_scheduled_tokens:
  2113. # adaptive verification trims the draft budget before running.
  2114. num_tokens: int
  2115. idx_mapping_np: np.ndarray # [num_reqs]
  2116. prefill_len_np: np.ndarray # [num_reqs]
  2117. num_computed_prefill_tokens_np: np.ndarray # [num_reqs]
  2118. is_prefilling_np: np.ndarray # [num_reqs]
  2119. has_prefill: bool
  2120. def sort_batch_req_ids(
  2121. num_tokens_per_req: dict[str, int],
  2122. draft_tokens: dict[str, list[int]],
  2123. decode_query_len: int,
  2124. ) -> list[str]:
  2125. # Order verification/decode -> short_extend -> prefill;
  2126. # split_decodes_and_prefills relies on decode-like requests leading.
  2127. key = lambda r: (
  2128. not draft_tokens.get(r),
  2129. (num := num_tokens_per_req[r]) != decode_query_len,
  2130. num,
  2131. )
  2132. return sorted(num_tokens_per_req, key=key)