|
| 1 | +""" |
| 2 | +Process-level cache for hardware detection and setup. |
| 3 | +
|
| 4 | +Reuses the outcome of the first tracker hardware probe so additional runs on |
| 5 | +the same device (same process) skip repeated powermetrics, cpuinfo, and GPU |
| 6 | +detection work. |
| 7 | +""" |
| 8 | + |
| 9 | +from __future__ import annotations |
| 10 | + |
| 11 | +import threading |
| 12 | +from dataclasses import dataclass, field |
| 13 | +from enum import Enum |
| 14 | +from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple |
| 15 | + |
| 16 | +from codecarbon.core.config import normalize_gpu_ids |
| 17 | + |
| 18 | +if TYPE_CHECKING: |
| 19 | + from codecarbon.core.resource_tracker import ResourceTracker |
| 20 | + |
| 21 | +DEFAULT_RAPL_DIR = "/sys/class/powercap/intel-rapl/subsystem" |
| 22 | + |
| 23 | +CONF_KEYS = ( |
| 24 | + "ram_total_size", |
| 25 | + "cpu_count", |
| 26 | + "cpu_physical_count", |
| 27 | + "cpu_model", |
| 28 | + "gpu_count", |
| 29 | + "gpu_model", |
| 30 | + "gpu_ids", |
| 31 | +) |
| 32 | + |
| 33 | + |
| 34 | +class HardwareKind(str, Enum): |
| 35 | + RAM = "ram" |
| 36 | + CPU = "cpu" |
| 37 | + APPLE_CHIP = "apple_chip" |
| 38 | + GPU = "gpu" |
| 39 | + |
| 40 | + |
| 41 | +_cache_lock = threading.Lock() |
| 42 | +_plans: Dict["_HardwareCacheKey", "_HardwarePlan"] = {} |
| 43 | +_tdp = None |
| 44 | + |
| 45 | + |
| 46 | +@dataclass(frozen=True) |
| 47 | +class _HardwareCacheKey: |
| 48 | + tracking_mode: str |
| 49 | + force_cpu_power: Any |
| 50 | + force_ram_power: Any |
| 51 | + force_mode_cpu_load: bool |
| 52 | + gpu_ids: Any |
| 53 | + rapl_include_dram: bool |
| 54 | + rapl_prefer_psys: bool |
| 55 | + |
| 56 | + |
| 57 | +@dataclass |
| 58 | +class _HardwarePlan: |
| 59 | + ram_tracker: str |
| 60 | + cpu_tracker: str |
| 61 | + gpu_tracker: str |
| 62 | + conf: Dict[str, Any] = field(default_factory=dict) |
| 63 | + hardware_specs: List[Dict[str, Any]] = field(default_factory=list) |
| 64 | + |
| 65 | + |
| 66 | +def _canonical_gpu_ids( |
| 67 | + gpu_ids: Optional[List], |
| 68 | +) -> Optional[Tuple[str, ...]]: |
| 69 | + """Normalize GPU ids to a stable cache-key form (tuple of strings).""" |
| 70 | + if gpu_ids is None: |
| 71 | + return None |
| 72 | + if not isinstance(gpu_ids, (list, tuple)): |
| 73 | + gpu_ids = [gpu_ids] |
| 74 | + normalized = normalize_gpu_ids(list(gpu_ids)) |
| 75 | + if not normalized: |
| 76 | + return None |
| 77 | + return tuple(str(gpu_id) for gpu_id in normalized) |
| 78 | + |
| 79 | + |
| 80 | +def make_key(tracker) -> _HardwareCacheKey: |
| 81 | + return _HardwareCacheKey( |
| 82 | + tracking_mode=tracker._tracking_mode, |
| 83 | + force_cpu_power=tracker._force_cpu_power, |
| 84 | + force_ram_power=tracker._force_ram_power, |
| 85 | + force_mode_cpu_load=bool(tracker._conf.get("force_mode_cpu_load", False)), |
| 86 | + gpu_ids=_canonical_gpu_ids(tracker._gpu_ids), |
| 87 | + rapl_include_dram=bool(tracker._rapl_include_dram), |
| 88 | + rapl_prefer_psys=bool(tracker._rapl_prefer_psys), |
| 89 | + ) |
| 90 | + |
| 91 | + |
| 92 | +def get_cached_tdp(cpu_module): |
| 93 | + """Return a shared cpu.TDP() instance for this process.""" |
| 94 | + global _tdp |
| 95 | + if _tdp is None: |
| 96 | + _tdp = cpu_module.TDP() |
| 97 | + return _tdp |
| 98 | + |
| 99 | + |
| 100 | +def _hardware_kind(hw) -> HardwareKind: |
| 101 | + """Classify hardware without isinstance (safe if modules were reloaded).""" |
| 102 | + name = type(hw).__name__ |
| 103 | + if name == "RAM": |
| 104 | + return HardwareKind.RAM |
| 105 | + if name == "CPU": |
| 106 | + return HardwareKind.CPU |
| 107 | + if name == "AppleSiliconChip": |
| 108 | + return HardwareKind.APPLE_CHIP |
| 109 | + if name == "GPU": |
| 110 | + return HardwareKind.GPU |
| 111 | + raise TypeError(f"Unsupported hardware type for cache: {type(hw)}") |
| 112 | + |
| 113 | + |
| 114 | +def _spec_from_hardware(hw) -> Dict[str, Any]: |
| 115 | + kind = _hardware_kind(hw) |
| 116 | + if kind == HardwareKind.RAM: |
| 117 | + return { |
| 118 | + "kind": kind.value, |
| 119 | + "tracking_mode": hw._tracking_mode, |
| 120 | + "force_ram_power": hw._force_ram_power, |
| 121 | + } |
| 122 | + if kind == HardwareKind.CPU: |
| 123 | + spec: Dict[str, Any] = { |
| 124 | + "kind": kind.value, |
| 125 | + "mode": hw._mode, |
| 126 | + "model": hw._model, |
| 127 | + "tdp": hw._tdp, |
| 128 | + "tracking_mode": hw._tracking_mode, |
| 129 | + "rapl_include_dram": False, |
| 130 | + "rapl_prefer_psys": False, |
| 131 | + } |
| 132 | + if hw._mode == "intel_rapl" and hasattr(hw, "_intel_interface"): |
| 133 | + intel = hw._intel_interface |
| 134 | + spec["rapl_include_dram"] = getattr(intel, "rapl_include_dram", False) |
| 135 | + spec["rapl_prefer_psys"] = getattr(intel, "rapl_prefer_psys", False) |
| 136 | + spec["rapl_dir"] = getattr(intel, "_lin_rapl_dir", DEFAULT_RAPL_DIR) |
| 137 | + return spec |
| 138 | + if kind == HardwareKind.APPLE_CHIP: |
| 139 | + return { |
| 140 | + "kind": kind.value, |
| 141 | + "model": hw._model, |
| 142 | + "chip_part": hw.chip_part, |
| 143 | + } |
| 144 | + if kind == HardwareKind.GPU: |
| 145 | + gpu_ids = _canonical_gpu_ids(hw.gpu_ids) |
| 146 | + return {"kind": kind.value, "gpu_ids": list(gpu_ids) if gpu_ids else None} |
| 147 | + raise TypeError(f"Unsupported hardware type for cache: {type(hw)}") |
| 148 | + |
| 149 | + |
| 150 | +def _hardware_from_spec(spec: Dict[str, Any], output_dir: str): |
| 151 | + from codecarbon.external.hardware import CPU, GPU, AppleSiliconChip |
| 152 | + from codecarbon.external.ram import RAM |
| 153 | + |
| 154 | + try: |
| 155 | + kind = HardwareKind(spec["kind"]) |
| 156 | + except ValueError as exc: |
| 157 | + raise ValueError(f"Unknown hardware spec kind: {spec['kind']}") from exc |
| 158 | + |
| 159 | + if kind == HardwareKind.RAM: |
| 160 | + return RAM( |
| 161 | + tracking_mode=spec["tracking_mode"], |
| 162 | + force_ram_power=spec.get("force_ram_power"), |
| 163 | + ) |
| 164 | + if kind == HardwareKind.CPU: |
| 165 | + return CPU( |
| 166 | + output_dir=output_dir, |
| 167 | + mode=spec["mode"], |
| 168 | + model=spec["model"], |
| 169 | + tdp=spec["tdp"], |
| 170 | + tracking_mode=spec["tracking_mode"], |
| 171 | + rapl_dir=spec.get("rapl_dir", DEFAULT_RAPL_DIR), |
| 172 | + rapl_include_dram=spec.get("rapl_include_dram", False), |
| 173 | + rapl_prefer_psys=spec.get("rapl_prefer_psys", False), |
| 174 | + ) |
| 175 | + if kind == HardwareKind.APPLE_CHIP: |
| 176 | + return AppleSiliconChip( |
| 177 | + output_dir=output_dir, |
| 178 | + model=spec["model"], |
| 179 | + chip_part=spec["chip_part"], |
| 180 | + ) |
| 181 | + if kind == HardwareKind.GPU: |
| 182 | + gpu_ids = _canonical_gpu_ids(spec.get("gpu_ids")) |
| 183 | + return GPU.from_utils(gpu_ids=list(gpu_ids) if gpu_ids else None) |
| 184 | + raise ValueError(f"Unknown hardware spec kind: {kind}") |
| 185 | + |
| 186 | + |
| 187 | +def capture(resource_tracker: "ResourceTracker") -> _HardwarePlan: |
| 188 | + tracker = resource_tracker.tracker |
| 189 | + conf = {k: tracker._conf[k] for k in CONF_KEYS if k in tracker._conf} |
| 190 | + return _HardwarePlan( |
| 191 | + ram_tracker=resource_tracker.ram_tracker, |
| 192 | + cpu_tracker=resource_tracker.cpu_tracker, |
| 193 | + gpu_tracker=resource_tracker.gpu_tracker, |
| 194 | + conf=conf, |
| 195 | + hardware_specs=[_spec_from_hardware(hw) for hw in tracker._hardware], |
| 196 | + ) |
| 197 | + |
| 198 | + |
| 199 | +def apply(resource_tracker: "ResourceTracker", plan: _HardwarePlan) -> None: |
| 200 | + tracker = resource_tracker.tracker |
| 201 | + resource_tracker.ram_tracker = plan.ram_tracker |
| 202 | + resource_tracker.cpu_tracker = plan.cpu_tracker |
| 203 | + resource_tracker.gpu_tracker = plan.gpu_tracker |
| 204 | + tracker._conf.update(plan.conf) |
| 205 | + if "gpu_ids" in plan.conf: |
| 206 | + tracker._gpu_ids = plan.conf["gpu_ids"] |
| 207 | + tracker._hardware = [ |
| 208 | + _hardware_from_spec(spec, tracker._output_dir) for spec in plan.hardware_specs |
| 209 | + ] |
| 210 | + |
| 211 | + |
| 212 | +def get_or_run_setup( |
| 213 | + resource_tracker: "ResourceTracker", |
| 214 | + setup_fn, |
| 215 | +) -> None: |
| 216 | + """Apply cached hardware plan or run full setup once per cache key.""" |
| 217 | + key = make_key(resource_tracker.tracker) |
| 218 | + with _cache_lock: |
| 219 | + plan = _plans.get(key) |
| 220 | + if plan is not None: |
| 221 | + apply(resource_tracker, plan) |
| 222 | + return |
| 223 | + setup_fn() |
| 224 | + _plans[key] = capture(resource_tracker) |
| 225 | + |
| 226 | + |
| 227 | +def clear_cache() -> None: |
| 228 | + """Clear cached plans (for tests).""" |
| 229 | + global _tdp |
| 230 | + import sys |
| 231 | + |
| 232 | + with _cache_lock: |
| 233 | + _plans.clear() |
| 234 | + _tdp = None |
| 235 | + |
| 236 | + for mod_name, clear_fn in ( |
| 237 | + ("codecarbon.core.gpu_nvidia", "clear_nvidia_system_cache"), |
| 238 | + ("codecarbon.core.gpu_amd", "clear_rocm_system_cache"), |
| 239 | + ("codecarbon.core.cpu", "clear_powergadget_cache"), |
| 240 | + ("codecarbon.core.powermetrics", "clear_powermetrics_cache"), |
| 241 | + ): |
| 242 | + mod = sys.modules.get(mod_name) |
| 243 | + if mod is not None: |
| 244 | + getattr(mod, clear_fn)() |
| 245 | + |
| 246 | + if "codecarbon.external.hardware" in sys.modules: |
| 247 | + from codecarbon.external.hardware import clear_cpu_load_prime_cache |
| 248 | + |
| 249 | + clear_cpu_load_prime_cache() |
0 commit comments