Files
wehub-resource-sync 7ce4c8e27e
pre-commit / pre-run-check (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:55:37 +08:00

604 lines
21 KiB
Python

# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""NUMA binding utilities for vLLM worker processes.
Adapted in part from SGLang's NUMA helper implementation:
https://github.com/sgl-project/sglang/blob/ba6d54d0f08f82f42b8224908ae2459a496b31b3/python/sglang/srt/utils/numa_utils.py
"""
import ctypes
import logging
import multiprocessing
import os
import subprocess
from contextlib import contextmanager
from functools import cache
from pathlib import Path
from typing import TYPE_CHECKING, NamedTuple
import psutil
from vllm import envs
if TYPE_CHECKING:
from vllm.config import VllmConfig
logger = logging.getLogger(__name__)
_NUMACTL_ARGS_ENV = "_VLLM_INTERNAL_NUMACTL_ARGS"
_NUMACTL_PYTHON_EXECUTABLE_ENV = "_VLLM_INTERNAL_NUMACTL_PYTHON_EXECUTABLE"
@cache
def get_libnuma():
libnuma = None
for libnuma_so in ["libnuma.so", "libnuma.so.1"]:
try:
libnuma = ctypes.CDLL(libnuma_so)
except OSError:
libnuma = None
if libnuma is not None:
break
return libnuma
def _can_set_mempolicy() -> bool:
"""Check whether the current process can use NUMA memory policy syscalls."""
try:
libnuma = get_libnuma()
if libnuma is None or libnuma.numa_available() < 0:
return False
mode = ctypes.c_int()
ret = libnuma.get_mempolicy(
ctypes.byref(mode), None, ctypes.c_ulong(0), None, ctypes.c_ulong(0)
)
return ret == 0
except Exception:
return False
def _is_auto_numa_available() -> bool:
"""Check whether automatic GPU-to-NUMA detection should be attempted."""
from vllm.platforms import current_platform
if not current_platform.is_cuda_alike():
return False
if not os.path.isdir("/sys/devices/system/node/node1"):
return False
try:
process = psutil.Process(os.getpid())
cpu_affinity = process.cpu_affinity()
cpu_count = psutil.cpu_count()
if cpu_count is not None and cpu_affinity != list(range(cpu_count)):
logger.warning(
"CPU affinity is already constrained for this process. "
"Skipping automatic NUMA binding; pass --numa-bind-nodes "
"explicitly to override."
)
return False
except (AttributeError, NotImplementedError, psutil.Error):
pass
if not _can_set_mempolicy():
logger.warning(
"User lacks permission to set NUMA memory policy. "
"Automatic NUMA detection may not work; if you are using Docker, "
"try adding --cap-add SYS_NICE."
)
return False
if not hasattr(current_platform, "get_all_device_numa_nodes"):
logger.warning(
"Platform %s does not support automatic NUMA detection",
type(current_platform).__name__,
)
return False
return True
@cache
def get_auto_numa_nodes() -> list[int] | None:
"""Auto-detect NUMA nodes for all visible GPUs."""
from vllm.platforms import current_platform
if not _is_auto_numa_available():
return None
numa_nodes = current_platform.get_all_device_numa_nodes()
if numa_nodes is not None:
logger.info("Auto-detected NUMA nodes for GPUs: %s", numa_nodes)
return numa_nodes
# PCT (Priority Core Turbo) auto-detection workaround for Granite Rapids
# Xeon SKUs.
#
# Background:
# * The Linux kernel does not expose PCT priority-core membership via any
# unprivileged sysfs path. The official interface
# (/dev/isst_interface, used by `intel-speed-select`) is root-only,
# which is a non-starter in most production deployments (shared
# clusters, prebuilt containers, managed cloud).
# * Even recent stable kernels (e.g. 6.14, March 2025) do not yet
# preferentially schedule work on PCT priority cores, so vLLM cannot
# just "let the scheduler handle it".
#
# Empirical heuristic (DGX B300 / Xeon 6776P, the SKU we measured):
# * /proc/cpuinfo `model name` contains the SKU number.
# * cpu0 is a PCT priority core on these SKUs, so it reports the
# priority-cohort CPPC `highest_perf` (the value matches the SKU's
# "Max PCT core frequency" in 100 MHz units, e.g. 4.6 GHz -> 46).
# * Priority cores within each NUMA node satisfy `cpu_id % S in (0, 1)`
# intersected with the node's cpulist, where `S` is the SKU's logical
# CPUs per priority "group" (= total threads / 8 priority cores; 16 on
# 64-core SKUs, 18 on 72-core SKUs).
#
# SKU table:
# ``_PCT_CAPABLE_SKUS`` maps each known PCT-capable Granite Rapids part
# to a ``_PctSku(highest_perf, priority_stride)`` config:
# * highest_perf is the expected ``acpi_cppc/highest_perf`` on cpu0,
# derived from Intel ARK's "Max PCT core frequency" * 10 (CPPC max
# ratio reports in 100 MHz units).
# * priority_stride is the SKU's "Total Cores" / 4 (= total HT threads
# / 8 priority cores), used in the ``cpu_id % stride`` filter above.
# Values:
# * 6776P - 4.6 GHz, 64C/128T -> (46, 16) measured on DGX B300
# * 6774P - 4.6 GHz, 64C/128T -> (46, 16) per Intel ARK, not measured
# * 6962P - 4.4 GHz, 72C/144T -> (44, 18) per Intel ARK, not measured
# The non-measured SKUs are listed best-effort: the gate fails closed
# (no PCT engagement) if a host's actual highest_perf doesn't match the
# table value, so adding entries is safe. If you have access to a 6962P
# or 6774P box and find a different value or cpu-id pattern, update the
# table below.
#
# This whole block is a stop-gap until the kernel exposes PCT membership
# in an unprivileged way; see the tracking issue linked from the PR.
class _PctSku(NamedTuple):
"""Per-SKU config used by the PCT auto-detection gate."""
highest_perf: int
priority_stride: int
_PCT_CAPABLE_SKUS: dict[str, _PctSku] = {
"6776P": _PctSku(highest_perf=46, priority_stride=16),
"6774P": _PctSku(highest_perf=46, priority_stride=16),
"6962P": _PctSku(highest_perf=44, priority_stride=18),
}
_PCT_HIGHEST_PERF_PATH = "/sys/devices/system/cpu/cpu0/acpi_cppc/highest_perf"
_PROC_CPUINFO_PATH = "/proc/cpuinfo"
def _pct_sku_from_cpuinfo() -> _PctSku | None:
"""Return the ``_PctSku`` config for this host's SKU, or None.
Reads ``/proc/cpuinfo``'s ``model name`` and looks the SKU up in
``_PCT_CAPABLE_SKUS``. Returns ``None`` when the host is not a known
PCT-capable Granite Rapids Xeon (or when ``/proc/cpuinfo`` is
unreadable).
"""
try:
with open(_PROC_CPUINFO_PATH) as f:
for line in f:
if not line.lstrip().lower().startswith("model name"):
continue
for sku, config in _PCT_CAPABLE_SKUS.items():
if sku in line:
return config
except OSError:
return None
return None
@cache
def _pct_sku_config() -> _PctSku | None:
"""Detect a PCT-capable Granite Rapids Xeon with PCT enabled.
See the comment block above ``_PCT_CAPABLE_SKUS`` for the full context
(why we hard-code SKUs, why we read CPPC ``highest_perf``, etc.).
Returns the matching ``_PctSku`` config when both gates hold:
* ``/proc/cpuinfo`` ``model name`` contains an SKU listed in
``_PCT_CAPABLE_SKUS``.
* ``/sys/devices/system/cpu/cpu0/acpi_cppc/highest_perf`` matches
that SKU's expected ``highest_perf``.
Otherwise returns ``None`` and the caller falls back to the default
NUMA-node bind.
"""
sku = _pct_sku_from_cpuinfo()
if sku is None:
return None
try:
with open(_PCT_HIGHEST_PERF_PATH) as f:
actual = int(f.read().strip())
except (OSError, ValueError):
return None
if actual != sku.highest_perf:
return None
return sku
def _get_gpu_index(
parallel_config, local_rank: int, dp_local_rank: int | None = None
) -> int:
"""Compute the physical GPU index used for NUMA lookup."""
if (
parallel_config.distributed_executor_backend not in ("ray", "external_launcher")
and parallel_config.data_parallel_backend != "ray"
and parallel_config.nnodes_within_dp == 1
):
if dp_local_rank is None:
dp_local_rank = parallel_config.data_parallel_rank_local
if dp_local_rank is None:
dp_local_rank = parallel_config.data_parallel_index
tp_pp_world_size = (
parallel_config.pipeline_parallel_size
* parallel_config.tensor_parallel_size
)
return local_rank + dp_local_rank * tp_pp_world_size
return local_rank
def _get_numa_node(parallel_config, gpu_index: int) -> int:
numa_nodes = parallel_config.numa_bind_nodes
if numa_nodes is None:
numa_nodes = get_auto_numa_nodes()
if numa_nodes is None:
raise RuntimeError(
"NUMA binding was requested, but vLLM could not detect the "
"GPU-to-NUMA topology automatically. Pass --numa-bind-nodes "
"explicitly or disable --numa-bind."
)
parallel_config.numa_bind_nodes = numa_nodes
if gpu_index >= len(numa_nodes):
raise ValueError(
f"GPU index {gpu_index} exceeds numa_bind_nodes size {len(numa_nodes)}. "
"Ensure the binding lists cover every visible GPU."
)
return numa_nodes[gpu_index]
def _maybe_get_pct_cpu_binding(numa_nodes: list[int]) -> list[int] | None:
"""Return the union of PCT priority cores across ``numa_nodes`` (or None).
PCT (Priority Core Turbo) lets a subset of cores boost above the rest;
we want workers and the EngineCore on those cores. The Linux kernel does
not expose PCT membership without root, so we use the empirical heuristic
documented above ``_PCT_CAPABLE_SKUS``: priority cores within each NUMA
node satisfy ``cpu_id % stride in (0, 1)`` intersected with the node's
``cpulist``, where ``stride`` is the SKU's logical CPUs per priority
group (16 on 64-core SKUs, 18 on 72-core SKUs). Only triggers on the
SKUs in ``_PCT_CAPABLE_SKUS`` with the expected CPPC ``highest_perf``
signal; on any other host it returns None and the caller falls back to
the default NUMA-node bind.
Returns the sorted CPU ids as a ``list[int]``; the caller is expected
to format them for the chosen tool (e.g. comma-joined for
``numactl --physcpubind``).
"""
sku = _pct_sku_config()
if sku is None:
return None
from vllm.utils.cpu_resource_utils import parse_id_list
stride = sku.priority_stride
union_cpus: set[int] = set()
for numa_node in numa_nodes:
cpulist_path = Path(f"/sys/devices/system/node/node{numa_node}/cpulist")
try:
cpulist_raw = cpulist_path.read_text().strip()
except OSError:
continue
if not cpulist_raw:
continue
try:
node_cpus = parse_id_list(cpulist_raw)
except ValueError:
continue
priority = [cpu for cpu in node_cpus if cpu % stride in (0, 1)]
if not priority:
continue
union_cpus.update(priority)
logger.info(
"Detected PCT-capable Granite Rapids Xeon (stride=%d); "
"NUMA node %d priority cores: %s",
stride,
numa_node,
",".join(str(c) for c in priority),
)
if not union_cpus:
return None
return sorted(union_cpus)
def _get_cpu_binding(
parallel_config, gpu_index: int, numa_nodes: list[int]
) -> str | None:
"""Return the CPU list a process should be pinned to (or None)."""
cpu_bindings = parallel_config.numa_bind_cpus
if cpu_bindings is None:
pct_cpus = _maybe_get_pct_cpu_binding(numa_nodes)
if pct_cpus is None:
return None
return ",".join(str(c) for c in pct_cpus)
if gpu_index >= len(cpu_bindings):
raise ValueError(
f"GPU index {gpu_index} exceeds numa_bind_cpus size "
f"{len(cpu_bindings)}. Ensure the binding lists cover every visible GPU."
)
return cpu_bindings[gpu_index]
def _get_numactl_worker_args(
parallel_config, local_rank: int, dp_local_rank: int | None = None
) -> str:
"""Compute the numactl args for a single TP/PP worker subprocess."""
gpu_index = _get_gpu_index(parallel_config, local_rank, dp_local_rank)
numa_node = _get_numa_node(parallel_config, gpu_index)
cpu_binding = _get_cpu_binding(parallel_config, gpu_index, [numa_node])
if cpu_binding is not None:
logger.info(
"Binding worker subprocess (local_rank=%s, gpu_index=%s) to CPUs %s and NUMA node %s", # noqa: E501
local_rank,
gpu_index,
cpu_binding,
numa_node,
)
return f"--physcpubind={cpu_binding} --membind={numa_node}"
logger.info(
"Binding worker subprocess (local_rank=%s, gpu_index=%s) to NUMA node %s",
local_rank,
gpu_index,
numa_node,
)
return f"--cpunodebind={numa_node} --membind={numa_node}"
def _get_enginecore_numa_nodes(
parallel_config, dp_local_rank: int | None = None
) -> list[int]:
"""Return the sorted, unique NUMA nodes of the EngineCore's DP shard."""
numa_nodes = parallel_config.numa_bind_nodes
if numa_nodes is None:
# Trigger auto-detection (it caches into parallel_config).
_get_numa_node(parallel_config, 0)
numa_nodes = parallel_config.numa_bind_nodes
if (
parallel_config.distributed_executor_backend not in ("ray", "external_launcher")
and parallel_config.data_parallel_backend != "ray"
and parallel_config.nnodes_within_dp == 1
):
if dp_local_rank is None:
dp_local_rank = parallel_config.data_parallel_rank_local
if dp_local_rank is None:
dp_local_rank = parallel_config.data_parallel_index
tp_pp_world_size = (
parallel_config.pipeline_parallel_size
* parallel_config.tensor_parallel_size
)
shard_start = dp_local_rank * tp_pp_world_size
shard_end = min(shard_start + tp_pp_world_size, len(numa_nodes))
shard_indices: range | tuple[int, ...] = range(shard_start, shard_end)
else:
shard_indices = range(len(numa_nodes))
if not shard_indices:
return [numa_nodes[0]]
return sorted({numa_nodes[i] for i in shard_indices})
def _get_numactl_enginecore_args(
parallel_config, local_rank: int, dp_local_rank: int | None = None
) -> str:
"""Compute the numactl args for an EngineCore subprocess.
``--numa-bind-cpus`` is deliberately ignored here: the user provides a
per-worker CPU list, and binding EngineCore to any of those entries
would shrink its ``cpus_allowed`` below the strict-superset that the
workers' ``--physcpubind`` spawns require. We fall back to
``--cpunodebind=<shard nodes>`` instead, which is always a safe
superset. PCT auto-detection still applies when the user did not pass
``--numa-bind-cpus`` (its priority-core union across the shard nodes
is also a safe superset by construction).
"""
shard_nodes = _get_enginecore_numa_nodes(parallel_config, dp_local_rank)
membind_arg = ",".join(str(n) for n in shard_nodes)
pct_cpus = (
None
if parallel_config.numa_bind_cpus is not None
else _maybe_get_pct_cpu_binding(shard_nodes)
)
if pct_cpus is not None:
cpu_binding = ",".join(str(c) for c in pct_cpus)
logger.info(
"Binding EngineCore subprocess (local_rank=%s) to CPUs %s "
"and NUMA nodes %s",
local_rank,
cpu_binding,
membind_arg,
)
return f"--physcpubind={cpu_binding} --membind={membind_arg}"
logger.info(
"Binding EngineCore subprocess (local_rank=%s) to NUMA nodes %s",
local_rank,
membind_arg,
)
return f"--cpunodebind={membind_arg} --membind={membind_arg}"
def _log_numactl_show(label: str) -> bool:
try:
result = subprocess.run(
["numactl", "--show"],
check=True,
capture_output=True,
text=True,
)
except (FileNotFoundError, subprocess.CalledProcessError) as e:
logger.warning("Failed to run `numactl --show` for %s: %s", label, e)
return False
output = result.stdout.strip()
if not output:
logger.warning("`numactl --show` returned no output for %s", label)
return False
summary = ", ".join(line.strip() for line in output.splitlines() if line.strip())
logger.debug("%s affinity: %s", label, summary)
return True
def log_current_affinity_state(label: str) -> None:
"""Log the process's effective NUMA affinity state."""
_log_numactl_show(label)
def _probe_numactl_args(numactl_args: str) -> bool:
"""Whether ``numactl <args> true`` succeeds in this (parent) environment."""
try:
result = subprocess.run(
["numactl", *numactl_args.split(), "true"],
capture_output=True,
timeout=10,
)
except (OSError, subprocess.SubprocessError):
return False
return result.returncode == 0
def _resolve_numactl_args(numactl_args: str) -> str:
"""Drop ``--membind`` if the container rejects it, keeping CPU binding."""
cpu_only = " ".join(
t for t in numactl_args.split() if not t.startswith("--membind=")
)
for candidate in (numactl_args, cpu_only, ""):
if _probe_numactl_args(candidate):
if candidate != numactl_args:
logger.warning(
"numactl args %r rejected; falling back to %r. Add "
"--cap-add SYS_NICE for full NUMA binding.",
numactl_args,
candidate or "no binding",
)
return candidate
return ""
@contextmanager
def configure_subprocess(
vllm_config: "VllmConfig",
local_rank: int,
dp_local_rank: int | None = None,
process_kind: str = "worker",
):
"""Temporarily replace the multiprocessing executable with a numactl wrapper."""
parallel_config = vllm_config.parallel_config
if not parallel_config.numa_bind:
yield
return
if process_kind == "EngineCore":
numactl_args = _get_numactl_enginecore_args(
parallel_config, local_rank, dp_local_rank
)
elif process_kind == "worker":
numactl_args = _get_numactl_worker_args(
parallel_config, local_rank, dp_local_rank
)
else:
raise ValueError(
f"Unknown process_kind {process_kind!r}; expected 'worker' or 'EngineCore'."
)
executable, debug_str = _get_numactl_executable()
numactl_args = _resolve_numactl_args(numactl_args)
if not numactl_args:
# No NUMA binding possible here; launch without the wrapper.
yield
return
python_executable = os.fsdecode(multiprocessing.spawn.get_executable())
with (
_set_numa_wrapper_env(numactl_args, python_executable),
_mp_set_executable(executable, debug_str),
):
yield
def _get_numactl_executable() -> tuple[str, str]:
"""Return the fixed wrapper executable used to launch numactl."""
from shutil import which
if which("numactl") is None:
raise RuntimeError(
"numactl is required for NUMA binding but is not installed or "
"not available on PATH."
)
script_path = Path(__file__).with_name("numa_wrapper.sh")
return str(script_path), f"{script_path} via {_NUMACTL_ARGS_ENV}"
@contextmanager
def _set_numa_wrapper_env(numactl_args: str, python_executable: str):
old_numactl_args = os.environ.get(_NUMACTL_ARGS_ENV)
old_python_executable = os.environ.get(_NUMACTL_PYTHON_EXECUTABLE_ENV)
os.environ[_NUMACTL_ARGS_ENV] = numactl_args
os.environ[_NUMACTL_PYTHON_EXECUTABLE_ENV] = python_executable
try:
yield
finally:
if old_numactl_args is None:
os.environ.pop(_NUMACTL_ARGS_ENV, None)
else:
os.environ[_NUMACTL_ARGS_ENV] = old_numactl_args
if old_python_executable is None:
os.environ.pop(_NUMACTL_PYTHON_EXECUTABLE_ENV, None)
else:
os.environ[_NUMACTL_PYTHON_EXECUTABLE_ENV] = old_python_executable
@contextmanager
def _mp_set_executable(executable: str, debug_str: str):
start_method = envs.VLLM_WORKER_MULTIPROC_METHOD
if start_method != "spawn":
logger.warning(
"NUMA binding requires spawn method but got '%s'. "
"NUMA binding will be ineffective. "
"Set VLLM_WORKER_MULTIPROC_METHOD=spawn to enable NUMA binding.",
start_method,
)
yield
return
old_executable = os.fsdecode(multiprocessing.spawn.get_executable())
multiprocessing.spawn.set_executable(executable)
try:
yield
finally:
assert os.fsdecode(multiprocessing.spawn.get_executable()) == executable, (
"Executable was changed during NUMA binding context: "
f"expected {executable}, got {multiprocessing.spawn.get_executable()}"
)
multiprocessing.spawn.set_executable(old_executable)