Files
xen/tools/python/xen/xend/XendDomainInfo.py
T
Ewan Mellor 56906a3ab2 [XEND] Fix pygrub when run server-side on a domain with blktap disks.
Equivalent fix to xen-unstable 11706:bf0deb09facd847db87ab59ed377db6eb0f5a3ad.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
2006-10-28 17:45:43 +01:00

1948 lines
65 KiB
Python

#===========================================================================
# This library is free software; you can redistribute it and/or
# modify it under the terms of version 2.1 of the GNU Lesser General Public
# License as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#============================================================================
# Copyright (C) 2004, 2005 Mike Wray <mike.wray@hp.com>
# Copyright (C) 2005, 2006 XenSource Ltd
#============================================================================
"""Representation of a single domain.
Includes support for domain construction, using
open-ended configurations.
Author: Mike Wray <mike.wray@hp.com>
"""
import logging
import time
import threading
import re
import copy
from types import StringTypes
import xen.lowlevel.xc
from xen.util import asserts
from xen.util.blkif import blkdev_uname_to_file
from xen.util import security
from xen.xend import balloon, sxp, uuid, image, arch
from xen.xend import XendRoot, XendNode
from xen.xend.XendBootloader import bootloader
from xen.xend.XendConfig import XendConfig
from xen.xend.XendError import XendError, VmError
from xen.xend.XendDevices import XendDevices
from xen.xend.xenstore.xstransact import xstransact, complete
from xen.xend.xenstore.xsutil import GetDomainPath, IntroduceDomain
from xen.xend.xenstore.xswatch import xswatch
from xen.xend.XendConstants import *
from xen.xend.XendAPIConstants import *
MIGRATE_TIMEOUT = 30.0
xc = xen.lowlevel.xc.xc()
xroot = XendRoot.instance()
log = logging.getLogger("xend.XendDomainInfo")
#log.setLevel(logging.TRACE)
##
# All parameters of VMs that may be configured on-the-fly, or at start-up.
#
VM_CONFIG_PARAMS = [
('name', str),
('on_poweroff', str),
('on_reboot', str),
('on_crash', str),
]
##
# Configuration entries that we expect to round-trip -- be read from the
# config file or xc, written to save-files (i.e. through sxpr), and reused as
# config on restart or restore, all without munging. Some configuration
# entries are munged for backwards compatibility reasons, or because they
# don't come out of xc in the same form as they are specified in the config
# file, so those are handled separately.
ROUNDTRIPPING_CONFIG_ENTRIES = [
('uuid', str),
('vcpus', int),
('vcpu_avail', int),
('cpu_weight', float),
('memory', int),
('shadow_memory', int),
('maxmem', int),
('bootloader', str),
('bootloader_args', str),
('features', str),
('localtime', int),
]
ROUNDTRIPPING_CONFIG_ENTRIES += VM_CONFIG_PARAMS
##
# All entries written to the store. This is VM_CONFIG_PARAMS, plus those
# entries written to the store that cannot be reconfigured on-the-fly.
#
VM_STORE_ENTRIES = [
('uuid', str),
('vcpus', int),
('vcpu_avail', int),
('memory', int),
('shadow_memory', int),
('maxmem', int),
('start_time', float),
('on_xend_start', str),
('on_xend_stop', str),
]
VM_STORE_ENTRIES += VM_CONFIG_PARAMS
#
# There are a number of CPU-related fields:
#
# vcpus: the number of virtual CPUs this domain is configured to use.
# vcpu_avail: a bitmap telling the guest domain whether it may use each of
# its VCPUs. This is translated to
# <dompath>/cpu/<id>/availability = {online,offline} for use
# by the guest domain.
# cpumap: a list of bitmaps, one for each VCPU, giving the physical
# CPUs that that VCPU may use.
# cpu: a configuration setting requesting that VCPU 0 is pinned to
# the specified physical CPU.
#
# vcpus and vcpu_avail settings persist with the VM (i.e. they are persistent
# across save, restore, migrate, and restart). The other settings are only
# specific to the domain, so are lost when the VM moves.
#
def create(config):
"""Creates and start a VM using the supplied configuration.
(called from XMLRPCServer directly)
@param config: A configuration object involving lists of tuples.
@type config: list of lists, eg ['vm', ['image', 'xen.gz']]
@rtype: XendDomainInfo
@return: A up and running XendDomainInfo instance
@raise VmError: Invalid configuration or failure to start.
"""
log.debug("XendDomainInfo.create(%s)", config)
vm = XendDomainInfo(XendConfig(sxp = config))
try:
vm.start()
except:
log.exception('Domain construction failed')
vm.destroy()
raise
return vm
def recreate(info, priv):
"""Create the VM object for an existing domain. The domain must not
be dying, as the paths in the store should already have been removed,
and asking us to recreate them causes problems.
@param xeninfo: Parsed configuration
@type xeninfo: Dictionary
@param priv: TODO, unknown, something to do with memory
@type priv: bool
@rtype: XendDomainInfo
@return: A up and running XendDomainInfo instance
@raise VmError: Invalid configuration.
@raise XendError: Errors with configuration.
"""
log.debug("XendDomainInfo.recreate(%s)", info)
assert not info['dying']
xeninfo = XendConfig(cfg = info)
domid = xeninfo['domid']
uuid1 = xeninfo['handle']
xeninfo['uuid'] = uuid.toString(uuid1)
needs_reinitialising = False
dompath = GetDomainPath(domid)
if not dompath:
raise XendError('No domain path in store for existing '
'domain %d' % domid)
log.info("Recreating domain %d, UUID %s. at %s" %
(domid, xeninfo['uuid'], dompath))
# need to verify the path and uuid if not Domain-0
# if the required uuid and vm aren't set, then that means
# we need to recreate the dom with our own values
#
# NOTE: this is probably not desirable, really we should just
# abort or ignore, but there may be cases where xenstore's
# entry disappears (eg. xenstore-rm /)
#
try:
vmpath = xstransact.Read(dompath, "vm")
if not vmpath:
log.warn('/local/domain/%d/vm is missing. recreate is '
'confused, trying our best to recover' % domid)
needs_reinitialising = True
raise XendError('reinit')
uuid2_str = xstransact.Read(vmpath, "uuid")
if not uuid2_str:
log.warn('%s/uuid/ is missing. recreate is confused, '
'trying our best to recover' % vmpath)
needs_reinitialising = True
raise XendError('reinit')
uuid2 = uuid.fromString(uuid2_str)
if uuid1 != uuid2:
log.warn('UUID in /vm does not match the UUID in /dom/%d.'
'Trying out best to recover' % domid)
needs_reinitialising = True
except XendError:
pass # our best shot at 'goto' in python :)
vm = XendDomainInfo(xeninfo, domid, dompath, augment = True, priv = priv)
if needs_reinitialising:
vm._recreateDom()
vm._removeVm()
vm._storeVmDetails()
vm._storeDomDetails()
vm._registerWatches()
vm._refreshShutdown(xeninfo)
return vm
def restore(config):
"""Create a domain and a VM object to do a restore.
@param config: Domain configuration object
@type config: list of lists. (see C{create})
@rtype: XendDomainInfo
@return: A up and running XendDomainInfo instance
@raise VmError: Invalid configuration or failure to start.
@raise XendError: Errors with configuration.
"""
log.debug("XendDomainInfo.restore(%s)", config)
vm = XendDomainInfo(XendConfig(sxp = config), resume = True)
try:
vm.resume()
except:
vm.destroy()
raise
def createDormant(xeninfo):
"""Create a dormant/inactive XenDomainInfo without creating VM.
This is for creating instances of persistent domains that are not
yet start.
@param xeninfo: Parsed configuration
@type xeninfo: dictionary
@rtype: XendDomainInfo
@return: A up and running XendDomainInfo instance
@raise XendError: Errors with configuration.
"""
log.debug("XendDomainInfo.createDormant(%s)", xeninfo)
# domid does not make sense for non-running domains.
xeninfo.pop('domid', None)
vm = XendDomainInfo(XendConfig(cfg = xeninfo))
return vm
def domain_by_name(name):
"""Get domain by name
@params name: Name of the domain
@type name: string
@return: XendDomainInfo or None
"""
from xen.xend import XendDomain
return XendDomain.instance().domain_lookup_by_name_nr(name)
def shutdown_reason(code):
"""Get a shutdown reason from a code.
@param code: shutdown code
@type code: int
@return: shutdown reason
@rtype: string
"""
return DOMAIN_SHUTDOWN_REASONS.get(code, "?")
def dom_get(dom):
"""Get info from xen for an existing domain.
@param dom: domain id
@type dom: int
@return: info or None
@rtype: dictionary
"""
try:
domlist = xc.domain_getinfo(dom, 1)
if domlist and dom == domlist[0]['domid']:
return domlist[0]
except Exception, err:
# ignore missing domain
log.trace("domain_getinfo(%d) failed, ignoring: %s", dom, str(err))
return None
class XendDomainInfo:
"""An object represents a domain.
@TODO: try to unify dom and domid, they mean the same thing, but
xc refers to it as dom, and everywhere else, including
xenstore it is domid. The best way is to change xc's
python interface.
@ivar info: Parsed configuration
@type info: dictionary
@ivar domid: Domain ID (if VM has started)
@type domid: int or None
@ivar vmpath: XenStore path to this VM.
@type vmpath: string
@ivar dompath: XenStore path to this Domain.
@type dompath: string
@ivar image: Reference to the VM Image.
@type image: xen.xend.image.ImageHandler
@ivar store_port: event channel to xenstored
@type store_port: int
@ivar console_port: event channel to xenconsoled
@type console_port: int
@ivar store_mfn: xenstored mfn
@type store_mfn: int
@ivar console_mfn: xenconsoled mfn
@type console_mfn: int
@ivar vmWatch: reference to a watch on the xenstored vmpath
@type vmWatch: xen.xend.xenstore.xswatch
@ivar shutdownWatch: reference to watch on the xenstored domain shutdown
@type shutdownWatch: xen.xend.xenstore.xswatch
@ivar shutdownStartTime: UNIX Time when domain started shutting down.
@type shutdownStartTime: float or None
@ivar state: Domain state
@type state: enum(DOM_STATE_HALTED, DOM_STATE_RUNNING, ...)
@ivar state_updated: lock for self.state
@type state_updated: threading.Condition
@ivar refresh_shutdown_lock: lock for polling shutdown state
@type refresh_shutdown_lock: threading.Condition
@ivar _deviceControllers: device controller cache for this domain
@type _deviceControllers: dict 'string' to DevControllers
"""
def __init__(self, info, domid = None, dompath = None, augment = False,
priv = False, resume = False):
"""Constructor for a domain
@param info: parsed configuration
@type info: dictionary
@keyword domid: Set initial domain id (if any)
@type domid: int
@keyword dompath: Set initial dompath (if any)
@type dompath: string
@keyword augment: Augment given info with xenstored VM info
@type augment: bool
@keyword priv: Is a privledged domain (Dom 0) (TODO: really?)
@type priv: bool
@keyword resume: Is this domain being resumed?
@type resume: bool
"""
self.info = info
if domid == None:
self.domid = self.info.get('domid')
else:
self.domid = domid
#REMOVE: uuid is now generated in XendConfig
#if not self._infoIsSet('uuid'):
# self.info['uuid'] = uuid.toString(uuid.create())
#REMOVE: domid logic can be shortened
#if domid is not None:
# self.domid = domid
#elif info.has_key('dom'):
# self.domid = int(info['dom'])
#else:
# self.domid = None
self.vmpath = XS_VMROOT + self.info['uuid']
self.dompath = dompath
self.image = None
self.store_port = None
self.store_mfn = None
self.console_port = None
self.console_mfn = None
self.vmWatch = None
self.shutdownWatch = None
self.shutdownStartTime = None
self.state = DOM_STATE_HALTED
self.state_updated = threading.Condition()
self.refresh_shutdown_lock = threading.Condition()
self._deviceControllers = {}
for state in DOM_STATES_OLD:
self.info[state] = 0
if augment:
self._augmentInfo(priv)
self._checkName(self.info['name'])
self.setResume(resume)
#
# Public functions available through XMLRPC
#
def start(self, is_managed = False):
"""Attempts to start the VM by do the appropriate
initialisation if it not started.
"""
from xen.xend import XendDomain
if self.state == DOM_STATE_HALTED:
try:
self._constructDomain()
self._initDomain()
self._storeVmDetails()
self._storeDomDetails()
self._registerWatches()
self._refreshShutdown()
self.unpause()
# save running configuration if XendDomains believe domain is
# persistent
#
if is_managed:
xendomains = XendDomain.instance()
xendomains.managed_config_save(self)
except:
log.exception('VM start failed')
self.destroy()
raise
else:
raise XendError('VM already running')
def resume(self):
"""Resumes a domain that has come back from suspension."""
if self.state in (DOM_STATE_HALTED, DOM_STATE_SUSPENDED):
try:
self._constructDomain()
self._storeVmDetails()
self._createDevices()
self._createChannels()
self._storeDomDetails()
self._endRestore()
except:
log.exception('VM resume failed')
raise
else:
raise XendError('VM already running')
def shutdown(self, reason):
"""Shutdown a domain by signalling this via xenstored."""
log.debug('XendDomainInfo.shutdown')
if self.state in (DOM_STATE_SHUTDOWN, DOM_STATE_HALTED,):
raise XendError('Domain cannot be shutdown')
if not reason in DOMAIN_SHUTDOWN_REASONS.values():
raise XendError('Invalid reason: %s' % reason)
self._storeDom("control/shutdown", reason)
def pause(self):
"""Pause domain
@raise XendError: Failed pausing a domain
"""
try:
xc.domain_pause(self.domid)
self._stateSet(DOM_STATE_PAUSED)
except Exception, ex:
raise XendError("Domain unable to be paused: %s" % str(ex))
def unpause(self):
"""Unpause domain
@raise XendError: Failed unpausing a domain
"""
try:
xc.domain_unpause(self.domid)
self._stateSet(DOM_STATE_RUNNING)
except Exception, ex:
raise XendError("Domain unable to be unpaused: %s" % str(ex))
def send_sysrq(self, key):
""" Send a Sysrq equivalent key via xenstored."""
asserts.isCharConvertible(key)
self._storeDom("control/sysrq", '%c' % key)
def device_create(self, dev_config):
"""Create a new device.
@param dev_config: device configuration
@type dev_config: dictionary (parsed config)
"""
log.debug("XendDomainInfo.device_create: %s" % dev_config)
dev_type = sxp.name(dev_config)
devid = self._createDevice(dev_type, dev_config)
self.info.device_add(dev_type, cfg_sxp = dev_config)
self._waitForDevice(dev_type, devid)
return self.getDeviceController(dev_type).sxpr(devid)
def device_configure(self, dev_config, devid):
"""Configure an existing device.
@param dev_config: device configuration
@type dev_config: dictionary (parsed config)
@param devid: device id
@type devid: int
"""
deviceClass = sxp.name(dev_config)
self._reconfigureDevice(deviceClass, devid, dev_config)
def waitForDevices(self):
"""Wait for this domain's configured devices to connect.
@raise VmError: if any device fails to initialise.
"""
for devclass in XendDevices.valid_devices():
self.getDeviceController(devclass).waitForDevices()
def destroyDevice(self, deviceClass, devid):
try:
devid = int(devid)
except ValueError:
# devid is not a number, let's search for it in xenstore.
devicePath = '%s/device/%s' % (self.dompath, deviceClass)
for entry in xstransact.List(devicePath):
backend = xstransact.Read('%s/%s' % (devicePath, entry),
"backend")
devName = xstransact.Read(backend, "dev")
if devName == devid:
# We found the integer matching our devid, use it instead
devid = entry
break
return self.getDeviceController(deviceClass).destroyDevice(devid)
def getDeviceSxprs(self, deviceClass):
return self.getDeviceController(deviceClass).sxprs()
def setMemoryTarget(self, target):
"""Set the memory target of this domain.
@param target: In MiB.
"""
log.debug("Setting memory target of domain %s (%d) to %d MiB.",
self.info['name'], self.domid, target)
if target <= 0:
raise XendError('Invalid memory size')
self.info['memory'] = target
self.storeVm("memory", target)
self._storeDom("memory/target", target << 10)
def getVCPUInfo(self):
try:
# We include the domain name and ID, to help xm.
sxpr = ['domain',
['domid', self.domid],
['name', self.info['name']],
['vcpu_count', self.info['online_vcpus']]]
for i in range(0, self.info['max_vcpu_id']+1):
info = xc.vcpu_getinfo(self.domid, i)
sxpr.append(['vcpu',
['number', i],
['online', info['online']],
['blocked', info['blocked']],
['running', info['running']],
['cpu_time', info['cpu_time'] / 1e9],
['cpu', info['cpu']],
['cpumap', info['cpumap']]])
return sxpr
except RuntimeError, exn:
raise XendError(str(exn))
#
# internal functions ... TODO: re-categorised
#
def _augmentInfo(self, priv):
"""Augment self.info, as given to us through L{recreate}, with
values taken from the store. This recovers those values known
to xend but not to the hypervisor.
"""
def useIfNeeded(name, val):
if not self._infoIsSet(name) and val is not None:
self.info[name] = val
if priv:
entries = VM_STORE_ENTRIES[:]
entries.remove(('memory', int))
entries.remove(('maxmem', int))
else:
entries = VM_STORE_ENTRIES
entries.append(('image', str))
entries.append(('security', str))
map(lambda x, y: useIfNeeded(x[0], y), entries,
self._readVMDetails(entries))
devices = []
for devclass in XendDevices.valid_devices():
devconfig = self.getDeviceController(devclass).configurations()
if devconfig:
devices.extend(map(lambda conf: (devclass, conf), devconfig))
if not self.info['device'] and devices is not None:
for device in devices:
self.info.device_add(device[0], cfg_sxp = device)
#
# Function to update xenstore /vm/*
#
def _readVm(self, *args):
return xstransact.Read(self.vmpath, *args)
def _writeVm(self, *args):
return xstransact.Write(self.vmpath, *args)
def _removeVm(self, *args):
return xstransact.Remove(self.vmpath, *args)
def _gatherVm(self, *args):
return xstransact.Gather(self.vmpath, *args)
def storeVm(self, *args):
return xstransact.Store(self.vmpath, *args)
#
# Function to update xenstore /dom/*
#
def _readDom(self, *args):
return xstransact.Read(self.dompath, *args)
def _writeDom(self, *args):
return xstransact.Write(self.dompath, *args)
def _removeDom(self, *args):
return xstransact.Remove(self.dompath, *args)
def _storeDom(self, *args):
return xstransact.Store(self.dompath, *args)
def _recreateDom(self):
complete(self.dompath, lambda t: self._recreateDomFunc(t))
def _recreateDomFunc(self, t):
t.remove()
t.mkdir()
t.set_permissions({ 'dom' : self.domid })
def _storeDomDetails(self):
to_store = {
'domid': str(self.domid),
'vm': self.vmpath,
'name': self.info['name'],
'console/limit': str(xroot.get_console_limit() * 1024),
'memory/target': str(self.info['memory'] * 1024)
}
def f(n, v):
if v is not None:
to_store[n] = str(v)
f('console/port', self.console_port)
f('console/ring-ref', self.console_mfn)
f('store/port', self.store_port)
f('store/ring-ref', self.store_mfn)
to_store.update(self._vcpuDomDetails())
log.debug("Storing domain details: %s", to_store)
self._writeDom(to_store)
def _vcpuDomDetails(self):
def availability(n):
if self.info['vcpu_avail'] & (1 << n):
return 'online'
else:
return 'offline'
result = {}
for v in range(0, self.info['vcpus']):
result["cpu/%d/availability" % v] = availability(v)
return result
#
# xenstore watches
#
def _registerWatches(self):
"""Register a watch on this VM's entries in the store, and the
domain's control/shutdown node, so that when they are changed
externally, we keep up to date. This should only be called by {@link
#create}, {@link #recreate}, or {@link #restore}, once the domain's
details have been written, but before the new instance is returned."""
self.vmWatch = xswatch(self.vmpath, self._storeChanged)
self.shutdownWatch = xswatch(self.dompath + '/control/shutdown',
self._handleShutdownWatch)
def _storeChanged(self, _):
log.trace("XendDomainInfo.storeChanged");
changed = False
def f(x, y):
if y is not None and self.info[x[0]] != y:
self.info[x[0]] = y
changed = True
map(f, VM_CONFIG_PARAMS, self._readVMDetails(VM_CONFIG_PARAMS))
im = self._readVm('image')
current_im = self.info['image']
if (im is not None and
(current_im is None or sxp.to_string(current_im) != im)):
self.info['image'] = sxp.from_string(im)
changed = True
if changed:
# Update the domain section of the store, as this contains some
# parameters derived from the VM configuration.
self._storeDomDetails()
return 1
def _handleShutdownWatch(self, _):
log.debug('XendDomainInfo.handleShutdownWatch')
reason = self._readDom('control/shutdown')
if reason and reason != 'suspend':
sst = self._readDom('xend/shutdown_start_time')
now = time.time()
if sst:
self.shutdownStartTime = float(sst)
timeout = float(sst) + SHUTDOWN_TIMEOUT - now
else:
self.shutdownStartTime = now
self._storeDom('xend/shutdown_start_time', now)
timeout = SHUTDOWN_TIMEOUT
log.trace(
"Scheduling refreshShutdown on domain %d in %ds.",
self.domid, timeout)
threading.Timer(timeout, self._refreshShutdown).start()
return True
#
# Public Attributes for the VM
#
def getDomid(self):
return self.domid
def setName(self, name):
self._checkName(name)
self.info['name'] = name
self.storeVm("name", name)
def getName(self):
return self.info['name']
def getDomainPath(self):
return self.dompath
def getStorePort(self):
"""For use only by image.py and XendCheckpoint.py."""
return self.store_port
def getConsolePort(self):
"""For use only by image.py and XendCheckpoint.py"""
return self.console_port
def getFeatures(self):
"""For use only by image.py."""
return self.info['features']
def getVCpuCount(self):
return self.info['vcpus']
def setVCpuCount(self, vcpus):
self.info['vcpu_avail'] = (1 << vcpus) - 1
self.storeVm('vcpu_avail', self.info['vcpu_avail'])
self._writeDom(self._vcpuDomDetails())
def getLabel(self):
return security.get_security_info(self.info, 'label')
def getMemoryTarget(self):
"""Get this domain's target memory size, in KB."""
return self.info['memory'] * 1024
def getResume(self):
return "%s" % self.info['resume']
def setResume(self, state):
self.info['resume'] = state
def getRestartCount(self):
return self._readVm('xend/restart_count')
def _refreshShutdown(self, xeninfo = None):
# If set at the end of this method, a restart is required, with the
# given reason. This restart has to be done out of the scope of
# refresh_shutdown_lock.
restart_reason = None
self.refresh_shutdown_lock.acquire()
try:
if xeninfo is None:
xeninfo = dom_get(self.domid)
if xeninfo is None:
# The domain no longer exists. This will occur if we have
# scheduled a timer to check for shutdown timeouts and the
# shutdown succeeded. It will also occur if someone
# destroys a domain beneath us. We clean up the domain,
# just in case, but we can't clean up the VM, because that
# VM may have migrated to a different domain on this
# machine.
self.cleanupDomain()
self._stateSet(DOM_STATE_HALTED)
return
if xeninfo['dying']:
# Dying means that a domain has been destroyed, but has not
# yet been cleaned up by Xen. This state could persist
# indefinitely if, for example, another domain has some of its
# pages mapped. We might like to diagnose this problem in the
# future, but for now all we do is make sure that it's not us
# holding the pages, by calling cleanupDomain. We can't
# clean up the VM, as above.
self.cleanupDomain()
self._stateSet(DOM_STATE_SHUTDOWN)
return
elif xeninfo['crashed']:
if self._readDom('xend/shutdown_completed'):
# We've seen this shutdown already, but we are preserving
# the domain for debugging. Leave it alone.
return
log.warn('Domain has crashed: name=%s id=%d.',
self.info['name'], self.domid)
if xroot.get_enable_dump():
self.dumpCore()
restart_reason = 'crash'
self._stateSet(DOM_STATE_HALTED)
elif xeninfo['shutdown']:
self._stateSet(DOM_STATE_SHUTDOWN)
if self._readDom('xend/shutdown_completed'):
# We've seen this shutdown already, but we are preserving
# the domain for debugging. Leave it alone.
return
else:
reason = shutdown_reason(xeninfo['shutdown_reason'])
log.info('Domain has shutdown: name=%s id=%d reason=%s.',
self.info['name'], self.domid, reason)
self._clearRestart()
if reason == 'suspend':
self._stateSet(DOM_STATE_SUSPENDED)
# Don't destroy the domain. XendCheckpoint will do
# this once it has finished. However, stop watching
# the VM path now, otherwise we will end up with one
# watch for the old domain, and one for the new.
self._unwatchVm()
elif reason in ['poweroff', 'reboot']:
restart_reason = reason
else:
self.destroy()
elif self.dompath is None:
# We have yet to manage to call introduceDomain on this
# domain. This can happen if a restore is in progress, or has
# failed. Ignore this domain.
pass
else:
# Domain is alive. If we are shutting it down, then check
# the timeout on that, and destroy it if necessary.
self._stateSet(DOM_STATE_RUNNING)
if self.shutdownStartTime:
timeout = (SHUTDOWN_TIMEOUT - time.time() +
self.shutdownStartTime)
if timeout < 0:
log.info(
"Domain shutdown timeout expired: name=%s id=%s",
self.info['name'], self.domid)
self.destroy()
finally:
self.refresh_shutdown_lock.release()
if restart_reason:
self._maybeRestart(restart_reason)
#
# Restart functions - handling whether we come back up on shutdown.
#
def _clearRestart(self):
self._removeDom("xend/shutdown_start_time")
def _maybeRestart(self, reason):
# Dispatch to the correct method based upon the configured on_{reason}
# behaviour.
{"destroy" : self.destroy,
"restart" : self._restart,
"preserve" : self._preserve,
"rename-restart" : self._renameRestart}[self.info['on_' + reason]]()
def _renameRestart(self):
self._restart(True)
def _restart(self, rename = False):
"""Restart the domain after it has exited.
@param rename True if the old domain is to be renamed and preserved,
False if it is to be destroyed.
"""
from xen.xend import XendDomain
self._configureBootloader()
config = self.sxpr()
if self._infoIsSet('cpus') and len(self.info['cpus']) != 0:
config.append(['cpus', reduce(lambda x, y: str(x) + "," + str(y),
self.info['cpus'])])
if self._readVm(RESTART_IN_PROGRESS):
log.error('Xend failed during restart of domain %s. '
'Refusing to restart to avoid loops.',
str(self.domid))
self.destroy()
return
self._writeVm(RESTART_IN_PROGRESS, 'True')
now = time.time()
rst = self._readVm('xend/previous_restart_time')
if rst:
rst = float(rst)
timeout = now - rst
if timeout < MINIMUM_RESTART_TIME:
log.error(
'VM %s restarting too fast (%f seconds since the last '
'restart). Refusing to restart to avoid loops.',
self.info['name'], timeout)
self.destroy()
return
self._writeVm('xend/previous_restart_time', str(now))
try:
if rename:
self._preserveForRestart()
else:
self._unwatchVm()
self.destroyDomain()
# new_dom's VM will be the same as this domain's VM, except where
# the rename flag has instructed us to call preserveForRestart.
# In that case, it is important that we remove the
# RESTART_IN_PROGRESS node from the new domain, not the old one,
# once the new one is available.
new_dom = None
try:
new_dom = XendDomain.instance().domain_create(config)
new_dom.unpause()
rst_cnt = self._readVm('xend/restart_count')
rst_cnt = int(rst_cnt) + 1
self._writeVm('xend/restart_count', str(rst_cnt))
new_dom._removeVm(RESTART_IN_PROGRESS)
except:
if new_dom:
new_dom._removeVm(RESTART_IN_PROGRESS)
new_dom.destroy()
else:
self._removeVm(RESTART_IN_PROGRESS)
raise
except:
log.exception('Failed to restart domain %s.', str(self.domid))
def _preserveForRestart(self):
"""Preserve a domain that has been shut down, by giving it a new UUID,
cloning the VM details, and giving it a new name. This allows us to
keep this domain for debugging, but restart a new one in its place
preserving the restart semantics (name and UUID preserved).
"""
new_uuid = uuid.createString()
new_name = 'Domain-%s' % new_uuid
log.info("Renaming dead domain %s (%d, %s) to %s (%s).",
self.info['name'], self.domid, self.info['uuid'],
new_name, new_uuid)
self._unwatchVm()
self._releaseDevices()
self.info['name'] = new_name
self.info['uuid'] = new_uuid
self.vmpath = XS_VMROOT + new_uuid
self._storeVmDetails()
self._preserve()
def _preserve(self):
log.info("Preserving dead domain %s (%d).", self.info['name'],
self.domid)
self._unwatchVm()
self._storeDom('xend/shutdown_completed', 'True')
self._stateSet(DOM_STATE_HALTED)
#
# Debugging ..
#
def dumpCore(self, corefile = None):
"""Create a core dump for this domain. Nothrow guarantee."""
try:
if not corefile:
this_time = time.strftime("%Y-%m%d-%H%M.%S", time.localtime())
corefile = "/var/xen/dump/%s-%s.%s.core" % (this_time,
self.info['name'], self.domid)
if os.path.isdir(corefile):
raise XendError("Cannot dump core in a directory: %s" %
corefile)
xc.domain_dumpcore(self.domid, corefile)
except RuntimeError, ex:
corefile_incomp = corefile+'-incomplete'
os.rename(corefile, corefile_incomp)
log.exception("XendDomainInfo.dumpCore failed: id = %s name = %s",
self.domid, self.info['name'])
raise XendError("Failed to dump core: %s" % str(ex))
#
# Device creation/deletion functions
#
def _createDevice(self, deviceClass, devConfig):
return self.getDeviceController(deviceClass).createDevice(devConfig)
def _waitForDevice(self, deviceClass, devid):
return self.getDeviceController(deviceClass).waitForDevice(devid)
def _reconfigureDevice(self, deviceClass, devid, devconfig):
return self.getDeviceController(deviceClass).reconfigureDevice(
devid, devconfig)
def _createDevices(self):
"""Create the devices for a vm.
@raise: VmError for invalid devices
"""
for (devclass, config) in self.info.all_devices_sxpr():
log.info("createDevice: %s : %s" % (devclass, config))
self._createDevice(devclass, config)
if self.image:
self.image.createDeviceModel()
def _releaseDevices(self):
"""Release all domain's devices. Nothrow guarantee."""
while True:
t = xstransact("%s/device" % self.dompath)
for devclass in XendDevices.valid_devices():
for dev in t.list(devclass):
try:
t.remove(dev)
except:
# Log and swallow any exceptions in removal --
# there's nothing more we can do.
log.exception(
"Device release failed: %s; %s; %s",
self.info['name'], devclass, dev)
if t.commit():
break
def getDeviceController(self, name):
"""Get the device controller for this domain, and if it
doesn't exist, create it.
@param name: device class name
@type name: string
@rtype: subclass of DevController
"""
if name not in self._deviceControllers:
devController = XendDevices.make_controller(name, self)
if not devController:
raise XendError("Unknown device type: %s" % name)
self._deviceControllers[name] = devController
return self._deviceControllers[name]
#
# Migration functions (public)
#
def testMigrateDevices(self, network, dst):
""" Notify all device about intention of migration
@raise: XendError for a device that cannot be migrated
"""
for (n, c) in self.info.all_devices_sxpr():
rc = self.migrateDevice(n, c, network, dst, DEV_MIGRATE_TEST)
if rc != 0:
raise XendError("Device of type '%s' refuses migration." % n)
def migrateDevices(self, network, dst, step, domName=''):
"""Notify the devices about migration
"""
ctr = 0
try:
for (dev_type, dev_conf) in self.info.all_devices_sxpr():
self.migrateDevice(dev_type, dev_conf, network, dst,
step, domName)
ctr = ctr + 1
except:
for dev_type, dev_conf in self.info.all_devices_sxpr():
if ctr == 0:
step = step - 1
ctr = ctr - 1
self._recoverMigrateDevice(dev_type, dev_conf, network,
dst, step, domName)
raise
def migrateDevice(self, deviceClass, deviceConfig, network, dst,
step, domName=''):
return self.getDeviceController(deviceClass).migrate(deviceConfig,
network, dst, step, domName)
def _recoverMigrateDevice(self, deviceClass, deviceConfig, network,
dst, step, domName=''):
return self.getDeviceController(deviceClass).recover_migrate(
deviceConfig, network, dst, step, domName)
## private:
def _constructDomain(self):
"""Construct the domain.
@raise: VmError on error
"""
log.debug('XendDomainInfo.constructDomain')
self.domid = xc.domain_create(
domid = 0,
ssidref = security.get_security_info(self.info, 'ssidref'),
handle = uuid.fromString(self.info['uuid']))
if self.domid < 0:
raise VmError('Creating domain failed: name=%s' %
self.info['name'])
self.dompath = GetDomainPath(self.domid)
self._recreateDom()
# Set maximum number of vcpus in domain
xc.domain_max_vcpus(self.domid, int(self.info['vcpus']))
def _introduceDomain(self):
assert self.domid is not None
assert self.store_mfn is not None
assert self.store_port is not None
try:
IntroduceDomain(self.domid, self.store_mfn, self.store_port)
except RuntimeError, exn:
raise XendError(str(exn))
def _initDomain(self):
log.debug('XendDomainInfo.initDomain: %s %s',
self.domid,
self.info['cpu_weight'])
# if we have a boot loader but no image, then we need to set things
# up by running the boot loader non-interactively
if self._infoIsSet('bootloader') and not self._infoIsSet('image'):
self._configureBootloader()
if not self._infoIsSet('image'):
raise VmError('Missing image in configuration')
try:
self.image = image.create(self,
self.info['image'],
self.info.all_devices_sxpr())
localtime = self.info.get('localtime', 0)
if localtime is not None and localtime == 1:
xc.domain_set_time_offset(self.domid)
xc.domain_setcpuweight(self.domid, self.info['cpu_weight'])
# repin domain vcpus if a restricted cpus list is provided
# this is done prior to memory allocation to aide in memory
# distribution for NUMA systems.
if self.info['cpus'] is not None and len(self.info['cpus']) > 0:
for v in range(0, self.info['max_vcpu_id']+1):
xc.vcpu_setaffinity(self.domid, v, self.info['cpus'])
# Use architecture- and image-specific calculations to determine
# the various headrooms necessary, given the raw configured
# values.
# reservation, maxmem, memory, and shadow are all in KiB.
reservation = self.image.getRequiredInitialReservation(
self.info['memory'] * 1024)
maxmem = self.image.getRequiredAvailableMemory(
self.info['maxmem'] * 1024)
memory = self.image.getRequiredAvailableMemory(
self.info['memory'] * 1024)
shadow = self.image.getRequiredShadowMemory(
self.info['shadow_memory'] * 1024,
self.info['maxmem'] * 1024)
# Round shadow up to a multiple of a MiB, as shadow_mem_control
# takes MiB and we must not round down and end up under-providing.
shadow = ((shadow + 1023) / 1024) * 1024
# set memory limit
xc.domain_setmaxmem(self.domid, maxmem)
# Make sure there's enough RAM available for the domain
balloon.free(memory + shadow)
# Set up the shadow memory
shadow_cur = xc.shadow_mem_control(self.domid, shadow / 1024)
self.info['shadow_memory'] = shadow_cur
# initial memory reservation
xc.domain_memory_increase_reservation(self.domid, reservation, 0,
0)
self._createChannels()
channel_details = self.image.createImage()
self.store_mfn = channel_details['store_mfn']
if 'console_mfn' in channel_details:
self.console_mfn = channel_details['console_mfn']
self._introduceDomain()
self._createDevices()
if self.info['bootloader']:
self.image.cleanupBootloading()
self.info['start_time'] = time.time()
self._stateSet(DOM_STATE_RUNNING)
except RuntimeError, exn:
log.exception("XendDomainInfo.initDomain: exception occurred")
raise VmError(str(exn))
def cleanupDomain(self):
"""Cleanup domain resources; release devices. Idempotent. Nothrow
guarantee."""
self.refresh_shutdown_lock.acquire()
try:
self.unwatchShutdown()
self._releaseDevices()
if self.image:
try:
self.image.destroy()
except:
log.exception(
"XendDomainInfo.cleanup: image.destroy() failed.")
self.image = None
try:
self._removeDom()
except:
log.exception("Removing domain path failed.")
self.info['dying'] = 0
self.info['shutdown'] = 0
self._stateSet(DOM_STATE_HALTED)
finally:
self.refresh_shutdown_lock.release()
def unwatchShutdown(self):
"""Remove the watch on the domain's control/shutdown node, if any.
Idempotent. Nothrow guarantee. Expects to be protected by the
refresh_shutdown_lock."""
try:
try:
if self.shutdownWatch:
self.shutdownWatch.unwatch()
finally:
self.shutdownWatch = None
except:
log.exception("Unwatching control/shutdown failed.")
def waitForShutdown(self):
self.state_updated.acquire()
try:
while self.state in (DOM_STATE_RUNNING,):
self.state_updated.wait()
finally:
self.state_updated.release()
#
# TODO: recategorise - called from XendCheckpoint
#
def completeRestore(self, store_mfn, console_mfn):
log.debug("XendDomainInfo.completeRestore")
self.store_mfn = store_mfn
self.console_mfn = console_mfn
self._introduceDomain()
self._storeDomDetails()
self._registerWatches()
self._refreshShutdown()
log.debug("XendDomainInfo.completeRestore done")
def _endRestore(self):
self.setResume(False)
#
# VM Destroy
#
def destroy(self):
"""Cleanup VM and destroy domain. Nothrow guarantee."""
log.debug("XendDomainInfo.destroy: domid=%s", str(self.domid))
self._cleanupVm()
if self.dompath is not None:
self.destroyDomain()
def destroyDomain(self):
log.debug("XendDomainInfo.destroyDomain(%s)", str(self.domid))
try:
if self.domid is not None:
xc.domain_destroy(self.domid)
self.domid = None
for state in DOM_STATES_OLD:
self.info[state] = 0
except:
log.exception("XendDomainInfo.destroy: xc.domain_destroy failed.")
self.cleanupDomain()
#
# Channels for xenstore and console
#
def _createChannels(self):
"""Create the channels to the domain.
"""
self.store_port = self._createChannel()
self.console_port = self._createChannel()
def _createChannel(self):
"""Create an event channel to the domain.
"""
try:
return xc.evtchn_alloc_unbound(domid=self.domid, remote_dom=0)
except:
log.exception("Exception in alloc_unbound(%d)", self.domid)
raise
#
# Bootloader configuration
#
def _configureBootloader(self):
"""Run the bootloader if we're configured to do so."""
if not self.info['bootloader']:
return
blcfg = None
# FIXME: this assumes that we want to use the first disk device
for (n, c) in self.info.all_devices_sxpr():
if not n or not c or not(n in ["vbd", "tap"]):
continue
disk = sxp.child_value(c, "uname")
if disk is None:
continue
fn = blkdev_uname_to_file(disk)
blcfg = bootloader(self.info['bootloader'], fn, 1,
self.info['bootloader_args'],
self.info['image'])
break
if blcfg is None:
msg = "Had a bootloader specified, but can't find disk"
log.error(msg)
raise VmError(msg)
self.info['image'] = blcfg
#
# VM Functions
#
def _readVMDetails(self, params):
"""Read the specified parameters from the store.
"""
try:
return self._gatherVm(*params)
except ValueError:
# One of the int/float entries in params has a corresponding store
# entry that is invalid. We recover, because older versions of
# Xend may have put the entry there (memory/target, for example),
# but this is in general a bad situation to have reached.
log.exception(
"Store corrupted at %s! Domain %d's configuration may be "
"affected.", self.vmpath, self.domid)
return []
def _cleanupVm(self):
"""Cleanup VM resources. Idempotent. Nothrow guarantee."""
self._unwatchVm()
try:
self._removeVm()
except:
log.exception("Removing VM path failed.")
def checkLiveMigrateMemory(self):
""" Make sure there's enough memory to migrate this domain """
overhead_kb = 0
if arch.type == "x86":
# 1MB per vcpu plus 4Kib/Mib of RAM. This is higher than
# the minimum that Xen would allocate if no value were given.
overhead_kb = self.info['vcpus'] * 1024 + self.info['maxmem'] * 4
overhead_kb = ((overhead_kb + 1023) / 1024) * 1024
# The domain might already have some shadow memory
overhead_kb -= xc.shadow_mem_control(self.domid) * 1024
if overhead_kb > 0:
balloon.free(overhead_kb)
def _unwatchVm(self):
"""Remove the watch on the VM path, if any. Idempotent. Nothrow
guarantee."""
def testDeviceComplete(self):
""" For Block IO migration safety we must ensure that
the device has shutdown correctly, i.e. all blocks are
flushed to disk
"""
start = time.time()
while True:
test = 0
diff = time.time() - start
for i in self.getDeviceController('vbd').deviceIDs():
test = 1
log.info("Dev %s still active, looping...", i)
time.sleep(0.1)
if test == 0:
break
if diff >= MIGRATE_TIMEOUT:
log.info("Dev still active but hit max loop timeout")
break
def _storeVmDetails(self):
to_store = {}
for k in VM_STORE_ENTRIES:
if self._infoIsSet(k[0]):
to_store[k[0]] = str(self.info[k[0]])
if self._infoIsSet('image'):
to_store['image'] = sxp.to_string(self.info['image'])
if self._infoIsSet('security'):
secinfo = self.info['security']
to_store['security'] = sxp.to_string(secinfo)
for idx in range(0, len(secinfo)):
if secinfo[idx][0] == 'access_control':
to_store['security/access_control'] = sxp.to_string(
[secinfo[idx][1], secinfo[idx][2]])
for aidx in range(1, len(secinfo[idx])):
if secinfo[idx][aidx][0] == 'label':
to_store['security/access_control/label'] = \
secinfo[idx][aidx][1]
if secinfo[idx][aidx][0] == 'policy':
to_store['security/access_control/policy'] = \
secinfo[idx][aidx][1]
if secinfo[idx][0] == 'ssidref':
to_store['security/ssidref'] = str(secinfo[idx][1])
if not self._readVm('xend/restart_count'):
to_store['xend/restart_count'] = str(0)
log.debug("Storing VM details: %s", to_store)
self._writeVm(to_store)
self._setVmPermissions()
def _setVmPermissions(self):
"""Allow the guest domain to read its UUID. We don't allow it to
access any other entry, for security."""
xstransact.SetPermissions('%s/uuid' % self.vmpath,
{ 'dom' : self.domid,
'read' : True,
'write' : False })
#
# Utility functions
#
def _stateSet(self, state):
self.state_updated.acquire()
try:
if self.state != state:
self.state = state
self.state_updated.notifyAll()
finally:
self.state_updated.release()
def _infoIsSet(self, name):
return name in self.info and self.info[name] is not None
def _checkName(self, name):
"""Check if a vm name is valid. Valid names contain alphabetic
characters, digits, or characters in '_-.:/+'.
The same name cannot be used for more than one vm at the same time.
@param name: name
@raise: VmError if invalid
"""
from xen.xend import XendDomain
if name is None or name == '':
raise VmError('Missing VM Name')
if not re.search(r'^[A-Za-z0-9_\-\.\:\/\+]+$', name):
raise VmError('Invalid VM Name')
dom = XendDomain.instance().domain_lookup_nr(name)
if dom and dom != self:
raise VmError("VM name '%s' already exists" % name)
def update(self, info = None, refresh = True):
"""Update with info from xc.domain_getinfo().
"""
log.trace("XendDomainInfo.update(%s) on domain %s", info,
str(self.domid))
if not info:
info = dom_get(self.domid)
if not info:
return
#manually update ssidref / security fields
if security.on() and info.has_key('ssidref'):
if (info['ssidref'] != 0) and self.info.has_key('security'):
security_field = self.info['security']
if not security_field:
#create new security element
self.info.update({'security':
[['ssidref', str(info['ssidref'])]]})
#ssidref field not used any longer
if 'ssidref' in info:
info.pop('ssidref')
# make sure state is reset for info
# TODO: we should eventually get rid of old_dom_states
self.info.update(info)
self.info.validate()
if refresh:
self._refreshShutdown(info)
log.trace("XendDomainInfo.update done on domain %s: %s",
str(self.domid), self.info)
def sxpr(self, ignore_devices = False):
return self.info.get_sxp(domain = self,
ignore_devices = ignore_devices)
# Xen API
# ----------------------------------------------------------------
def get_uuid(self):
return self.info['uuid']
def get_memory_static_max(self):
return self.info['maxmem']
def get_memory_static_min(self):
return self.info['memory']
def get_vcpus_policy(self):
sched_id = xc.sched_id_get()
if sched_id == xen.lowlevel.xc.XEN_SCHEDULER_SEDF:
return 'sedf'
elif sched_id == xen.lowlevel.xc.XEN_SCHEDULER_CREDIT:
return 'credit'
else:
return 'unknown'
def get_vcpus_params(self):
return '' # TODO
def get_power_state(self):
return XEN_API_VM_POWER_STATE[self.state]
def get_tpm_instance(self):
return '' # TODO
def get_tpm_backend(self):
return '' # TODO
def get_bios_boot(self):
return '' # TODO
def get_platform_std_vga(self):
return False
def get_platform_serial(self):
return '' # TODO
def get_platform_localtime(self):
return False # TODO
def get_platform_clock_offset(self):
return False # TODO
def get_platform_enable_audio(self):
return False # TODO
def get_builder(self):
return 'Linux' # TODO
def get_boot_method(self):
bootloader = self.info['bootloader']
if not bootloader or bootloader not in XEN_API_BOOT_TYPE:
return 'kernel_external'
return bootloader
def get_kernel_image(self):
return self.info['kernel_kernel']
def get_kernel_initrd(self):
return self.info['kernel_initrd']
def get_kernel_args(self):
return self.info['kernel_args']
def get_grub_cmdline(self):
return '' # TODO
def get_pci_bus(self):
return 0 # TODO
def get_tools_version(self):
return {} # TODO
def get_other_config(self):
return {} # TODO
def get_on_shutdown(self):
after_shutdown = self.info.get('on_poweroff')
if not after_shutdown or after_shutdown not in XEN_API_ON_NORMAL_EXIT:
return XEN_API_ON_NORMAL_EXIT[-1]
return after_shutdown
def get_on_reboot(self):
after_reboot = self.info.get('on_reboot')
if not after_reboot or after_reboot not in XEN_API_ON_NORMAL_EXIT:
return XEN_API_ON_NORMAL_EXIT[-1]
return after_reboot
def get_on_suspend(self):
after_suspend = self.info.get('on_suspend') # TODO: not supported
if not after_suspend or after_suspend not in XEN_API_ON_NORMAL_EXIT:
return XEN_API_ON_NORMAL_EXIT[-1]
return after_suspend
def get_on_crash(self):
after_crash = self.info.get('on_crash')
if not after_crash or after_crash not in XEN_API_ON_CRASH_BEHAVIOUR:
return XEN_API_ON_CRASH_BEHAVIOUR[0]
return after_crash
def get_dev_config_by_uuid(self, dev_class, dev_uuid):
""" Get's a device configuration either from XendConfig or
from the DevController.
@param dev_class: device class, either, 'vbd' or 'vif'
@param dev_uuid: device UUID
@rtype: dictionary
"""
dev_type_config = self.info['device'].get(dev_uuid)
# shortcut if the domain isn't started because
# the devcontrollers will have no better information
# than XendConfig.
if self.state in (XEN_API_VM_POWER_STATE_HALTED,):
if dev_type_config:
return copy.deepcopy(dev_type_config[1])
return None
# instead of using dev_class, we use the dev_type
# that is from XendConfig.
# This will accomdate 'tap' as well as 'vbd'
dev_type = dev_type_config[0]
controller = self.getDeviceController(dev_type)
if not controller:
return None
all_configs = controller.getAllDeviceConfigurations()
if not all_configs:
return None
dev_config = copy.deepcopy(dev_type_config[1])
for _devid, _devcfg in all_configs.items():
if _devcfg.get('uuid') == dev_uuid:
dev_config.update(_devcfg)
dev_config['id'] = _devid
return dev_config
return dev_config
def get_dev_xenapi_config(self, dev_class, dev_uuid):
config = self.get_dev_config_by_uuid(dev_class, dev_uuid)
if not config:
return {}
config['VM'] = self.get_uuid()
if dev_class == 'vif':
if not config.has_key('name'):
config['name'] = config.get('vifname', '')
if not config.has_key('MAC'):
config['MAC'] = config.get('mac', '')
if not config.has_key('type'):
config['type'] = 'paravirtualised'
if not config.has_key('device'):
devid = config.get('id')
if devid != None:
config['device'] = 'eth%d' % devid
else:
config['device'] = ''
config['network'] = '' # Invalid for Xend
config['MTU'] = 1500 # TODO
config['network_read_kbs'] = 0.0
config['network_write_kbs'] = 0.0
config['IO_bandwidth_incoming_kbs'] = 0.0
config['IO_bandwidth_outgoing_kbs'] = 0.0
if dev_class =='vbd':
config['VDI'] = '' # TODO
config['device'] = config.get('dev', '')
config['driver'] = 'paravirtualised' # TODO
config['image'] = config.get('uname', '')
config['IO_bandwidth_incoming_kbs'] = 0.0
config['IO_bandwidth_outgoing_kbs'] = 0.0
if config['mode'] == 'r':
config['mode'] = 'RO'
else:
config['mode'] = 'RW'
return config
def get_dev_property(self, dev_class, dev_uuid, field):
config = self.get_dev_xenapi_config(dev_class, dev_uuid)
try:
return config[field]
except KeyError:
raise XendError('Invalid property for device: %s' % field)
def get_vcpus_util(self):
# TODO: this returns the total accum cpu time, rather than util
# TODO: spec says that key is int, however, python does not allow
# non-string keys to dictionaries.
vcpu_util = {}
if 'max_vcpu_id' in self.info and self.domid != None:
for i in range(0, self.info['max_vcpu_id']+1):
info = xc.vcpu_getinfo(self.domid, i)
vcpu_util[str(i)] = info['cpu_time']/1000000000.0
return vcpu_util
def get_vifs(self):
return self.info.get('vif_refs', [])
def get_vbds(self):
return self.info.get('vbd_refs', [])
def get_vtpms(self):
return self.info.get('vtpm_refs', [])
def create_vbd(self, xenapi_vbd):
"""Create a VBD device from the passed struct in Xen API format.
@return: uuid of the device
@rtype: string
"""
dev_uuid = self.info.device_add('vbd', cfg_xenapi = xenapi_vbd)
if not dev_uuid:
raise XendError('Failed to create device')
if self.state in (XEN_API_VM_POWER_STATE_RUNNING,):
sxpr = self.info.device_sxpr(dev_uuid)
devid = self.getDeviceController('vbd').createDevice(sxpr)
raise XendError("Device creation failed")
return dev_uuid
def create_vbd_with_vdi(self, xenapi_vbd, vdi_image_path):
"""Create a VBD using a VDI from XendStorageRepository.
@param xenapi_vbd: vbd struct from the Xen API
@param vdi_image_path: VDI UUID
@rtype: string
@return: uuid of the device
"""
xenapi_vbd['image'] = vdi_image_path
log.debug('create_vbd_with_vdi: %s' % xenapi_vbd)
dev_uuid = self.info.device_add('tap', cfg_xenapi = xenapi_vbd)
if not dev_uuid:
raise XendError('Failed to create device')
if self.state in (XEN_API_VM_POWER_STATE_RUNNING,):
sxpr = self.info.device_sxpr(dev_uuid)
devid = self.getDeviceController('tap').createDevice(sxpr)
raise XendError("Device creation failed")
return dev_uuid
def create_vif(self, xenapi_vif):
"""Create VIF device from the passed struct in Xen API format.
@param xenapi_vif: Xen API VIF Struct.
@rtype: string
@return: UUID
"""
dev_uuid = self.info.device_add('vif', cfg_xenapi = xenapi_vif)
if not dev_uuid:
raise XendError('Failed to create device')
if self.state in (DOM_STATE_HALTED,):
sxpr = self.info.device_sxpr(dev_uuid)
devid = self.getDeviceController('vif').createDevice(sxpr)
raise XendError("Device creation failed")
return dev_uuid
def create_vtpm(self, xenapi_vtpm):
"""Create a VTPM device from the passed struct in Xen API format.
@return: uuid of the device
@rtype: string
"""
dev_uuid = self.info.device_add('vtpm', cfg_xenapi = xenapi_vtpm)
if not dev_uuid:
raise XendError('Failed to create device')
if self.state in (DOM_STATE_HALTED,):
sxpr = self.info.device_sxpr(dev_uuid)
devid = self.getDeviceController('vtpm').createDevice(sxpr)
raise XendError("Device creation failed")
return dev_uuid
def has_device(self, dev_class, dev_uuid):
return (dev_uuid in self.info['%s_refs' % dev_class])
"""
def stateChar(name):
if name in self.info:
if self.info[name]:
return name[0]
else:
return '-'
else:
return '?'
state = reduce(lambda x, y: x + y, map(stateChar, DOM_STATES_OLD))
sxpr.append(['state', state])
if self.store_mfn:
sxpr.append(['store_mfn', self.store_mfn])
if self.console_mfn:
sxpr.append(['console_mfn', self.console_mfn])
"""
def __str__(self):
return '<domain id=%s name=%s memory=%s state=%s>' % \
(str(self.domid), self.info['name'],
str(self.info['memory']), DOM_STATES[self.state])
__repr__ = __str__