vllm.v1.kv_offload.tiering.p2p.data
¶
Modules:
-
base–Abstract base class for the P2P data-plane transport.
-
nixl–NixlTransport: Data-plane transport for RDMA-based KV block transfers via NIXL.
Classes:
-
DataTransport–Abstract data-plane transport for RDMA-style block transfers.
-
NixlTransport–Manages a NIXL agent, memory registration, and block transfers.
-
PollResult–Result of polling inflight transfers.
DataTransport
¶
Bases: ABC
Abstract data-plane transport for RDMA-style block transfers.
Owns the local KV block memory region and manages transfers to/from registered remote peers.
Construction
view: A 2D memoryview (num_blocks × block_len bytes) over the local KV cache block storage. config_fields: Dict of model config values used to compute the compatibility fingerprint. None → empty fingerprint (compatible with any peer).
Methods:
-
add_remote_peer–Register a remote peer for block transfers.
-
add_remote_peer_async–Register a remote peer without blocking the caller.
-
cancel–Cancel inflight transfers by their IDs.
-
close–Release all resources (registrations, handles, memory).
-
get_agent_metadata–Return opaque metadata needed by remote peers to connect.
-
poll–Poll inflight transfers for completion.
-
remove_remote_peer–Unregister a remote peer and release associated resources.
-
write_blocks–Submit a WRITE transfer: local blocks → remote peer's blocks.
Attributes:
-
base_addr(int) –Base address of the local block memory region.
-
block_len(int) –Size of each block in bytes.
-
config_fingerprint(str) –Content-hash of the model configuration (hex string).
-
num_blocks(int) –Number of blocks in the local region.
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | |
base_addr
property
¶
Base address of the local block memory region.
block_len
property
¶
Size of each block in bytes.
config_fingerprint
property
¶
Content-hash of the model configuration (hex string).
Peers must have matching fingerprints to exchange blocks. Empty string means no fingerprint (always compatible).
num_blocks
property
¶
Number of blocks in the local region.
add_remote_peer(peer_id, agent_metadata, base_addr, num_blocks, block_len)
abstractmethod
¶
Register a remote peer for block transfers.
Must be called before write_blocks() to this peer.
Parameters:
-
(peer_id¶str) –Unique identifier for the remote peer.
-
(agent_metadata¶bytes) –Opaque bytes from the peer's get_agent_metadata().
-
(base_addr¶int) –Base address of the peer's block memory region.
-
(num_blocks¶int) –Number of blocks in the peer's region.
-
(block_len¶int) –Size of each block (must match local block_len).
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
add_remote_peer_async(peer_id, agent_metadata, base_addr, num_blocks, block_len)
¶
Register a remote peer without blocking the caller.
Registration is O(num_blocks) and can take seconds for a large
secondary tier, so the session starts it here and sends
ConnectAckMsg only once the returned future resolves. The
acknowledgement is therefore the peer's guarantee that this side
is ready to serve, and no write_blocks can arrive before it.
The default implementation runs add_remote_peer inline and
returns an already-resolved future; transports whose registration
is cheap need not override it.
Parameters:
-
(peer_id¶str) –Unique identifier for the remote peer.
-
(agent_metadata¶bytes) –Opaque bytes from the peer's get_agent_metadata().
-
(base_addr¶int) –Base address of the peer's block memory region.
-
(num_blocks¶int) –Number of blocks in the peer's region.
-
(block_len¶int) –Size of each block (must match local block_len).
Returns:
-
Future[None]–A future resolving to None on success. A failed future means
-
Future[None]–the peer must be rejected rather than acknowledged.
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
cancel(transfer_ids, mode='immediate')
abstractmethod
¶
Cancel inflight transfers by their IDs.
Best-effort: transfers that already completed are ignored.
Parameters:
-
(transfer_ids¶Iterable[int]) –IDs to cancel. Unknown IDs are ignored.
-
(mode¶CancelMode, default:'immediate') –"immediate" (default): pop and release each handle and return []. Matches the legacy fire-and-forget behavior — the caller does not wait for the underlying transfer to drain. "wait": release only transfers that have stopped. A transfer still PROC/PEND (or whose release fails) stays in the inflight set and its id is included in the returned list. The caller is expected to keep calling poll() until every returned id surfaces in done/failed.
Returns:
-
list[int]–For mode="wait", the subset of transfer_ids still
-
list[int]–tracked as inflight after the cancel attempt. For
-
list[int]–mode="immediate", always [].
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
close()
abstractmethod
¶
Release all resources (registrations, handles, memory).
Cancels any remaining inflight transfers. Idempotent. After close(), no other methods may be called.
get_agent_metadata()
abstractmethod
¶
Return opaque metadata needed by remote peers to connect.
The returned bytes are sent during the control-plane handshake and passed to the remote peer's add_remote_peer().
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
poll(peer_id=None)
abstractmethod
¶
Poll inflight transfers for completion.
Parameters:
-
(peer_id¶str | None, default:None) –If given, only poll (and drain) transfers submitted for this peer_id — the value passed to
write_blocks. This is required when a single transport is shared across multiple peer sessions:poll()pops completed handles, so an unscoped poll by one session would consume and discard the completions of its siblings, starving them.Nonepolls every peer's transfers (used only for the shutdown drain).
Returns:
-
PollResult–PollResult with lists of completed and failed transfer_ids.
-
PollResult–Completed/failed transfers are removed from the inflight set.
Must be called periodically to drive progress checking.
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
remove_remote_peer(peer_id)
abstractmethod
¶
Unregister a remote peer and release associated resources.
Inflight transfers to this peer should be cancelled first.
write_blocks(peer_id, local_idxs, remote_idxs)
abstractmethod
¶
Submit a WRITE transfer: local blocks → remote peer's blocks.
Parameters:
-
(peer_id¶str) –Target peer (must be registered via add_remote_peer).
-
(local_idxs¶list[int]) –Indexes of local blocks to read from.
-
(remote_idxs¶list[int]) –Indexes of remote blocks to write to. Must be same length as local_idxs.
Returns:
-
int | None–A unique transfer_id (int) to track this transfer, or
-
int | None–None if the peer is not registered or submission failed.
Source code in vllm/v1/kv_offload/tiering/p2p/data/base.py
NixlTransport
¶
Bases: DataTransport
Manages a NIXL agent, memory registration, and block transfers.
Wraps the NIXL C library behind a Python interface so the rest of the P2P tier code never touches NIXL types directly. Tracks inflight handles internally and returns completed/failed tags on poll.
Methods:
-
cancel–Cancel inflight transfers by their IDs.
-
poll–Poll inflight transfers.
-
write_blocks–Submit a WRITE transfer to peer_id.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 | |
_begin_registration(peer_id)
¶
Claim the next registration generation for peer_id.
_build_peer_handles(agent_metadata, base_addr, num_blocks, block_len)
¶
The expensive half: agent wireup plus one descriptor per block.
Touches no shared state, so it runs unlocked — holding the peer lock across it would stall the scheduler thread for exactly as long as the registration it is meant to move off that thread.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
_publish_peer(peer_id, gen, nixl_name, remote_dlist)
¶
Install freshly built handles, unless gen is stale.
Returns False when the peer was removed or re-registered while the handles were being built; the handles are released here since nothing else ever saw them.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
_record_failure(peer_id, exc)
¶
Classify a NIXL exception: a peer fault, or one strike.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
_record_state_check_failure(peer_id, exc)
¶
Fault peer_id for a check_xfer_state that raised.
The bindings raise for every NIXL error status (only success and in-progress are returned), so a raise is a failure NIXL reported, not a flaky check. A peer whose transfer state can't be trusted is torn down rather than given strikes: with strikes, successes to the same peer could keep resetting them while the transfer stays inflight, holding its pins, for good.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
_release_remote_handles(peer_id, dlist, nixl_name)
¶
Release a peer's descriptor list and remote agent independently.
The two teardown operations are independent: NIXL may reject one
after a transport failure, and a release_dlist_handle that
raises must not skip remove_remote_agent. Skipping it would
leave a stale remote registration behind after the peer is gone
(peer removal) or after its registration was superseded.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
cancel(transfer_ids, mode='immediate')
¶
Cancel inflight transfers by their IDs.
See DataTransport.cancel for the contract. In "wait" mode, a
transfer is released only once NIXL reports it terminal. Releasing
a PROC/PEND handle does not stop the WRITE: the UCX backend frees
the request without cancelling RMA, and the bytes keep landing. So
PROC/PEND transfers, and those whose state check or
release_xfer_handle raises, stay in self._inflight for a
later poll() to observe. A state check that raises faults the
peer; only a remote disconnect also counts as terminal (see
_is_terminal_state_error).
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
poll(peer_id=None)
¶
Poll inflight transfers.
When peer_id is given, only transfers submitted for that peer_id are checked and drained — the transport is shared across peer sessions, so an unscoped poll by one session would consume and discard siblings' completions. peer_id None polls every peer (shutdown drain only).
Returns PollResult(done=..., failed=..., peer_fault=...) with
transfer IDs. Completed handles are released automatically.
peer_fault is set on a scoped poll once peer_id is faulted.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 | |
write_blocks(peer_id, local_idxs, remote_idxs)
¶
Submit a WRITE transfer to peer_id.
Returns a transfer ID, or None if the peer is not registered or submission fails. The ID is returned via poll() when the transfer completes or fails.
Source code in vllm/v1/kv_offload/tiering/p2p/data/nixl.py
PollResult
¶
Bases: NamedTuple
Result of polling inflight transfers.
Attributes:
-
done(Sequence[int]) –Transfer IDs that completed successfully.
-
failed(Sequence[int]) –Transfer IDs that failed (error, timeout, etc.).
-
peer_fault(str | None) –Set only on a peer-scoped poll() once the transport has judged the peer unusable (see "Failure model"); a short human-readable cause. None while the peer is healthy.