vllm.v1.kv_offload.tiering.manager
¶
TieringOffloadingManager: Multi-tier KV cache offloading orchestrator.
This manager coordinates between a CPU primary tier (with direct GPU access) and zero or more secondary tiers (Storage, Network, etc.) to provide hierarchical KV cache offloading.
Key Design Principles: 1. Always offload to all tiers — When a chunk is stored to the primary tier, it is cascaded to ALL secondary tiers 2. Primary tier is the gateway — Secondary tiers cannot access GPU memory directly; all data flows through the CPU primary tier 3. Staged promotion — Chunks in secondary tiers must be promoted to the primary tier before GPU can access them 4. Transparent retry mechanism — Return None from lookup() to signal "data is being promoted, try later" 5. ref_cnt as eviction protection — primary.prepare_read() increments ref_cnt, protecting chunks from eviction until complete_read() is called
Classes:
-
CPUPrimaryTierOffloadingManager–CPUOffloadingManager with a primary/secondary transfer interface.
-
PendingPromotion–Accumulator for chunks awaiting submit_load() for one (tier, request).
-
TieringOffloadingManager–Orchestrates multi-tier KV cache offloading.
CPUPrimaryTierOffloadingManager
¶
Bases: CPUOffloadingManager
CPUOffloadingManager with a primary/secondary transfer interface.
The inherited prepare_store/complete_store/prepare_load/complete_load are the GPU-facing OffloadingManager interface. These aliases expose the same operations from the secondary tier perspective, where read/write refers to secondary accessing primary. This avoids confusion when reading TieringOffloadingManager code (e.g. calling prepare_load inside a cascade/store path would be misleading).
Methods:
-
get_kv_memoryview–Return the memoryview over the primary tier's KV cache buffer.
-
prepare_read–Pin chunks for a CPU-to-secondary transfer.
Source code in vllm/v1/kv_offload/tiering/manager.py
get_kv_memoryview()
¶
Return the memoryview over the primary tier's KV cache buffer.
The view has shape (num_chunks, row_stride_bytes) and is backed by the
SharedOffloadRegion mmap. Secondary tiers address chunk c as
view[c].
Source code in vllm/v1/kv_offload/tiering/manager.py
prepare_read(keys, req_context)
¶
Pin chunks for a CPU-to-secondary transfer.
Cascade reads are implementation details of tiering, not additional request accesses, so they must not alter request-scoped recency.
Source code in vllm/v1/kv_offload/tiering/manager.py
PendingPromotion
dataclass
¶
Accumulator for chunks awaiting submit_load() for one (tier, request).
Source code in vllm/v1/kv_offload/tiering/manager.py
TieringOffloadingManager
¶
Bases: OffloadingManager
Orchestrates multi-tier KV cache offloading.
This manager coordinates between a CPU primary tier (with direct GPU access) and zero or more secondary tiers (Storage, Network, etc.) to provide hierarchical KV cache offloading.
Key internal state
- Minimal state tracking; relies on secondary tiers to report completion via get_finished_jobs()
- Secondary tiers return JobResult objects containing all necessary information
- job_id_counter: monotonically increasing counter for job IDs
Methods:
-
__init__–Initialize the TieringOffloadingManager.
-
complete_load–Mark chunks as done loading from primary tier to GPU.
-
complete_store–Mark chunks as done storing from GPU to primary tier.
-
create_store_job–Pin chunks in the primary tier and create a tracked store job.
-
lookup–Check whether a single chunk is offloaded and ready.
-
on_new_request–Query each secondary tier for its offload policy preference.
-
on_schedule_end–End-of-schedule hook: process finished jobs, flush deferred
-
poll_tiers–Advance the control plane of tiers that cannot wait for a step.
-
prepare_load–Prepare chunks to be loaded from primary tier to GPU.
-
prepare_store–Prepare chunks to be stored from GPU to primary tier.
-
reset_cache–Reset transfer bookkeeping and primary-tier cache.
-
shutdown–Shut down secondary tiers before releasing primary resources.
-
take_events–Yield events owned by the primary and secondary tiers.
-
touch–Mark chunks as recently used in all tiers.
Source code in vllm/v1/kv_offload/tiering/manager.py
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 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 | |
__init__(primary_tier, secondary_tiers=None, tier_poll_interval_s=DEFAULT_TIER_POLL_INTERVAL_S)
¶
Initialize the TieringOffloadingManager.
Parameters:
-
(primary_tier¶CPUPrimaryTierOffloadingManager) –The primary tier manager (CPU-based).
-
(secondary_tiers¶list[SecondaryTierManager] | None, default:None) –List of secondary tier managers (e.g., Storage, Network). Can be None or empty list.
-
(tier_poll_interval_s¶float, default:DEFAULT_TIER_POLL_INTERVAL_S) –Pause between control-plane rounds for tiers that set serves_external_requests. Zero or negative disables the thread, leaving those tiers serviced once per engine step as before.
Source code in vllm/v1/kv_offload/tiering/manager.py
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 | |
_cascade_existing_chunks_to_request_level_tiers(keys, req_context, request_level_tiers)
¶
For tiers that requested request-level policy, submit_store() for chunks that are already present in the primary tier.
A key whose primary write is still in flight (HIT_PENDING) cannot be dropped: prepare_store already excluded it as present, and the scheduler advances past its chunk, so no path offers it again. Park it instead. MISS keys are dropped, since nothing is there to read.
The primary tier resolves every key it holds, so RETRY cannot reach here. Parking on it would have no guarantee of ever draining, which is what makes parking HIT_PENDING safe, so it is rejected rather than guessed at.
Source code in vllm/v1/kv_offload/tiering/manager.py
_flush_pending_cascades()
¶
Retry request-level cascades parked on an in-flight primary write.
A parked key always resolves, to HIT or to MISS, so the set drains and a request cannot be held from finalization forever.
Source code in vllm/v1/kv_offload/tiering/manager.py
_flush_pending_promotions()
¶
Submit one batched submit_load() per (tier, request).
Called from on_schedule_end() at the end of each scheduler step, flushing all promotion requests deferred during lookup().
Source code in vllm/v1/kv_offload/tiering/manager.py
_initiate_promotion(tier_idx, key, req_context)
¶
Queue a chunk for promotion from a secondary tier to the primary tier.
Allocates space in the primary tier immediately (sets ref_cnt=-1 so subsequent lookups within the same step see the slot as in-flight), then defers the actual submit_load() call to _flush_pending_promotions() so all chunks queued during one engine step are submitted as a single batched job.
Parameters:
-
(tier_idx¶int) –The secondary tier index to promote from
-
(key¶OffloadKey) –Chunk to promote
-
(req_context¶ReqContext) –Per-request context forwarded to primary.prepare_write().
Returns:
-
bool–True if promotion was initiated, False if primary tier is full.
Source code in vllm/v1/kv_offload/tiering/manager.py
_maybe_finalize_request(req_id, exclude_tier_idx=None)
¶
Finalize secondary tiers once no more cascades can be submitted.
Their finalization is delayed until pending GPU->primary stores finish, since those callbacks may still submit secondary stores.
Source code in vllm/v1/kv_offload/tiering/manager.py
_maybe_process_finished_jobs()
¶
Poll secondary tiers for completed jobs (at most once per step).
Guarded by _processed_jobs_this_step: the first call in an engine step does the actual polling; subsequent calls are no-ops. The flag is reset in on_schedule_end() at the end of each step.
Source code in vllm/v1/kv_offload/tiering/manager.py
_next_job_id()
¶
_process_finished_jobs(tiers=None)
¶
Unconditionally poll secondary tiers for completed jobs.
This method: 1. Calls get_finished_jobs() on each secondary tier 2. For completed stores (primary→secondary): calls primary.complete_read() to decrement ref_cnt 3. For completed loads (secondary→primary): calls primary.complete_write() to make chunks available
Parameters:
-
(tiers¶Sequence[tuple[int, SecondaryTierManager]] | None, default:None) –(index, tier) pairs to poll. Defaults to every secondary tier. Pass a subset to poll only the tiers a caller is responsible for, so a tier that expects to be polled on the scheduler thread is not dragged elsewhere.
Source code in vllm/v1/kv_offload/tiering/manager.py
_start_control_plane()
¶
Start the control-plane thread, if any tier asked for one.
Source code in vllm/v1/kv_offload/tiering/manager.py
_stop_control_plane()
¶
Stop and join the control-plane thread.
Must run before any tier teardown: the thread drives tier transports, and closing one underneath it can crash the process rather than raise.
Source code in vllm/v1/kv_offload/tiering/manager.py
complete_load(keys, req_context)
¶
Mark chunks as done loading from primary tier to GPU.
This decrements ref_cnt on the chunks in the primary tier, allowing them to be evicted again.
Parameters:
-
(keys¶Collection[OffloadKey]) –Chunks that finished loading.
-
(req_context¶ReqContext) –Per-request context.
Source code in vllm/v1/kv_offload/tiering/manager.py
complete_store(keys, req_context, success=True)
¶
Mark chunks as done storing from GPU to primary tier.
This is where secondary tier cascading happens — after chunks are confirmed to be in the primary tier, they are cascaded to ALL secondary tiers.
For each secondary tier: 1. Call primary.prepare_read() to get LoadStoreSpec AND increment ref_cnt (protecting chunks during async transfer) 2. Call tier.submit_store() to start async transfer: primary→secondary 3. Track the job in _store_jobs dictionary
Parameters:
-
(keys¶Collection[OffloadKey]) –Chunks that finished storing.
-
(success¶bool, default:True) –Whether the GPU→primary transfer succeeded.
-
(req_context¶ReqContext) –Per-request context forwarded to primary.prepare_read().
Source code in vllm/v1/kv_offload/tiering/manager.py
create_store_job(keys, req_context, tier_idx=0)
¶
Pin chunks in the primary tier and create a tracked store job.
Calls prepare_read() to increment ref_cnt (protecting chunks from eviction during the async transfer), allocates a job ID, and registers the job in _jobs.
The caller is responsible for the actual data transfer and reporting completion via get_finished_jobs().
Source code in vllm/v1/kv_offload/tiering/manager.py
lookup(key, req_context, *, exclude_tier_idx=None)
¶
Check whether a single chunk is offloaded and ready.
Algorithm
- Process any completed async jobs first.
- Query primary tier — short-circuit on hit or in-flight.
- On primary miss, query secondary tiers — stop on first hit and initiate promotion.
Parameters:
-
(key¶OffloadKey) –Chunk hash to look up.
-
(req_context¶ReqContext) –Per-request context.
-
(exclude_tier_idx¶int | None, default:None) –Skip this tier index during the lookup.
Returns:
-
LookupResult–HIT — chunk is ready in the primary tier.
-
LookupResult–HIT_PENDING — chunk found but not yet readable (write in-flight on the primary tier).
-
LookupResult–RETRY — promotion started or a secondary tier is busy.
-
LookupResult–MISS — chunk not found in any tier, or primary is full and cannot accept a promotion.
Source code in vllm/v1/kv_offload/tiering/manager.py
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 | |
on_new_request(req_context, *, exclude_tier_idx=None)
¶
Query each secondary tier for its offload policy preference.
Returns REQUEST_LEVEL if ANY secondary tier wants request-level. Only stores REQUEST_LEVEL tier decisions for use in prepare_store.
Source code in vllm/v1/kv_offload/tiering/manager.py
on_schedule_end(context)
¶
End-of-schedule hook: process finished jobs, flush deferred promotions, and reset the per-step gate.
Called once per scheduler step, as the last manager call of the step, from OffloadingConnectorScheduler.build_connector_meta().
Source code in vllm/v1/kv_offload/tiering/manager.py
poll_tiers()
¶
Advance the control plane of tiers that cannot wait for a step.
Polls those tiers for finished jobs and lets them serve whatever their counterpart has asked for -- the same two steps on_schedule_end() runs, narrowed to the tiers that opted in.
Excludes _flush_pending_promotions() and _flush_pending_cascades() by design: both are per-step batching points, and running them here would fragment batches the scheduler thread accumulated during schedule(). A promotion that a lookup() from this path initiates therefore waits for the next on_schedule_end() to be submitted.
The caller must hold self.lock for the whole call. serve_external_requests() relies on that: it establishes lookup() HITs and then pins them, and the two must not be separated by an eviction.
Serving can look keys up through the parent, and lookup() runs the step's once-per-step poll. From here that poll would reach every tier off-thread, re-enter the serving tier's get_finished_jobs() from inside its own serve, and leave the gate set so the next step skips its poll. The round has just polled its tiers itself, so it holds the gate shut for its duration and then puts it back untouched.
Source code in vllm/v1/kv_offload/tiering/manager.py
prepare_load(keys, req_context)
¶
Prepare chunks to be loaded from primary tier to GPU.
Callers only pass keys already confirmed HIT by lookup() earlier this step.
This increments ref_cnt on the chunks in the primary tier, protecting them from eviction during the transfer.
Parameters:
-
(keys¶Collection[OffloadKey]) –Chunks to prepare for loading.
-
(req_context¶ReqContext) –Per-request context.
Returns:
-
LoadStoreSpec–LoadStoreSpec for reading from primary tier.
Source code in vllm/v1/kv_offload/tiering/manager.py
prepare_store(keys, req_context)
¶
Prepare chunks to be stored from GPU to primary tier.
CRITICAL: This method polls for finished jobs FIRST to ensure that any completed async transfers have their ref_cnt decremented before the primary tier makes eviction decisions.
For request-level tiers, chunks already present in the primary tier are immediately cascaded via submit_store().
Parameters:
-
(keys¶Collection[OffloadKey]) –Chunks to prepare for storing.
-
(req_context¶ReqContext) –Per-request context.
Returns:
-
PrepareStoreOutput | None–PrepareStoreOutput describing where to store chunks and what was
-
PrepareStoreOutput | None–evicted, or None if store cannot proceed.
Source code in vllm/v1/kv_offload/tiering/manager.py
reset_cache()
¶
Reset transfer bookkeeping and primary-tier cache.
Called during sleep, weight update, or resume. Each secondary tier drains its in-flight transfers via drain_jobs() so no tier I/O is touching primary memory before the primary tier is reset. A stuck tier will block here visibly — preferable to silent corruption from reusing primary slots while a transfer is mid-copy.
Secondary tiers are intentionally not reset: persistent stores (FS, network) keep their data across resets. Active request state is retained so those requests can continue after the reset; finished requests are finalized and removed.
Source code in vllm/v1/kv_offload/tiering/manager.py
shutdown()
¶
Shut down secondary tiers before releasing primary resources.
Stops the control-plane thread first: it drives tier transports, and tearing one down underneath it (closing a socket, destroying a ZMQ context) can take the process down rather than raise. If the thread will not exit, hold the manager lock across tier teardown so it cannot be mid-round, and skip teardown entirely if even that is unavailable -- a lingering daemon thread in an exiting process beats a crash.
Every secondary tier is given a shutdown attempt. If any shutdown fails, preserve the primary mmap because a failed tier may still use it.
Source code in vllm/v1/kv_offload/tiering/manager.py
take_events()
¶
Yield events owned by the primary and secondary tiers.
Yields:
-
Iterable[OffloadingEvent]–New OffloadingEvents collected by each tier since the last call.
Source code in vllm/v1/kv_offload/tiering/manager.py
touch(keys, req_context)
¶
Mark chunks as recently used in all tiers.
Parameters:
-
(keys¶Collection[OffloadKey]) –Chunks to mark as recently used.
-
(req_context¶ReqContext) –Per-request context.
Source code in vllm/v1/kv_offload/tiering/manager.py
_SecondaryTierFacingParent
¶
Bases: ParentManager
Wrapper that implements ParentManager by delegating to the TieringOffloadingManager with exclude_tier_idx set to the origin tier.