#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

from dataclasses import dataclass
import typing as ty

from oslo_log import log as logging

import nova.conf
from nova import exception
from nova.i18n import _
from nova import objects
from nova.virt import hardware
from nova.virt.libvirt.cpu import core

LOG = logging.getLogger(__name__)

CONF = nova.conf.CONF


@dataclass
class Core:
    """Class to model a CPU core as reported by sysfs.

    It may be a physical CPU core or a hardware thread on a shared CPU core
    depending on if the system supports SMT.
    """

    # NOTE(sbauza): ident is a mandatory field.
    # The CPU core id/number
    ident: int

    @property
    def online(self) -> bool:
        return core.get_online(self.ident)

    @online.setter
    def online(self, state: bool) -> None:
        if state:
            core.set_online(self.ident)
        else:
            core.set_offline(self.ident)

    def __hash__(self):
        return hash(self.ident)

    def __eq__(self, other):
        return self.ident == other.ident

    def __str__(self):
        return str(self.ident)

    @property
    def governor(self) -> ty.Optional[str]:
        try:
            return core.get_governor(self.ident)
        # NOTE(sbauza): cpufreq/scaling_governor is not enabled for some OS
        # platforms.
        except exception.FileNotFound:
            return None

    def set_high_governor(self) -> None:
        core.set_governor(self.ident, CONF.libvirt.cpu_power_governor_high)

    def set_low_governor(self) -> None:
        core.set_governor(self.ident, CONF.libvirt.cpu_power_governor_low)


class API(object):

    def core(self, i):
        """From a purely functional point of view, there is no need for this
        method. However, we want to test power management in multinode
        scenarios (ex: live migration) in our functional tests. If we
        instantiated the Core class directly in the methods below, the
        functional tests would not be able to distinguish between cores on the
        source and destination hosts. In functional tests we can replace this
        helper method by a stub that returns a fixture, allowing us to maintain
        distinct core power state for each host.

        See also nova.virt.libvirt.driver.LibvirtDriver.cpu_api.
        """
        return Core(i)

    def power_up(self, cpus: ty.Set[int]) -> None:
        if not CONF.libvirt.cpu_power_management:
            return
        cpu_dedicated_set = hardware.get_cpu_dedicated_set_nozero() or set()
        powered_up = set()
        for cpu in cpus:
            if cpu in cpu_dedicated_set:
                pcpu = self.core(cpu)
                if CONF.libvirt.cpu_power_management_strategy == 'cpu_state':
                    pcpu.online = True
                else:
                    pcpu.set_high_governor()
                powered_up.add(str(pcpu))
        LOG.debug("Cores powered up : %s", powered_up)

    def power_up_for_instance(self, instance: objects.Instance) -> None:
        if instance.numa_topology is None:
            return
        pcpus = instance.numa_topology.cpu_pinning.union(
            instance.numa_topology.cpuset_reserved)
        self.power_up(pcpus)

    def power_up_for_migration(
        self, dst_numa_info: objects.LibvirtLiveMigrateNUMAInfo
    ) -> None:
        pcpus = set()
        if 'emulator_pins' in dst_numa_info and dst_numa_info.emulator_pins:
            pcpus = dst_numa_info.emulator_pins
        for pins in dst_numa_info.cpu_pins.values():
            pcpus = pcpus.union(pins)
        self.power_up(pcpus)

    def _power_down(self, cpus: ty.Set[int]) -> None:
        if not CONF.libvirt.cpu_power_management:
            return
        cpu_dedicated_set = hardware.get_cpu_dedicated_set_nozero() or set()
        powered_down = set()
        for cpu in cpus:
            if cpu in cpu_dedicated_set:
                pcpu = self.core(cpu)
                if CONF.libvirt.cpu_power_management_strategy == 'cpu_state':
                    pcpu.online = False
                else:
                    pcpu.set_low_governor()
                powered_down.add(str(pcpu))
        LOG.debug("Cores powered down : %s", powered_down)

    def power_down_for_migration(
        self, dst_numa_info: objects.LibvirtLiveMigrateNUMAInfo
    ) -> None:
        pcpus = set()
        if 'emulator_pins' in dst_numa_info and dst_numa_info.emulator_pins:
            pcpus = dst_numa_info.emulator_pins
        for pins in dst_numa_info.cpu_pins.values():
            pcpus = pcpus.union(pins)
        self._power_down(pcpus)

    def power_down_for_instance(self, instance: objects.Instance) -> None:
        if instance.numa_topology is None:
            return
        pcpus = instance.numa_topology.cpu_pinning.union(
            instance.numa_topology.cpuset_reserved)
        self._power_down(pcpus)

    def power_down_all_dedicated_cpus(self) -> None:
        if not CONF.libvirt.cpu_power_management:
            return

        cpu_dedicated_set = hardware.get_cpu_dedicated_set_nozero() or set()
        for pcpu in cpu_dedicated_set:
            pcpu = self.core(pcpu)
            if CONF.libvirt.cpu_power_management_strategy == 'cpu_state':
                pcpu.online = False
            else:
                pcpu.set_low_governor()
        LOG.debug("Cores powered down : %s", cpu_dedicated_set)

    def validate_all_dedicated_cpus(self) -> None:
        if not CONF.libvirt.cpu_power_management:
            return
        cpu_dedicated_set = hardware.get_cpu_dedicated_set() or set()
        pcpus = []
        for pcpu in cpu_dedicated_set:
            if (pcpu == 0 and
                    CONF.libvirt.cpu_power_management_strategy == 'cpu_state'):
                LOG.warning('CPU0 is in cpu_dedicated_set, '
                            'but it is not eligible for state management '
                            'and will be ignored')
                continue
            # we need to collect the governors strategy and the CPU states
            pcpus.append(self.core(pcpu))
        if CONF.libvirt.cpu_power_management_strategy == 'cpu_state':
            # NOTE(sbauza): offline cores can't have a governor, it returns a
            # DeviceBusy exception.
            governors = set([pcpu.governor for pcpu in pcpus
                             if pcpu.online])
            # all the cores need to have the same governor strategy
            if len(governors) > 1:
                msg = _("All the cores need to have the same governor strategy"
                        "before modifying the CPU states. You can reboot the "
                        "compute node if you prefer.")
                raise exception.InvalidConfiguration(msg)
        elif CONF.libvirt.cpu_power_management_strategy == 'governor':
            cpu_states = set([pcpu.online for pcpu in pcpus])
            # all the cores need to be online
            if False in cpu_states:
                msg = _("All the cores need to be online before modifying the "
                        "governor strategy.")
                raise exception.InvalidConfiguration(msg)
