File size: 39,672 Bytes
c7550ff a815cac c7550ff a815cac c7550ff a815cac c7550ff a815cac c7550ff | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 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 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 | # SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""Dedicated CPU-offload process for PLE embedding layers.
This module implements a standalone process that:
1. Loads only the :class:`PleOffloadLayer` weights into CPU memory.
2. Accepts per-step computation requests from GPU worker processes.
3. Runs ``forward_impl()`` on CPU, copies results to every TP worker's GPU
output buffer for the requesting DP rank, and signals the corresponding
IPC semaphore.
The TP workers within one DP rank receive identical inputs, so the CPU result
is computed once per DP rank and fanned out to all of its TP ranks.
Class structure mirrors the GPU worker pattern in multiproc_executor.py:
PleOffloadWorkerHandle -- handle held by the spawning GPU worker
PleOffloadWorker -- process lifecycle and READY handshake
PleOffloadRunner -- owns weights and serves inference requests
"""
import contextlib
import json
import mmap as _mmap
import multiprocessing.process
import pickle
import signal
import tempfile
import threading
from collections.abc import Iterable
from dataclasses import dataclass
from multiprocessing.connection import Connection
from typing import Any, cast
import msgspec
import torch
import torch.distributed as dist
import zmq
import vllm.envs as envs
from vllm.config import VllmConfig, set_current_vllm_config
from vllm.distributed.parallel_state import (
ensure_model_parallel_initialized,
init_distributed_environment,
)
from vllm.logger import init_logger
from vllm.model_executor.layers.ple_offload_layer import (
CpuGpuSemaphore,
PleOffloadLayer,
mark_as_offload_worker,
)
from vllm.model_executor.model_loader import get_model_loader
from vllm.model_executor.model_loader.default_loader import DefaultModelLoader
from vllm.model_executor.model_loader.dummy_loader import DummyModelLoader
from vllm.model_executor.model_loader.utils import (
initialize_model,
process_weights_after_loading,
)
from vllm.model_executor.model_loader.weight_utils import initialize_dummy_weights
from vllm.utils.system_utils import decorate_logs, get_mp_context
from vllm.utils.torch_utils import set_default_torch_dtype
from vllm.v1.ple_offload.protocol import (
_PLE_OFFLOAD_REQUEST_DECODER,
PleOffloadRegistration,
PleOffloadRequest,
)
logger = init_logger(__name__)
@dataclass
class PleOffloadOutputTarget:
"""GPU output destination and semaphore for one TP worker."""
tp_rank: int
gpu_output_buffer: torch.Tensor # IPC-mapped GPU buffer for this TP worker
sem: CpuGpuSemaphore # semaphore paired with gpu_output_buffer
copy_stream: torch.cuda.Stream
@dataclass
class PleOffloadInputBuffers:
"""Shared-memory input buffers registered for one DP rank."""
input_ids_buf: torch.Tensor # int32 (max_num_tokens,)
query_start_loc_buf: torch.Tensor # int32 (max_num_reqs + 1,)
ngram_context_buf: torch.Tensor | None # int32 (max_num_reqs, ngram_context_len)
@dataclass
class PleOffloadWorkerHandle:
"""Resources owned by the GPU worker that spawned the offload process."""
proc: Any
death_writer: Connection | None
ready_pipe_reader: Connection | None
def close(self) -> None:
"""Release all process resources. Safe to call more than once."""
if self.ready_pipe_reader is not None:
self.ready_pipe_reader.close()
self.ready_pipe_reader = None
if self.death_writer is not None:
self.death_writer.close()
self.death_writer = None
# First allow the child to exit after observing the closed death pipe.
if self.proc.is_alive():
self.proc.join(timeout=5)
# Fall back to SIGTERM if graceful shutdown times out.
if self.proc.is_alive():
self.proc.terminate()
self.proc.join(timeout=5)
# Use SIGKILL as the final fallback for a stuck child.
if self.proc.is_alive():
self.proc.kill()
self.proc.join(timeout=5)
def _init_offload_distributed() -> None:
"""Initialize the single-rank Gloo world required by TP-aware layers."""
if dist.is_initialized():
return
# VocabParallelEmbedding reads the TP process group during construction.
# The offload process owns the full embedding table, so it uses an isolated
# TP1/PP1 Gloo world and never joins the GPU workers' NCCL groups.
store_dir = tempfile.mkdtemp(prefix="vllm_ple_offload_")
init_distributed_environment(
world_size=1,
rank=0,
distributed_init_method=f"file://{store_dir}/store",
local_rank=0,
backend="gloo",
)
# initialize_model_parallel reads the active VllmConfig in the current
# vLLM version. Explicitly configure DP1/TP1/PP1 to match the isolated
# world, regardless of any DP environment variables inherited from the GPU
# worker. The real DP/TP configuration is used later for model construction,
# registration, and request routing.
offload_config = VllmConfig()
offload_parallel_config = offload_config.parallel_config
offload_parallel_config.data_parallel_size = 1
offload_parallel_config.data_parallel_size_local = 1
offload_parallel_config.data_parallel_rank = 0
offload_parallel_config.data_parallel_rank_local = 0
offload_parallel_config.data_parallel_index = 0
offload_parallel_config.tensor_parallel_size = 1
offload_parallel_config.pipeline_parallel_size = 1
offload_parallel_config.prefill_context_parallel_size = 1
offload_parallel_config.decode_context_parallel_size = 1
offload_parallel_config.world_size = 1
offload_parallel_config.nnodes = 1
offload_parallel_config.node_rank = 0
with set_current_vllm_config(offload_config):
ensure_model_parallel_initialized(
tensor_model_parallel_size=1,
pipeline_model_parallel_size=1,
backend="gloo",
)
logger.info(
"Distributed environment initialized (backend=gloo, rank=0, world_size=1)."
)
class PleOffloadWorker:
"""Manage process creation, READY handshake, and the child entry point."""
READY_STR = "READY"
@staticmethod
def make_process(
vllm_config: VllmConfig,
num_workers: int,
ipc_addr: str,
) -> PleOffloadWorkerHandle:
"""Spawn one CPU offload process for all local DP and TP workers."""
context = get_mp_context()
ready_reader, ready_writer = context.Pipe(duplex=False)
death_reader, death_writer = context.Pipe(duplex=False)
proc = context.Process(
target=PleOffloadWorker.proc_main,
kwargs={
"vllm_config": vllm_config,
"num_workers": num_workers,
"ipc_addr": ipc_addr,
"ready_pipe": (ready_reader, ready_writer),
"death_pipe": death_reader,
},
name="PleOffloadWorker",
daemon=True,
)
# Python normally forbids a daemon WorkerProc from spawning children.
# vLLM owns this process through death_pipe and explicit shutdown, so
# temporarily clear the daemon flag while the child is created.
parent = multiprocessing.process._current_process # type: ignore[attr-defined]
saved_daemon = parent._config.get("daemon")
parent._config["daemon"] = False
try:
proc.start()
finally:
parent._config["daemon"] = saved_daemon
ready_writer.close()
return PleOffloadWorkerHandle(
proc=proc,
death_writer=death_writer,
ready_pipe_reader=ready_reader,
)
@staticmethod
def wait_for_ready(handle: PleOffloadWorkerHandle) -> None:
"""Wait until weights and all GPU registrations are ready to serve."""
reader = handle.ready_pipe_reader
if reader is None:
return
if not reader.poll(envs.VLLM_PLE_OFFLOAD_READY_TIMEOUT):
raise TimeoutError(
"PLE offload worker did not become ready within "
f"{envs.VLLM_PLE_OFFLOAD_READY_TIMEOUT}s."
)
try:
message = reader.recv()
except EOFError as error:
raise RuntimeError("PLE offload worker exited during startup") from error
finally:
reader.close()
handle.ready_pipe_reader = None
if message.get("status") != PleOffloadWorker.READY_STR:
raise RuntimeError(
"PLE offload worker failed during startup: "
f"{message.get('error', 'unknown error')}"
)
layer_names = message["layer_names"]
logger.info(
"Worker ready - %d PleOffloadLayer(s): %s",
len(layer_names),
layer_names,
)
@staticmethod
def proc_main(
vllm_config: VllmConfig,
num_workers: int,
ipc_addr: str,
ready_pipe: tuple[Connection, Connection],
death_pipe: Connection,
) -> None:
"""Load PLE weights, accept registrations, and run the request loop."""
decorate_logs("PleOffloadWorker")
ready_reader, ready_writer = ready_pipe
ready_reader.close()
shutdown_event = threading.Event()
def monitor_parent() -> None:
try:
death_pipe.recv()
except EOFError:
logger.info("Parent exited, shutting down.")
shutdown_event.set()
def handle_signal(_signum: int, _frame: object) -> None:
shutdown_event.set()
signal.signal(signal.SIGTERM, handle_signal)
signal.signal(signal.SIGINT, handle_signal)
threading.Thread(
target=monitor_parent,
daemon=True,
name="PleOffloadDeathMonitor",
).start()
zmq_context: zmq.Context | None = None
pull_socket: zmq.Socket | None = None
try:
# The flag lets PleOffloadLayer subclasses execute their complete
# constructors instead of becoming empty GPU-worker placeholders.
mark_as_offload_worker()
# Initialize Gloo before installing the real VllmConfig. This keeps
# the CPU process in an isolated rank-zero, world-size-one group.
_init_offload_distributed()
# Model components read the active VllmConfig while the meta model
# is constructed, so keep the context around runner initialization.
with set_current_vllm_config(vllm_config):
runner = PleOffloadRunner(vllm_config)
zmq_context = zmq.Context()
pull_socket = zmq_context.socket(zmq.PULL)
pull_socket.bind(ipc_addr)
logger.info(
"Bound IPC address %s; waiting for %d GPU worker registration(s).",
ipc_addr,
num_workers,
)
# READY means that the process can immediately serve requests. Wait
# for every DP/TP worker to register before notifying the parent.
runner.accept_registrations(pull_socket, num_workers)
ready_writer.send(
{
"status": PleOffloadWorker.READY_STR,
"layer_names": sorted(runner.layer_names),
}
)
ready_writer.close()
ready_writer = None # type: ignore[assignment]
runner.busy_loop(pull_socket, shutdown_event)
except Exception as error:
logger.exception("Unexpected failure in PLE offload worker.")
if ready_writer is not None:
with contextlib.suppress(Exception):
ready_writer.send({"status": "FAILURE", "error": repr(error)})
raise
finally:
if pull_socket is not None:
pull_socket.close(linger=0)
if zmq_context is not None:
zmq_context.term()
if ready_writer is not None:
ready_writer.close()
death_pipe.close()
def _ple_disk_shard_of(mapped_name: str) -> str | None:
""""<layer>.a.b.shard_3.weight" -> "<layer>.a.b" (the parameter the shard fills)."""
import re
m = re.match(r"^(.*)\.shard_\d+\.weight$", mapped_name)
return m.group(1) if m else None
class _PleQuantTable:
"""Shard-mmapped quantized n-gram table; gathers dequantize to BF16."""
ROWS_PER_SHARD = 2_500_012
def __init__(self, quant_dir: str, total_rows: int, width: int) -> None:
import json
import os
from safetensors import safe_open
meta = json.load(open(os.path.join(quant_dir, "META.json")))
self.layout = meta["layout"]
assert meta["rows"] == total_rows and meta["width"] == width, (
f"sidecar built for {meta['rows']}x{meta['width']}, "
f"table is {total_rows}x{width}"
)
n_shards = meta["shards"]
assert n_shards * self.ROWS_PER_SHARD == total_rows, "non-uniform shards"
# Order matters: the e2m1 layout string contains "e4m3" (its scale dtype).
if "e2m1" in self.layout:
key = "weight_e2m1"
elif "e4m3" in self.layout:
key = "weight_fp8"
else:
key = "weight_i4"
self._q, self._s, self._s2 = [], [], []
for n in range(n_shards):
f = safe_open(os.path.join(quant_dir, f"shard_{n}.safetensors"),
framework="pt")
self._q.append(f.get_tensor(key))
self._s.append(f.get_tensor("weight_scale"))
self._s2.append(
f.get_tensor("weight_scale_2").item()
if "weight_scale_2" in f.keys() else 1.0
)
self.width = width
self._lut = None
logger.info("PLE quant table: %s, %d shards mmapped from %s",
self.layout, n_shards, quant_dir)
def gather_into(self, ids: torch.Tensor, out: torch.Tensor) -> None:
ids = ids.long()
shard = ids // self.ROWS_PER_SHARD
local = ids - shard * self.ROWS_PER_SHARD
order = torch.argsort(shard)
s_sorted, l_sorted = shard[order], local[order]
uniq, counts = torch.unique_consecutive(s_sorted, return_counts=True)
pos = 0
for s, c in zip(uniq.tolist(), counts.tolist()):
sel = l_sorted[pos:pos + c]
rows = self._dequant(s, sel)
out[order[pos:pos + c]] = rows.to(out.dtype)
pos += c
def _dequant(self, s: int, sel: torch.Tensor) -> torch.Tensor:
if "e2m1" in self.layout:
if self._lut is None:
mags = [0.0, 0.5, 1.0, 1.5, 2.0, 3.0, 4.0, 6.0]
self._lut = torch.tensor(mags + [-m for m in mags],
dtype=torch.float32)
packed = self._q[s].index_select(0, sel)
lo = (packed & 0xF).long()
hi = (packed >> 4).long()
nib = torch.stack((lo, hi), dim=-1).view(packed.shape[0], self.width)
scale = self._s[s].index_select(0, sel).to(torch.float32)
g = self.width // scale.shape[1]
return (self._lut[nib]
* scale.repeat_interleave(g, dim=1)
* self._s2[s])
if "e4m3" in self.layout:
q = self._q[s].index_select(0, sel).to(torch.float32)
return q * self._s[s].index_select(0, sel)[:, None]
packed = self._q[s].index_select(0, sel)
lo = (packed & 0xF).to(torch.int16)
hi = (packed >> 4).to(torch.int16)
nib = torch.stack((lo, hi), dim=-1).view(packed.shape[0], self.width)
scale = self._s[s].index_select(0, sel).to(torch.float32)
g = self.width // scale.shape[1]
return (nib.to(torch.float32) - 8) * scale.repeat_interleave(g, dim=1)
def _ple_quant_dir() -> str | None:
import os
return os.environ.get("VLLM_PLE_QUANT_DIR") or None
def _ple_quant_attach(layer_name: str, layer: torch.nn.Module,
quant_dir: str) -> str | None:
"""Swap the layer's table for a sidecar-backed quant store.
Returns the stubbed parameter's name, or None when the layer has no
parameter large enough to be a table (>= 1 GiB).
"""
named = sorted(layer.named_parameters(), key=lambda kv: kv[1].numel(), reverse=True)
if not named or named[0][1].numel() * named[0][1].element_size() < (1 << 30):
return None
pname, param = named[0]
rows, width = param.shape
owner = layer
parts = pname.split(".")
for p in parts[:-1]:
owner = getattr(owner, p)
owner._ple_quant = _PleQuantTable(quant_dir, rows, width)
# Stub before anything writes the parameter: the original 95 GB allocation
# is lazy virtual memory and stays unmaterialized.
getattr(owner, parts[-1]).data = torch.empty(0, width, dtype=param.dtype)
logger.info("PLE quant: %s.%s stubbed, gathers served from sidecar.",
layer_name, pname)
return pname
def _ple_disk_dir() -> str | None:
import os
return os.environ.get("VLLM_PLE_DISK_OFFLOAD_DIR") or None
_PLE_DISK_MAPS: dict[str, object] = {}
def _disk_backed_tensor(path: str, shape: tuple[int, ...], dtype: torch.dtype,
writable: bool) -> torch.Tensor:
"""Map ``path`` as a tensor of ``shape``/``dtype``.
numpy has no bfloat16, so the file is mapped with a same-width integer dtype
and reinterpreted. ``writable`` selects a shared read-write mapping (first
boot, shard writes must reach the file) versus copy-on-write (steady state).
MADV_RANDOM is applied either way: gathers are random-access and readahead
only evicts useful pages.
"""
import numpy as np
_NP = {torch.bfloat16: (np.uint16, torch.uint16), torch.float16: (np.uint16, torch.uint16),
torch.float32: (np.uint32, torch.uint32), torch.float8_e4m3fn: (np.uint8, torch.uint8)}
np_dtype, torch_int = _NP[dtype]
arr = np.memmap(path, dtype=np_dtype, mode="r+" if writable else "c", shape=shape)
with contextlib.suppress(Exception):
arr._mmap.madvise(_mmap.MADV_RANDOM) # noqa: SLF001 - numpy has no public madvise
_PLE_DISK_MAPS[path] = arr
return torch.from_numpy(arr).view(dtype)
def _ple_disk_attach(layer_name: str, layer: torch.nn.Module,
disk_dir: str) -> tuple[str, bool] | None:
"""Swap the layer's largest parameter (the n-gram table) for a disk-backed map.
Returns ``(param_name, file_complete)`` or ``None`` when the layer has no
parameter large enough to be worth spilling (>= 1 GiB).
"""
import os
named = sorted(layer.named_parameters(), key=lambda kv: kv[1].numel(), reverse=True)
if not named or named[0][1].numel() * named[0][1].element_size() < (1 << 30):
return None
pname, param = named[0]
shape, dtype = tuple(param.shape), param.dtype
nbytes = param.numel() * param.element_size()
os.makedirs(disk_dir, exist_ok=True)
base = os.path.join(disk_dir, layer_name.replace("/", "_") + "." + pname)
bin_path, done_path = base + ".bin", base + ".done.json"
complete = False
if os.path.exists(done_path) and os.path.exists(bin_path) and os.path.getsize(bin_path) == nbytes:
meta = json.load(open(done_path))
complete = meta.get("shape") == list(shape) and meta.get("dtype") == str(dtype)
if not complete:
with contextlib.suppress(FileNotFoundError):
os.remove(done_path)
with open(bin_path, "ab") as f:
f.truncate(nbytes)
mapped = _disk_backed_tensor(bin_path, shape, dtype, writable=not complete)
# Replace the parameter data in place; module structure and names are unchanged,
# so load_weights and the gather path are untouched.
owner = layer
parts = pname.split(".")
for p in parts[:-1]:
owner = getattr(owner, p)
getattr(owner, parts[-1]).data = mapped
logger.info(
"PLE disk offload: %s.%s -> %s (%.1f GiB, %s)",
layer_name, pname, bin_path, nbytes / (1 << 30),
"reusing finished file" if complete else "first boot, writing through",
)
return pname, complete
def _ple_disk_finalize(layer_name: str, layer: torch.nn.Module, pname: str,
disk_dir: str) -> None:
"""Flush the written mapping, record completion, and remap copy-on-write."""
import os
owner = layer
parts = pname.split(".")
for p in parts[:-1]:
owner = getattr(owner, p)
param = getattr(owner, parts[-1])
base = os.path.join(disk_dir, layer_name.replace("/", "_") + "." + pname)
arr = _PLE_DISK_MAPS.get(base + ".bin")
if arr is not None:
with contextlib.suppress(Exception):
arr.flush()
json.dump({"shape": list(param.shape), "dtype": str(param.dtype)},
open(base + ".done.json", "w"))
param.data = _disk_backed_tensor(base + ".bin", tuple(param.shape), param.dtype,
writable=False)
logger.info("PLE disk offload: %s.%s finalized and remapped copy-on-write.",
layer_name, pname)
class PleOffloadRunner:
"""Own all discovered PLE tables and serve every local DP rank."""
def __init__(self, vllm_config: VllmConfig) -> None:
self.vllm_config = vllm_config
self._clamp_input_ids = (
getattr(vllm_config, "speculative_config", None) is not None
)
# name -> PleOffloadLayer (CPU)
self._layers: dict[str, PleOffloadLayer] = {}
# dp_rank -> layer_name -> one destination per TP rank
self._worker_targets: dict[int, dict[str, list[PleOffloadOutputTarget]]] = {}
# Each (dp_rank, layer_name) pair owns a separate pinned scratch buffer.
# Sharing one buffer is unsafe because an asynchronous H2D copy may still
# be reading it when another layer or DP rank starts writing.
self._pinned_bufs: dict[int, dict[str, torch.Tensor]] = {}
# Shared-memory inputs are registered once per DP rank by TP rank zero.
self._input_bufs: dict[int, PleOffloadInputBuffers] = {}
self._load_weights()
@property
def layer_names(self) -> list[str]:
"""Return PleOffloadLayer names in model traversal order."""
return list(self._layers)
def _load_weights(self) -> None:
"""Load only :class:`PleOffloadLayer` subtrees into CPU memory.
Strategy:
1. Build the entire model on ``meta`` so non-offloaded parameters use no
physical memory. PleOffloadLayer constructors explicitly target CPU.
2. Discover all PleOffloadLayer modules from the complete model.
3. Stream the checkpoint through a prefix filter so only matching PLE
tensors are materialized and passed to ``model.load_weights``.
4. Run post-load processing only on the CPU-owned PLE subtrees.
"""
model_config = self.vllm_config.model_config
load_config = self.vllm_config.load_config
# Step 1: build complete structure, while only PLE subtrees allocate CPU
# memory. All transformer, MoE, and vision parameters remain on meta.
logger.info("Initializing model structure for PLE weight discovery ...")
model_dtype = cast(torch.dtype, model_config.dtype)
with set_default_torch_dtype(model_dtype), torch.device("meta"):
model = initialize_model(
vllm_config=self.vllm_config,
model_config=model_config,
)
# Step 2: preserve named_modules DFS order so CPU execution follows the
# same layer order as the GPU model forward.
offload_layers = {
name: module
for name, module in model.named_modules()
if isinstance(module, PleOffloadLayer)
}
if not offload_layers:
raise RuntimeError(
"VLLM_PLE_CPU_OFFLOAD is enabled, but no PleOffloadLayer "
"was found in the initialized model"
)
logger.info(
"Found %d PleOffloadLayer(s): %s",
len(offload_layers),
sorted(offload_layers),
)
offload_prefixes = tuple(f"{name}." for name in offload_layers)
quant_dir = _ple_quant_dir()
disk_dir = _ple_disk_dir() if quant_dir is None else None
disk_attached: dict[str, str] = {}
disk_complete_params: set[str] = set()
disk_complete_tables: tuple[str, ...] = ()
if quant_dir is not None:
table_prefixes = []
for layer_name, layer in offload_layers.items():
pname = _ple_quant_attach(layer_name, layer, quant_dir)
if pname is None:
continue
full = f"{layer_name}.{pname}"
disk_complete_params.add(full)
table_prefixes.append(full.rsplit(".", 1)[0])
disk_complete_tables = tuple(table_prefixes)
if disk_dir is not None:
table_prefixes = []
for layer_name, layer in offload_layers.items():
attached = _ple_disk_attach(layer_name, layer, disk_dir)
if attached is None:
continue
pname, complete = attached
disk_attached[layer_name] = pname
if complete:
full = f"{layer_name}.{pname}"
disk_complete_params.add(full)
# "...ngram_embedding.weight" -> "...ngram_embedding": the module
# whose shard_N.weight checkpoint tensors fill this table.
table_prefixes.append(full.rsplit(".", 1)[0])
# Shard tensors that land inside an already-finished table are not
# re-read from the checkpoint: mapping the file replaces them.
disk_complete_tables = tuple(table_prefixes)
# Step 3: filter checkpoint tensors before model.load_weights(). The
# conditional-generation checkpoint uses HF names such as
# ``model.language_model.*`` while named_modules exposes mapped vLLM
# names such as ``language_model.model.*``. Apply the model mapper only
# for matching, then yield the original pair so load_weights performs
# its normal single mapping pass.
mapper = getattr(model, "hf_to_vllm_mapper", None)
matched_checkpoint_tensors = 0
def offload_only_iter(
weights: Iterable[tuple[str, torch.Tensor]],
) -> Iterable[tuple[str, torch.Tensor]]:
nonlocal matched_checkpoint_tensors
for weight_name, tensor in weights:
mapped_name: str | None = weight_name
if mapper is not None:
mapped_names = mapper.apply_list([weight_name])
mapped_name = mapped_names[0] if mapped_names else None
if mapped_name is not None and mapped_name.startswith(offload_prefixes):
matched_checkpoint_tensors += 1
if disk_complete_tables:
table = _ple_disk_shard_of(mapped_name)
if table is not None and table.startswith(disk_complete_tables):
continue
yield weight_name, tensor
loader = get_model_loader(load_config)
if isinstance(loader, DummyModelLoader):
logger.info(
"Initializing dummy weights for %d PleOffloadLayer(s) ...",
len(offload_layers),
)
for layer in offload_layers.values():
initialize_dummy_weights(layer, model_config)
elif isinstance(loader, DefaultModelLoader):
all_weights = loader.get_all_weights(model_config, model)
loaded_params = model.load_weights(offload_only_iter(all_weights))
if matched_checkpoint_tensors == 0:
raise RuntimeError(
"PLE offload checkpoint filter matched no weights for "
f"layers: {sorted(offload_layers)}"
)
expected_offload_params = {
f"{layer_name}.{param_name}"
for layer_name, layer in offload_layers.items()
for param_name, _ in layer.named_parameters()
}
loaded_offload_entries = {
name for name in loaded_params if name.startswith(offload_prefixes)
}
loaded_expected_params = expected_offload_params.intersection(loaded_params)
missing_offload_params = sorted(
expected_offload_params.difference(loaded_expected_params)
- disk_complete_params
)
if missing_offload_params:
raise RuntimeError(
"PLE offload checkpoint did not load all materialized "
f"parameters: {missing_offload_params}"
)
logger.info(
"PLE offload matched %d checkpoint tensor(s), loaded %d "
"offload entries, and verified %d/%d materialized "
"parameter(s) for layers: %s",
matched_checkpoint_tensors,
len(loaded_offload_entries),
len(loaded_expected_params),
len(expected_offload_params),
sorted(offload_layers),
)
else:
raise NotImplementedError(
"PLE offload requires the default or dummy model loader, got "
f"{type(loader).__name__}"
)
# Step 4: post-load processing is restricted to CPU-owned PLE modules;
# the remainder of the model is still on meta and must not be visited.
for layer in offload_layers.values():
process_weights_after_loading(layer, model_config, torch.device("cpu"))
if disk_dir is not None:
for layer_name, pname in disk_attached.items():
if f"{layer_name}.{pname}" not in disk_complete_params:
_ple_disk_finalize(layer_name, offload_layers[layer_name],
pname, disk_dir)
self._layers.update(offload_layers)
del model
logger.info("PLE weight loading complete.")
def accept_registrations(
self,
pull_socket: zmq.Socket,
num_workers: int,
) -> None:
"""Receive every local DP/TP worker's IPC and shared-memory buffers."""
logger.info("Waiting for %d GPU worker registration(s) ...", num_workers)
registrations: list[PleOffloadRegistration] = []
for index in range(num_workers):
item = pickle.loads(pull_socket.recv())
if not isinstance(item, PleOffloadRegistration):
raise RuntimeError(
"Expected PleOffloadRegistration during setup, got "
f"{type(item).__name__} ({index + 1}/{num_workers})"
)
registrations.append(item)
logger.info(
"GPU worker %d registered (dp_rank=%d, tp_rank=%d, layers=%s).",
item.worker_id,
item.dp_rank,
item.tp_rank,
sorted(item.gpu_output_buffers),
)
dp_size = self.vllm_config.parallel_config.data_parallel_size
tp_size = self.vllm_config.parallel_config.tensor_parallel_size
if num_workers != dp_size * tp_size:
raise RuntimeError(
f"Expected {dp_size * tp_size} registrations for DP={dp_size}, "
f"TP={tp_size}, got {num_workers}"
)
registrations_by_dp: dict[int, list[PleOffloadRegistration]] = {}
for registration in registrations:
registrations_by_dp.setdefault(registration.dp_rank, []).append(
registration
)
if set(registrations_by_dp) != set(range(dp_size)):
raise RuntimeError(
f"Expected DP ranks {set(range(dp_size))}, "
f"got {set(registrations_by_dp)}"
)
for dp_rank, dp_registrations in registrations_by_dp.items():
tp_ranks = {registration.tp_rank for registration in dp_registrations}
if tp_ranks != set(range(tp_size)):
raise RuntimeError(
f"DP rank {dp_rank} expected TP ranks {set(range(tp_size))}, "
f"got {tp_ranks}"
)
for registration in registrations:
if set(registration.gpu_output_buffers) != set(self.layer_names):
raise RuntimeError(
"Registered PLE layers do not match CPU layers: "
f"registered={sorted(registration.gpu_output_buffers)}, "
f"cpu={sorted(self.layer_names)}"
)
targets_for_dp = self._worker_targets.setdefault(registration.dp_rank, {})
for layer_name, gpu_buffer in registration.gpu_output_buffers.items():
target = PleOffloadOutputTarget(
tp_rank=registration.tp_rank,
gpu_output_buffer=gpu_buffer,
sem=CpuGpuSemaphore.from_ipc_tensor(
registration.sem_flag_tensors[layer_name]
),
copy_stream=torch.cuda.Stream(device=gpu_buffer.device),
)
targets_for_dp.setdefault(layer_name, []).append(target)
# All TP ranks in one DP group receive the same input, so buffers
# registered by TP rank zero are sufficient for that DP rank.
if registration.tp_rank == 0:
self._input_bufs[registration.dp_rank] = PleOffloadInputBuffers(
input_ids_buf=registration.input_ids_buf,
query_start_loc_buf=registration.query_start_loc_buf,
ngram_context_buf=registration.ngram_context_buf,
)
if set(self._input_bufs) != set(range(dp_size)):
raise RuntimeError(
"TP rank zero did not register PLE input buffers for every DP "
f"rank: expected={set(range(dp_size))}, got={set(self._input_bufs)}"
)
config = self.vllm_config.model_config.hf_text_config
max_tokens = self.vllm_config.scheduler_config.max_num_batched_tokens
embedding_dim = int(config.ple_embed_dim)
for dp_rank, layer_targets in self._worker_targets.items():
self._pinned_bufs[dp_rank] = {}
for layer_name, targets in layer_targets.items():
if len(targets) != tp_size:
raise RuntimeError(
f"PLE layer {layer_name} for DP rank {dp_rank} received "
f"{len(targets)} targets, expected {tp_size}"
)
targets.sort(key=lambda target: target.tp_rank)
self._pinned_bufs[dp_rank][layer_name] = torch.empty(
max_tokens,
embedding_dim,
dtype=self._layers[layer_name].get_offload_output_dtype(
self.vllm_config.model_config.dtype
),
pin_memory=True,
)
logger.info(
"Registrations complete (dp_size=%d, tp_size=%d, layers=%s).",
dp_size,
tp_size,
sorted(self.layer_names),
)
@torch.inference_mode()
def busy_loop(
self,
pull_socket: zmq.Socket,
shutdown_event: threading.Event,
) -> None:
"""Decode and batch available requests by DP rank until shutdown."""
logger.info("Busy-loop started.")
poller = zmq.Poller()
poller.register(pull_socket, zmq.POLLIN)
while not shutdown_event.is_set():
if pull_socket not in dict(poller.poll(timeout=100)):
continue
requests = []
try:
requests.append(_PLE_OFFLOAD_REQUEST_DECODER.decode(pull_socket.recv()))
while True:
requests.append(
_PLE_OFFLOAD_REQUEST_DECODER.decode(
pull_socket.recv(zmq.NOBLOCK)
)
)
except zmq.Again:
pass
except msgspec.DecodeError as error:
raise RuntimeError("Unexpected PLE offload request") from error
self._handle_requests(requests)
def _handle_requests(self, requests: list[PleOffloadRequest]) -> None:
"""Run requests layer-first so each DP rank can resume promptly."""
requests_by_dp: dict[int, PleOffloadRequest] = {}
for request in requests:
if request.dp_rank not in self._worker_targets:
logger.warning(
"No PLE output targets for dp_rank=%d; skipping request.",
request.dp_rank,
)
continue
if request.dp_rank in requests_by_dp:
logger.warning(
"Duplicate PLE request for dp_rank=%d; skipping duplicate.",
request.dp_rank,
)
continue
requests_by_dp[request.dp_rank] = request
# Speculative placeholders are not vocabulary IDs. Normalize each DP
# input once before all PLE layers consume the shared buffer.
if self._clamp_input_ids:
for dp_rank, request in requests_by_dp.items():
self._input_bufs[dp_rank].input_ids_buf[
: request.num_tokens
].clamp_min_(0)
for layer_name, layer in self._layers.items():
for dp_rank, request in requests_by_dp.items():
targets = self._worker_targets[dp_rank][layer_name]
# The CPU must not overwrite a GPU output buffer until its
# previous result has been consumed. The GPU runner resets the
# flag after the complete model forward.
for target in targets:
target.copy_stream.synchronize()
target.sem.wait_reset(target.copy_stream)
input_bufs = self._input_bufs[dp_rank]
ngram_context = (
input_bufs.ngram_context_buf[: request.num_reqs]
if input_bufs.ngram_context_buf is not None
else None
)
result = layer.forward_impl(
input_bufs.input_ids_buf[: request.num_tokens],
input_bufs.input_ids_buf[: request.num_tokens],
input_bufs.query_start_loc_buf[: request.num_reqs + 1],
ngram_context,
output_buffer=self._pinned_bufs[dp_rank][layer_name],
)
# The result is identical on every TP rank in this DP group.
# Each copy stream signals only after its DMA completes.
slices = tuple(slice(0, size) for size in result.shape)
for target in targets:
with torch.cuda.stream(target.copy_stream):
target.gpu_output_buffer[slices].copy_(
result[slices], non_blocking=True
)
target.sem.signal(target.copy_stream)
|