[PATCH v4 0/5] Improve VM CPU update code
v4: - merged with "Improve VCPU code" patch - grouped similar commits together v3: - included commit "Hot add/remove CPUs on PPC" v2: - patch rebased This patchset refactors part of the code related to updating VM CPUs. I am aware of two tests which are failing with this patchset. They'll be worked on before the final version. Crístian Deives (3): Use locks to prevent concurrent updates to VMs Update VCPU by using libvirt function Check if the VM update params are valid for the current state Crístian Viana (1): Hot add/remove CPUs on PPC Jose Ricardo Ziviani (1): Forbid user to edit CPU value if topology is defined src/kimchi/i18n.py | 6 ++ src/kimchi/mockmodel.py | 48 +++++------- src/kimchi/model/vms.py | 198 +++++++++++++++++++++++++++++++++++++++++++++--- tests/test_rest.py | 3 +- 4 files changed, 215 insertions(+), 40 deletions(-) -- 1.9.1
From: Crístian Deives <cristiandeives@gmail.com> If several users try to update the same VM at the same time, an error may happen due to concurrent access. Define a dictionary containing one lock per each VM, and use it when updating the VM: the lock is acquired before the update operation begins and it is released when the operation finishes (whether by success or failure). Signed-off-by: Crístian Deives <cristiandeives@gmail.com> Signed-off-by: Jose Ricardo Ziviani <joserz@linux.vnet.ibm.com> --- src/kimchi/model/vms.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/src/kimchi/model/vms.py b/src/kimchi/model/vms.py index 8463287..b579712 100644 --- a/src/kimchi/model/vms.py +++ b/src/kimchi/model/vms.py @@ -22,6 +22,7 @@ import lxml.etree as ET import os import random import string +import threading import time import uuid @@ -78,6 +79,9 @@ XPATH_DOMAIN_UUID = '/domain/uuid' XPATH_NUMA_CELL = './cpu/numa/cell' +# key: VM name; value: lock object +vm_locks = {} + class VMsModel(object): def __init__(self, **kargs): @@ -215,10 +219,16 @@ class VMModel(object): self.stats = {} def update(self, name, params): - dom = self.get_vm(name, self.conn) - vm_name, dom = self._static_vm_update(name, dom, params) - self._live_vm_update(dom, params) - return vm_name + lock = vm_locks.get(name) + if lock is None: + lock = threading.Lock() + vm_locks[name] = lock + + with lock: + dom = self.get_vm(name, self.conn) + vm_name, dom = self._static_vm_update(name, dom, params) + self._live_vm_update(dom, params) + return vm_name def clone(self, name): """Clone a virtual machine based on an existing one. -- 1.9.1
From: Crístian Deives <cristiandeives@gmail.com> Currently, the VCPU count is updated by editing the configuration XML (tag: <vcpu>). However, in some cases, editing that tag will only update the maximum VCPU count, not the current one. For example, if the VM has the following XML tag: <vcpu current='2'>8</vcpu> and the user updates the VCPU value to 10, Kimchi will update the XML tag to: <vcpu current='2'>10</vcpu> which is probably not what the user wanted. Use the libvirt function "setVcpusFlags" to update the current and the maximum VCPU values to the one specified by the user. Signed-off-by: Aline Manera <alinefm@linux.vnet.ibm.com> Signed-off-by: Crístian Deives <cristiandeives@gmail.com> Signed-off-by: Jose Ricardo Ziviani <joserz@linux.vnet.ibm.com> --- src/kimchi/i18n.py | 5 +++ src/kimchi/mockmodel.py | 48 ++++++++++----------------- src/kimchi/model/vms.py | 88 +++++++++++++++++++++++++++++++++++++++++++++---- tests/test_rest.py | 3 +- 4 files changed, 107 insertions(+), 37 deletions(-) diff --git a/src/kimchi/i18n.py b/src/kimchi/i18n.py index 1004aa4..ecc10ff 100644 --- a/src/kimchi/i18n.py +++ b/src/kimchi/i18n.py @@ -122,6 +122,11 @@ messages = { "KCHVM0049E": _("Cannot power off %(name)s. Virtual machine is shut off."), "KCHVM0050E": _("Cannot shutdown %(name)s. Virtual machine is shut off."), "KCHVM0051E": _("Cannot reset %(name)s. Virtual machine is already shut off."), + "KCHVM0052E": _("Unable to update the following parameters while the VM is offline: %(params)s"), + "KCHVM0053E": _("Unable to update the following parameters while the VM is online: %(params)s"), + "KCHVM0054E": _("VM '%(vm)s' cannot have more than %(cpus)d CPUs. Please update the CPU value when the VM is not running."), + "KCHVM0055E": _("VM '%(vm)s' cannot have less than %(cpus)d CPUs. Please update the CPU value when the VM is not running."), + "KCHVM0056E": _("Unable to hotplug CPUs. Details: %(err)s"), "KCHVMHDEV0001E": _("VM %(vmid)s does not contain directly assigned host device %(dev_name)s."), "KCHVMHDEV0002E": _("The host device %(dev_name)s is not allowed to directly assign to VM."), diff --git a/src/kimchi/mockmodel.py b/src/kimchi/mockmodel.py index a207a0c..128b819 100644 --- a/src/kimchi/mockmodel.py +++ b/src/kimchi/mockmodel.py @@ -25,6 +25,7 @@ import time import kimchi.model.cpuinfo +from collections import defaultdict from lxml import objectify from lxml.builder import E @@ -58,10 +59,9 @@ storagevolumes.VALID_RAW_CONTENT = ['dos/mbr boot sector', class MockModel(Model): - _mock_vms = {} + _mock_vms = defaultdict(list) _mock_snapshots = {} _XMLDesc = libvirt.virDomain.XMLDesc - _defineXML = libvirt.virConnect.defineXML _undefineDomain = libvirt.virDomain.undefine _libvirt_get_vol_path = LibvirtVMTemplate._get_volume_path @@ -80,7 +80,6 @@ class MockModel(Model): kimchi.model.cpuinfo.get_topo_capabilities = \ MockModel.get_topo_capabilities - libvirt.virConnect.defineXML = MockModel.domainDefineXML libvirt.virDomain.XMLDesc = MockModel.domainXMLDesc libvirt.virDomain.undefine = MockModel.undefineDomain libvirt.virDomain.attachDeviceFlags = MockModel.attachDeviceFlags @@ -123,7 +122,7 @@ class MockModel(Model): imageinfo.probe_image = self._probe_image def reset(self): - MockModel._mock_vms = {} + MockModel._mock_vms = defaultdict(list) MockModel._mock_snapshots = {} self._mock_swupdate = MockSoftwareUpdate() self._mock_repositories = MockRepositories() @@ -158,21 +157,15 @@ class MockModel(Model): return ET.fromstring(xml) @staticmethod - def domainDefineXML(conn, xml): - name = objectify.fromstring(xml).name.text - try: - dom = conn.lookupByName(name) - if not dom.isActive(): - MockModel._mock_vms[name] = xml - except: - pass + def domainXMLDesc(dom, flags=0): + xml = MockModel._XMLDesc(dom, flags) + root = objectify.fromstring(xml) - return MockModel._defineXML(conn, xml) + for dev_xml in MockModel._mock_vms.get(dom.name(), []): + dev = objectify.fromstring(dev_xml) + root.devices.append(dev) - @staticmethod - def domainXMLDesc(dom, flags=0): - return MockModel._mock_vms.get(dom.name(), - MockModel._XMLDesc(dom, flags)) + return ET.tostring(root, encoding="utf-8") @staticmethod def undefineDomain(dom): @@ -183,12 +176,7 @@ class MockModel(Model): @staticmethod def attachDeviceFlags(dom, xml, flags=0): - old_xml = dom.XMLDesc(libvirt.VIR_DOMAIN_XML_SECURE) - root = objectify.fromstring(old_xml) - dev = objectify.fromstring(xml) - root.devices.append(dev) - - MockModel._mock_vms[dom.name()] = ET.tostring(root, encoding="utf-8") + MockModel._mock_vms[dom.name()].append(xml) @staticmethod def _get_device_node(dom, xml): @@ -214,16 +202,16 @@ class MockModel(Model): @staticmethod def detachDeviceFlags(dom, xml, flags=0): - root, dev = MockModel._get_device_node(dom, xml) - root.devices.remove(dev) - - MockModel._mock_vms[dom.name()] = ET.tostring(root, encoding="utf-8") + if xml in MockModel._mock_vms[dom.name()]: + MockModel._mock_vms[dom.name()].remove(xml) @staticmethod def updateDeviceFlags(dom, xml, flags=0): - root, old_dev = MockModel._get_device_node(dom, xml) - root.devices.replace(old_dev, objectify.fromstring(xml)) - MockModel._mock_vms[dom.name()] = ET.tostring(root, encoding="utf-8") + _, old_dev = MockModel._get_device_node(dom, xml) + old_xml = ET.tostring(old_dev, encoding="utf-8") + if old_xml in MockModel._mock_vms[dom.name()]: + MockModel._mock_vms[dom.name()].remove(old_xml) + MockModel._mock_vms[dom.name()].append(xml) @staticmethod def volResize(vol, size, flags=0): diff --git a/src/kimchi/model/vms.py b/src/kimchi/model/vms.py index b579712..96dd273 100644 --- a/src/kimchi/model/vms.py +++ b/src/kimchi/model/vms.py @@ -38,6 +38,7 @@ from kimchi.exception import InvalidOperation, InvalidParameter from kimchi.exception import NotFoundError, OperationFailed from kimchi.kvmusertests import UserTests from kimchi.model.config import CapabilitiesModel +from kimchi.model.cpuinfo import CPUInfoModel from kimchi.model.featuretests import FeatureTests from kimchi.model.tasks import TaskModel from kimchi.model.templates import TemplateModel @@ -63,10 +64,15 @@ DOM_STATE_MAP = {0: 'nostate', 6: 'crashed', 7: 'pmsuspended'} -VM_STATIC_UPDATE_PARAMS = {'name': './name', - 'cpus': './vcpu'} +VM_STATIC_UPDATE_PARAMS = {'name': './name'} VM_LIVE_UPDATE_PARAMS = {} +# update parameters which are updatable when the VM is online +VM_ONLINE_UPDATE_PARAMS = ['graphics', 'groups', 'memory', 'users'] +# update parameters which are updatable when the VM is offline +VM_OFFLINE_UPDATE_PARAMS = ['cpus', 'graphics', 'groups', 'memory', 'name', + 'users'] + XPATH_DOMAIN_DISK = "/domain/devices/disk[@device='disk']/source/@file" XPATH_DOMAIN_DISK_BY_FILE = "./devices/disk[@device='disk']/source[@file='%s']" XPATH_DOMAIN_NAME = '/domain/name' @@ -76,6 +82,7 @@ XPATH_DOMAIN_MAC_BY_ADDRESS = "./devices/interface[@type='network']/"\ XPATH_DOMAIN_MEMORY = '/domain/memory' XPATH_DOMAIN_MEMORY_UNIT = '/domain/memory/@unit' XPATH_DOMAIN_UUID = '/domain/uuid' +XPATH_DOMAIN_DEV_CPU_ID = '/domain/devices/spapr-cpu-socket/@id' XPATH_NUMA_CELL = './cpu/numa/cell' @@ -226,8 +233,20 @@ class VMModel(object): with lock: dom = self.get_vm(name, self.conn) - vm_name, dom = self._static_vm_update(name, dom, params) + + if DOM_STATE_MAP[dom.info()[0]] == 'shutoff': + ext_params = set(params.keys()) - set(VM_OFFLINE_UPDATE_PARAMS) + if len(ext_params) > 0: + raise InvalidParameter('KCHVM0052E', + {'params': ', '.join(ext_params)}) + else: + ext_params = set(params.keys()) - set(VM_ONLINE_UPDATE_PARAMS) + if len(ext_params) > 0: + raise InvalidParameter('KCHVM0053E', + {'params': ', '.join(ext_params)}) + self._live_vm_update(dom, params) + vm_name, dom = self._static_vm_update(name, dom, params) return vm_name def clone(self, name): @@ -751,8 +770,7 @@ class VMModel(object): vcpus = params.get('cpus') if numa_mem == []: if vcpus is None: - vcpus = int(xpath_get_text(xml, - VM_STATIC_UPDATE_PARAMS['cpus'])[0]) + vcpus = int(xpath_get_text(xml, 'vcpu')[0]) cpu = root.find('./cpu') if cpu is None: cpu = get_cpu_xml(vcpus, params['memory'] << 10) @@ -813,6 +831,62 @@ class VMModel(object): if 'memory' in params and dom.isActive(): self._update_memory_live(dom, params) + if DOM_STATE_MAP[dom.info()[0]] == 'shutoff': + try: + # set maximum VCPU count + max_vcpus = self.conn.get().getMaxVcpus('kvm') + dom.setVcpusFlags(max_vcpus, + libvirt.VIR_DOMAIN_AFFECT_CONFIG | + libvirt.VIR_DOMAIN_VCPU_MAXIMUM) + + # set current VCPU count + dom.setVcpusFlags(cpus, libvirt.VIR_DOMAIN_AFFECT_CONFIG) + except libvirt.libvirtError, e: + raise OperationFailed('KCHVM0008E', {'name': dom.name(), + 'err': e.message}) + else: + try: + dev_cpu_ids = xpath_get_text(dom.XMLDesc(0), + XPATH_DOMAIN_DEV_CPU_ID) + vcpu_count = dom.vcpus(libvirt.VIR_DOMAIN_AFFECT_LIVE) + total_cpu_count = vcpu_count + len(dev_cpu_ids) + new_cpu_count = int(params['cpus']) + max_cpu_count = dom.maxVcpus() + + if new_cpu_count > total_cpu_count: # add CPUs + if new_cpu_count > max_cpu_count: + raise InvalidOperation('KCHVM0054E', + {'cpus': max_cpu_count}) + + if len(dev_cpu_ids) == 0: + # there are no CPU devices yet; start from 0 + dev_id = 0 + else: + # there are some CPU devices; + # start from the last ID + 1 + dev_cpu_ids.sort() + dev_id = int(dev_cpu_ids[-1]) + 1 + + for i in xrange(new_cpu_count - total_cpu_count): + xml = E('spapr-cpu-socket', id=str(dev_id)) + dom.attachDevice(etree.tostring(xml)) + dev_id += 1 + elif new_cpu_count < total_cpu_count: # remove CPUs + if new_cpu_count < vcpu_count: + raise InvalidOperation('KCHVM0055E', + {'cpus': vcpu_count}) + + # the CPU IDs must be removed in descending order + dev_cpu_ids.sort(reverse=True) + last_id_idx = total_cpu_count - new_cpu_count + to_remove = dev_cpu_ids[:last_id_idx] + + for dev_id in to_remove: + xml = E('spapr-cpu-socket', id=dev_id) + dom.detachDevice(etree.tostring(xml)) + except (libvirt.libvirtError, ValueError), e: + raise OperationFailed('KCHVM0056E', {'err': e.message}) + def _update_memory_live(self, dom, params): # Check if host supports memory device if not self.caps.mem_hotplug_support: @@ -1011,12 +1085,14 @@ class VMModel(object): else: memory = info[2] >> 10 + cpu_devs = xpath_get_text(dom.XMLDesc(0), XPATH_DOMAIN_DEV_CPU_ID) + return {'name': name, 'state': state, 'stats': res, 'uuid': dom.UUIDString(), 'memory': memory, - 'cpus': info[3], + 'cpus': info[3] + len(cpu_devs), 'screenshot': screenshot, 'icon': icon, # (type, listen, port, passwd, passwdValidTo) diff --git a/tests/test_rest.py b/tests/test_rest.py index 6c5c96d..4b3b026 100644 --- a/tests/test_rest.py +++ b/tests/test_rest.py @@ -154,7 +154,7 @@ class RestTests(unittest.TestCase): req = json.dumps({'cpus': 3}) resp = self.request('/vms/vm-1', req, 'PUT') - self.assertEquals(200, resp.status) + self.assertEquals(400, resp.status) # Check if there is support to memory hotplug, once vm is running resp = self.request('/config/capabilities').read() @@ -168,6 +168,7 @@ class RestTests(unittest.TestCase): req = json.dumps({"graphics": {'passwd': "abcdef"}}) resp = self.request('/vms/vm-1', req, 'PUT') + self.assertEquals(200, resp.status) info = json.loads(resp.read()) self.assertEquals('abcdef', info["graphics"]["passwd"]) self.assertEquals(None, info["graphics"]["passwdValidTo"]) -- 1.9.1
- When a cpu topology is defined, the number of cpus must always be the product of sockets * cores * threads, otherwise libvirt will complain about it. Signed-off-by: Jose Ricardo Ziviani <joserz@linux.vnet.ibm.com> --- src/kimchi/i18n.py | 1 + src/kimchi/model/vms.py | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/src/kimchi/i18n.py b/src/kimchi/i18n.py index ecc10ff..26621a1 100644 --- a/src/kimchi/i18n.py +++ b/src/kimchi/i18n.py @@ -127,6 +127,7 @@ messages = { "KCHVM0054E": _("VM '%(vm)s' cannot have more than %(cpus)d CPUs. Please update the CPU value when the VM is not running."), "KCHVM0055E": _("VM '%(vm)s' cannot have less than %(cpus)d CPUs. Please update the CPU value when the VM is not running."), "KCHVM0056E": _("Unable to hotplug CPUs. Details: %(err)s"), + "KCHVM0057E": _("Cannot change VCPU value because '%(vm)s' has a topology defined - sockets: %(sockets)s, cores: %(cores)s, threads: %(threads)s."), "KCHVMHDEV0001E": _("VM %(vmid)s does not contain directly assigned host device %(dev_name)s."), "KCHVMHDEV0002E": _("The host device %(dev_name)s is not allowed to directly assign to VM."), diff --git a/src/kimchi/model/vms.py b/src/kimchi/model/vms.py index 96dd273..8389694 100644 --- a/src/kimchi/model/vms.py +++ b/src/kimchi/model/vms.py @@ -86,6 +86,8 @@ XPATH_DOMAIN_DEV_CPU_ID = '/domain/devices/spapr-cpu-socket/@id' XPATH_NUMA_CELL = './cpu/numa/cell' +XPATH_TOPOLOGY = './cpu/topology' + # key: VM name; value: lock object vm_locks = {} @@ -832,6 +834,28 @@ class VMModel(object): self._update_memory_live(dom, params) if DOM_STATE_MAP[dom.info()[0]] == 'shutoff': + + # user cannot change vcpu if topology is defined. In this case + # vcpu must always be sockets * cores * threads. + xml = dom.XMLDesc(0) + sockets = xpath_get_text(xml, XPATH_TOPOLOGY + '/@sockets') + cores = xpath_get_text(xml, XPATH_TOPOLOGY + '/@cores') + threads = xpath_get_text(xml, XPATH_TOPOLOGY + '/@threads') + current_vcpu = dom.vcpusFlags(libvirt.VIR_DOMAIN_VCPU_MAXIMUM) + + if sockets and cores and threads: + if current_vcpu != cpus: + raise InvalidOperation('KCHVM0057E', + {'vm': dom.name(), + 'sockets': sockets[0], + 'cores': cores[0], + 'threads': threads[0]}) + + # do not need to update vcpu if the value edit did not + # change + else: + return + try: # set maximum VCPU count max_vcpus = self.conn.get().getMaxVcpus('kvm') -- 1.9.1
Hi Ziviani, I was only able to apply the first patch. Could you, please, rebase the whole patch set and resend? Thanks, Aline Manera On 28/09/2015 10:11, Jose Ricardo Ziviani wrote:
v4: - merged with "Improve VCPU code" patch - grouped similar commits together
v3: - included commit "Hot add/remove CPUs on PPC"
v2: - patch rebased
This patchset refactors part of the code related to updating VM CPUs.
I am aware of two tests which are failing with this patchset. They'll be worked on before the final version.
Crístian Deives (3): Use locks to prevent concurrent updates to VMs Update VCPU by using libvirt function Check if the VM update params are valid for the current state
Crístian Viana (1): Hot add/remove CPUs on PPC
Jose Ricardo Ziviani (1): Forbid user to edit CPU value if topology is defined
src/kimchi/i18n.py | 6 ++ src/kimchi/mockmodel.py | 48 +++++------- src/kimchi/model/vms.py | 198 +++++++++++++++++++++++++++++++++++++++++++++--- tests/test_rest.py | 3 +- 4 files changed, 215 insertions(+), 40 deletions(-)
participants (2)
-
Aline Manera -
Jose Ricardo Ziviani