Class IntelRAPL

codecarbon/core/cpu.py:393–865

A class to interface Intel's Running Average Power Limit (RAPL) for monitoring CPU power consumption. This class provides methods to set up and read energy consumption data from Intel RAPL files, which are available on Linux systems. It enables the measurement of CPU energy usage o

class IntelRAPL:
    """
    A class to interface Intel's Running Average Power Limit (RAPL) for monitoring CPU power consumption.

    This class provides methods to set up and read energy consumption data from Intel RAPL files,
    which are available on Linux systems.
    It enables the measurement of CPU energy usage over time and provides methods to fetch
    both dynamic and static CPU energy details.

    Attributes:
        _lin_rapl_dir (str): The directory path where Intel RAPL files are located.
        _system (str): The platform of the running system, typically used to ensure compatibility.
        _rapl_files (List[RAPLFile]): A list of RAPLFile objects representing the files to read energy data from.
        _cpu_details (Dict): A dictionary storing the latest CPU energy details.
        _last_mesure (int): Placeholder for storing the last measurement time.
        rapl_include_dram (bool): Whether to include DRAM power in measurements (default: False for complete hardware measurement).
        rapl_prefer_psys (bool): Whether to prefer psys domain over package domains (default: False).
                                When True, uses psys (platform/system) domain which includes CPU + platform components.
                                When False (default), uses package domains which are more reliable and match CPU TDP specs.

    Args:
        rapl_dir (str): Path to RAPL directory (default: "/sys/class/powercap/intel-rapl/subsystem")
        rapl_include_dram (bool): Include DRAM domain for complete hardware measurement (default: False).
                                  Set to False to measure only CPU package power.
        rapl_prefer_psys (bool): Prefer psys (platform) domain over package domains (default: False).
                                Set to True to measure total platform power (CPU + chipset + PCIe).
                                Note: psys can report higher values than CPU TDP and may be less reliable on older systems.

    Methods:
        start():
            Starts monitoring CPU energy consumption.

        get_cpu_details(duration: Time) -> Dict:
            Fetches the CPU energy deltas over a specified duration by reading values from RAPL files.

        get_static_cpu_details() -> Dict:
            Returns the CPU details without recalculating them.

    """

    def __init__(
        self,
        rapl_dir="/sys/class/powercap/intel-rapl/subsystem",
        rapl_include_dram=False,
        rapl_prefer_psys=False,
    ):
        self._lin_rapl_dir = rapl_dir
        self._system = sys.platform.lower()
        self._rapl_files = []
        self.rapl_include_dram = rapl_include_dram
        self.rapl_prefer_psys = rapl_prefer_psys
        self._setup_rapl()
        self._cpu_details: Dict = {}

        self._last_mesure = 0

    def _is_platform_supported(self) -> bool:
        return self._system.startswith("lin")