virt-manager/virtinst/domain/cputune.py

# Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
#
# This work is licensed under the GNU GPLv2 or later.
# See the COPYING file in the top-level directory.

from ..xmlbuilder import XMLBuilder, XMLProperty, XMLChildProperty


###############
# CPU Pinning #
###############

class _VCPUPin(XMLBuilder):
    """
    Class for generating <cputune> child <vcpupin> XML
    """
    XML_NAME = "vcpupin"
    _XML_PROP_ORDER = ["vcpu", "cpuset"]

    vcpu = XMLProperty("./@vcpu", is_int=True)
    cpuset = XMLProperty("./@cpuset")


class _IOThreadPin(XMLBuilder):
    """
    Class for generating <cputune> child <iothreadpin> XML
    """
    XML_NAME = "iothreadpin"
    _XML_PROP_ORDER = ["iothread", "cpuset"]

    iothread = XMLProperty("./@iothread", is_int=True)
    cpuset = XMLProperty("./@cpuset")


##############
# Scheduling #
##############

class _VCPUSched(XMLBuilder):
    """
    Class for generating <cputune> child <vcpusched> XML
    """
    XML_NAME = "vcpusched"
    _XML_PROP_ORDER = ["vcpus", "scheduler", "priority"]

    vcpus = XMLProperty("./@vcpus")
    scheduler = XMLProperty("./@scheduler")
    priority = XMLProperty("./@priority", is_int=True)


class _IOThreadSched(XMLBuilder):
    """
    Class for generating <cputune> child <iothreadsched> XML
    """
    XML_NAME = "iothreadsched"
    _XML_PROP_ORDER = ["iothreads", "scheduler", "priority"]

    iothreads = XMLProperty("./@iothreads")
    scheduler = XMLProperty("./@scheduler")
    priority = XMLProperty("./@priority", is_int=True)


###########################
# Cache & Memory Tunables #
###########################

class _CacheTuneCache(XMLBuilder):
    """
    Class for generating <cachetune> child <cache> XML
    """
    XML_NAME = "cache"
    _XML_PROP_ORDER = ["id", "level", "type", "size", "unit"]

    id = XMLProperty("./@id", is_int=True)
    level = XMLProperty("./@level", is_int=True)
    type = XMLProperty("./@type")
    size = XMLProperty("./@size", is_int=True)
    unit = XMLProperty("./@unit")


class _CacheTuneMonitor(XMLBuilder):
    """
    Class for generating <cachetune> child <monitor> XML
    """
    XML_NAME = "monitor"
    _XML_PROP_ORDER = ["level", "vcpus"]

    level = XMLProperty("./@level", is_int=True)
    vcpus = XMLProperty("./@vcpus")


class _CacheTune(XMLBuilder):
    """
    Class for generating <cputune> child <cachetune> XML
    """
    XML_NAME = "cachetune"
    _XML_PROP_ORDER = ["vcpus", "caches"]

    vcpus = XMLProperty("./@vcpus")
    caches = XMLChildProperty(_CacheTuneCache)
    monitors = XMLChildProperty(_CacheTuneMonitor)


class _MemoryTuneNode(XMLBuilder):
    """
    Class for generating <memorytune> child <node> XML
    """
    XML_NAME = "node"
    _XML_PROP_ORDER = ["id", "bandwidth"]

    id = XMLProperty("./@id", is_int=True)
    bandwidth = XMLProperty("./@bandwidth", is_int=True)


class _MemoryTune(XMLBuilder):
    """
    Class for generating <cputune> child <memorytune> XML
    """
    XML_NAME = "memorytune"
    _XML_PROP_ORDER = ["vcpus", "nodes"]

    vcpus = XMLProperty("./@vcpus")
    nodes = XMLChildProperty(_MemoryTuneNode)


#########################
# Actual CPUTune domain #
#########################

class DomainCputune(XMLBuilder):
    """
    Class for generating <cputune> XML
    """
    XML_NAME = "cputune"
    _XML_PROP_ORDER = ["shares", "period", "quota", "global_period", "global_quota",
            "emulator_period", "emulator_quota", "iothread_period", "iothread_quota",
            "vcpupins", "emulatorpin_cpuset", "iothreadpins",
            "emulatorsched_scheduler", "emulatorsched_priority", "vcpuscheds", "iothreadscheds",
            "cachetunes", "memorytunes"]

    # Resource quotas
    shares = XMLProperty("./shares", is_int=True)
    period = XMLProperty("./period", is_int=True)
    quota = XMLProperty("./quota", is_int=True)
    global_period = XMLProperty("./global_period", is_int=True)
    global_quota = XMLProperty("./global_quota", is_int=True)
    emulator_period = XMLProperty("./emulator_period", is_int=True)
    emulator_quota = XMLProperty("./emulator_quota", is_int=True)
    iothread_period = XMLProperty("./iothread_period", is_int=True)
    iothread_quota = XMLProperty("./iothread_quota", is_int=True)

    # CPU Pinning
    vcpupins = XMLChildProperty(_VCPUPin)
    emulatorpin_cpuset = XMLProperty("./emulatorpin/@cpuset")
    iothreadpins = XMLChildProperty(_IOThreadPin)

    # Scheduling
    emulatorsched_scheduler = XMLProperty("./emulatorsched/@scheduler")
    emulatorsched_priority = XMLProperty("./emulatorsched/@priority", is_int=True)
    vcpuscheds = XMLChildProperty(_VCPUSched)
    iothreadscheds = XMLChildProperty(_IOThreadSched)

    # Cache & Memory Tunables
    cachetunes = XMLChildProperty(_CacheTune)
    memorytunes = XMLChildProperty(_MemoryTune)