model_runner.py 106 KB

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