code.grnet.gr Git - ganeti-local/blob - lib/hypervisor/hv_kvm.py

   1 #
   2 #
   3
   4 # Copyright (C) 2008, 2009, 2010, 2011 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21
  22 """KVM hypervisor
  23
  24 """
  25
  26 import errno
  27 import os
  28 import os.path
  29 import re
  30 import tempfile
  31 import time
  32 import logging
  33 import pwd
  34 import struct
  35 import fcntl
  36 import shutil
  37 import socket
  38 import stat
  39 import StringIO
  40 try:
  41   import affinity   # pylint: disable=F0401
  42 except ImportError:
  43   affinity = None
  44
  45 from ganeti import utils
  46 from ganeti import constants
  47 from ganeti import errors
  48 from ganeti import serializer
  49 from ganeti import objects
  50 from ganeti import uidpool
  51 from ganeti import ssconf
  52 from ganeti.hypervisor import hv_base
  53 from ganeti import netutils
  54 from ganeti.utils import wrapper as utils_wrapper
  55
  56
  57 _KVM_NETWORK_SCRIPT = constants.SYSCONFDIR + "/ganeti/kvm-vif-bridge"
  58 _KVM_START_PAUSED_FLAG = "-S"
  59
  60 # TUN/TAP driver constants, taken from <linux/if_tun.h>
  61 # They are architecture-independent and already hardcoded in qemu-kvm source,
  62 # so we can safely include them here.
  63 TUNSETIFF = 0x400454ca
  64 TUNGETIFF = 0x800454d2
  65 TUNGETFEATURES = 0x800454cf
  66 IFF_TAP = 0x0002
  67 IFF_NO_PI = 0x1000
  68 IFF_VNET_HDR = 0x4000
  69
  70
  71 def _ProbeTapVnetHdr(fd):
  72   """Check whether to enable the IFF_VNET_HDR flag.
  73
  74   To do this, _all_ of the following conditions must be met:
  75    1. TUNGETFEATURES ioctl() *must* be implemented
  76    2. TUNGETFEATURES ioctl() result *must* contain the IFF_VNET_HDR flag
  77    3. TUNGETIFF ioctl() *must* be implemented; reading the kernel code in
  78       drivers/net/tun.c there is no way to test this until after the tap device
  79       has been created using TUNSETIFF, and there is no way to change the
  80       IFF_VNET_HDR flag after creating the interface, catch-22! However both
  81       TUNGETIFF and TUNGETFEATURES were introduced in kernel version 2.6.27,
  82       thus we can expect TUNGETIFF to be present if TUNGETFEATURES is.
  83
  84    @type fd: int
  85    @param fd: the file descriptor of /dev/net/tun
  86
  87   """
  88   req = struct.pack("I", 0)
  89   try:
  90     res = fcntl.ioctl(fd, TUNGETFEATURES, req)
  91   except EnvironmentError:
  92     logging.warning("TUNGETFEATURES ioctl() not implemented")
  93     return False
  94
  95   tunflags = struct.unpack("I", res)[0]
  96   if tunflags & IFF_VNET_HDR:
  97     return True
  98   else:
  99     logging.warning("Host does not support IFF_VNET_HDR, not enabling")
 100     return False
 101
 102
 103 def _OpenTap(vnet_hdr=True):
 104   """Open a new tap device and return its file descriptor.
 105
 106   This is intended to be used by a qemu-type hypervisor together with the -net
 107   tap,fd=<fd> command line parameter.
 108
 109   @type vnet_hdr: boolean
 110   @param vnet_hdr: Enable the VNET Header
 111   @return: (ifname, tapfd)
 112   @rtype: tuple
 113
 114   """
 115   try:
 116     tapfd = os.open("/dev/net/tun", os.O_RDWR)
 117   except EnvironmentError:
 118     raise errors.HypervisorError("Failed to open /dev/net/tun")
 119
 120   flags = IFF_TAP | IFF_NO_PI
 121
 122   if vnet_hdr and _ProbeTapVnetHdr(tapfd):
 123     flags |= IFF_VNET_HDR
 124
 125   # The struct ifreq ioctl request (see netdevice(7))
 126   ifr = struct.pack("16sh", "", flags)
 127
 128   try:
 129     res = fcntl.ioctl(tapfd, TUNSETIFF, ifr)
 130   except EnvironmentError:
 131     raise errors.HypervisorError("Failed to allocate a new TAP device")
 132
 133   # Get the interface name from the ioctl
 134   ifname = struct.unpack("16sh", res)[0].strip("\x00")
 135   return (ifname, tapfd)
 136
 137
 138 class QmpMessage:
 139   """QEMU Messaging Protocol (QMP) message.
 140
 141   """
 142   def __init__(self, data):
 143     """Creates a new QMP message based on the passed data.
 144
 145     """
 146     if not isinstance(data, dict):
 147       raise TypeError("QmpMessage must be initialized with a dict")
 148
 149     self.data = data
 150
 151   def __getitem__(self, field_name):
 152     """Get the value of the required field if present, or None.
 153
 154     Overrides the [] operator to provide access to the message data,
 155     returning None if the required item is not in the message
 156     @return: the value of the field_name field, or None if field_name
 157              is not contained in the message
 158
 159     """
 160     return self.data.get(field_name, None)
 161
 162   def __setitem__(self, field_name, field_value):
 163     """Set the value of the required field_name to field_value.
 164
 165     """
 166     self.data[field_name] = field_value
 167
 168   @staticmethod
 169   def BuildFromJsonString(json_string):
 170     """Build a QmpMessage from a JSON encoded string.
 171
 172     @type json_string: str
 173     @param json_string: JSON string representing the message
 174     @rtype: L{QmpMessage}
 175     @return: a L{QmpMessage} built from json_string
 176
 177     """
 178     # Parse the string
 179     data = serializer.LoadJson(json_string)
 180     return QmpMessage(data)
 181
 182   def __str__(self):
 183     # The protocol expects the JSON object to be sent as a single line.
 184     return serializer.DumpJson(self.data)
 185
 186   def __eq__(self, other):
 187     # When comparing two QmpMessages, we are interested in comparing
 188     # their internal representation of the message data
 189     return self.data == other.data
 190
 191
 192 class QmpConnection:
 193   """Connection to the QEMU Monitor using the QEMU Monitor Protocol (QMP).
 194
 195   """
 196   _FIRST_MESSAGE_KEY = "QMP"
 197   _EVENT_KEY = "event"
 198   _ERROR_KEY = "error"
 199   _RETURN_KEY = RETURN_KEY = "return"
 200   _ACTUAL_KEY = ACTUAL_KEY = "actual"
 201   _ERROR_CLASS_KEY = "class"
 202   _ERROR_DATA_KEY = "data"
 203   _ERROR_DESC_KEY = "desc"
 204   _EXECUTE_KEY = "execute"
 205   _ARGUMENTS_KEY = "arguments"
 206   _CAPABILITIES_COMMAND = "qmp_capabilities"
 207   _MESSAGE_END_TOKEN = "\r\n"
 208   _SOCKET_TIMEOUT = 5
 209
 210   def __init__(self, monitor_filename):
 211     """Instantiates the QmpConnection object.
 212
 213     @type monitor_filename: string
 214     @param monitor_filename: the filename of the UNIX raw socket on which the
 215                              QMP monitor is listening
 216
 217     """
 218     self.monitor_filename = monitor_filename
 219     self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
 220     # We want to fail if the server doesn't send a complete message
 221     # in a reasonable amount of time
 222     self.sock.settimeout(self._SOCKET_TIMEOUT)
 223     self._connected = False
 224     self._buf = ""
 225
 226   def _check_socket(self):
 227     sock_stat = None
 228     try:
 229       sock_stat = os.stat(self.monitor_filename)
 230     except EnvironmentError, err:
 231       if err.errno == errno.ENOENT:
 232         raise errors.HypervisorError("No qmp socket found")
 233       else:
 234         raise errors.HypervisorError("Error checking qmp socket: %s",
 235                                      utils.ErrnoOrStr(err))
 236     if not stat.S_ISSOCK(sock_stat.st_mode):
 237       raise errors.HypervisorError("Qmp socket is not a socket")
 238
 239   def _check_connection(self):
 240     """Make sure that the connection is established.
 241
 242     """
 243     if not self._connected:
 244       raise errors.ProgrammerError("To use a QmpConnection you need to first"
 245                                    " invoke connect() on it")
 246
 247   def connect(self):
 248     """Connects to the QMP monitor.
 249
 250     Connects to the UNIX socket and makes sure that we can actually send and
 251     receive data to the kvm instance via QMP.
 252
 253     @raise errors.HypervisorError: when there are communication errors
 254     @raise errors.ProgrammerError: when there are data serialization errors
 255
 256     """
 257     if self._connected:
 258       raise errors.ProgrammerError("Cannot connect twice")
 259
 260     self._check_socket()
 261
 262     # Check file existance/stuff
 263     try:
 264       self.sock.connect(self.monitor_filename)
 265     except EnvironmentError:
 266       raise errors.HypervisorError("Can't connect to qmp socket")
 267     self._connected = True
 268
 269     # Check if we receive a correct greeting message from the server
 270     # (As per the QEMU Protocol Specification 0.1 - section 2.2)
 271     greeting = self._Recv()
 272     if not greeting[self._FIRST_MESSAGE_KEY]:
 273       self._connected = False
 274       raise errors.HypervisorError("kvm: qmp communication error (wrong"
 275                                    " server greeting")
 276
 277     # Let's put the monitor in command mode using the qmp_capabilities
 278     # command, or else no command will be executable.
 279     # (As per the QEMU Protocol Specification 0.1 - section 4)
 280     self.Execute(self._CAPABILITIES_COMMAND)
 281
 282   def _ParseMessage(self, buf):
 283     """Extract and parse a QMP message from the given buffer.
 284
 285     Seeks for a QMP message in the given buf. If found, it parses it and
 286     returns it together with the rest of the characters in the buf.
 287     If no message is found, returns None and the whole buffer.
 288
 289     @raise errors.ProgrammerError: when there are data serialization errors
 290
 291     """
 292     message = None
 293     # Check if we got the message end token (CRLF, as per the QEMU Protocol
 294     # Specification 0.1 - Section 2.1.1)
 295     pos = buf.find(self._MESSAGE_END_TOKEN)
 296     if pos >= 0:
 297       try:
 298         message = QmpMessage.BuildFromJsonString(buf[:pos + 1])
 299       except Exception, err:
 300         raise errors.ProgrammerError("QMP data serialization error: %s" % err)
 301       buf = buf[pos + 1:]
 302
 303     return (message, buf)
 304
 305   def _Recv(self):
 306     """Receives a message from QMP and decodes the received JSON object.
 307
 308     @rtype: QmpMessage
 309     @return: the received message
 310     @raise errors.HypervisorError: when there are communication errors
 311     @raise errors.ProgrammerError: when there are data serialization errors
 312
 313     """
 314     self._check_connection()
 315
 316     # Check if there is already a message in the buffer
 317     (message, self._buf) = self._ParseMessage(self._buf)
 318     if message:
 319       return message
 320
 321     recv_buffer = StringIO.StringIO(self._buf)
 322     recv_buffer.seek(len(self._buf))
 323     try:
 324       while True:
 325         data = self.sock.recv(4096)
 326         if not data:
 327           break
 328         recv_buffer.write(data)
 329
 330         (message, self._buf) = self._ParseMessage(recv_buffer.getvalue())
 331         if message:
 332           return message
 333
 334     except socket.timeout, err:
 335       raise errors.HypervisorError("Timeout while receiving a QMP message: "
 336                                    "%s" % (err))
 337     except socket.error, err:
 338       raise errors.HypervisorError("Unable to receive data from KVM using the"
 339                                    " QMP protocol: %s" % err)
 340
 341   def _Send(self, message):
 342     """Encodes and sends a message to KVM using QMP.
 343
 344     @type message: QmpMessage
 345     @param message: message to send to KVM
 346     @raise errors.HypervisorError: when there are communication errors
 347     @raise errors.ProgrammerError: when there are data serialization errors
 348
 349     """
 350     self._check_connection()
 351     try:
 352       message_str = str(message)
 353     except Exception, err:
 354       raise errors.ProgrammerError("QMP data deserialization error: %s" % err)
 355
 356     try:
 357       self.sock.sendall(message_str)
 358     except socket.timeout, err:
 359       raise errors.HypervisorError("Timeout while sending a QMP message: "
 360                                    "%s (%s)" % (err.string, err.errno))
 361     except socket.error, err:
 362       raise errors.HypervisorError("Unable to send data from KVM using the"
 363                                    " QMP protocol: %s" % err)
 364
 365   def Execute(self, command, arguments=None):
 366     """Executes a QMP command and returns the response of the server.
 367
 368     @type command: str
 369     @param command: the command to execute
 370     @type arguments: dict
 371     @param arguments: dictionary of arguments to be passed to the command
 372     @rtype: dict
 373     @return: dictionary representing the received JSON object
 374     @raise errors.HypervisorError: when there are communication errors
 375     @raise errors.ProgrammerError: when there are data serialization errors
 376
 377     """
 378     self._check_connection()
 379     message = QmpMessage({self._EXECUTE_KEY: command})
 380     if arguments:
 381       message[self._ARGUMENTS_KEY] = arguments
 382     self._Send(message)
 383
 384     # Events can occur between the sending of the command and the reception
 385     # of the response, so we need to filter out messages with the event key.
 386     while True:
 387       response = self._Recv()
 388       err = response[self._ERROR_KEY]
 389       if err:
 390         raise errors.HypervisorError("kvm: error executing the %s"
 391                                      " command: %s (%s, %s):" %
 392                                      (command,
 393                                       err[self._ERROR_DESC_KEY],
 394                                       err[self._ERROR_CLASS_KEY],
 395                                       err[self._ERROR_DATA_KEY]))
 396
 397       elif not response[self._EVENT_KEY]:
 398         return response
 399
 400
 401 class KVMHypervisor(hv_base.BaseHypervisor):
 402   """KVM hypervisor interface
 403
 404   """
 405   CAN_MIGRATE = True
 406
 407   _ROOT_DIR = constants.RUN_GANETI_DIR + "/kvm-hypervisor"
 408   _PIDS_DIR = _ROOT_DIR + "/pid" # contains live instances pids
 409   _UIDS_DIR = _ROOT_DIR + "/uid" # contains instances reserved uids
 410   _CTRL_DIR = _ROOT_DIR + "/ctrl" # contains instances control sockets
 411   _CONF_DIR = _ROOT_DIR + "/conf" # contains instances startup data
 412   _NICS_DIR = _ROOT_DIR + "/nic" # contains instances nic <-> tap associations
 413   _KEYMAP_DIR = _ROOT_DIR + "/keymap" # contains instances keymaps
 414   # KVM instances with chroot enabled are started in empty chroot directories.
 415   _CHROOT_DIR = _ROOT_DIR + "/chroot" # for empty chroot directories
 416   # After an instance is stopped, its chroot directory is removed.
 417   # If the chroot directory is not empty, it can't be removed.
 418   # A non-empty chroot directory indicates a possible security incident.
 419   # To support forensics, the non-empty chroot directory is quarantined in
 420   # a separate directory, called 'chroot-quarantine'.
 421   _CHROOT_QUARANTINE_DIR = _ROOT_DIR + "/chroot-quarantine"
 422   _DIRS = [_ROOT_DIR, _PIDS_DIR, _UIDS_DIR, _CTRL_DIR, _CONF_DIR, _NICS_DIR,
 423            _CHROOT_DIR, _CHROOT_QUARANTINE_DIR]
 424
 425   PARAMETERS = {
 426     constants.HV_KERNEL_PATH: hv_base.OPT_FILE_CHECK,
 427     constants.HV_INITRD_PATH: hv_base.OPT_FILE_CHECK,
 428     constants.HV_ROOT_PATH: hv_base.NO_CHECK,
 429     constants.HV_KERNEL_ARGS: hv_base.NO_CHECK,
 430     constants.HV_ACPI: hv_base.NO_CHECK,
 431     constants.HV_SERIAL_CONSOLE: hv_base.NO_CHECK,
 432     constants.HV_VNC_BIND_ADDRESS:
 433       (False, lambda x: (netutils.IP4Address.IsValid(x) or
 434                          utils.IsNormAbsPath(x)),
 435        "the VNC bind address must be either a valid IP address or an absolute"
 436        " pathname", None, None),
 437     constants.HV_VNC_TLS: hv_base.NO_CHECK,
 438     constants.HV_VNC_X509: hv_base.OPT_DIR_CHECK,
 439     constants.HV_VNC_X509_VERIFY: hv_base.NO_CHECK,
 440     constants.HV_VNC_PASSWORD_FILE: hv_base.OPT_FILE_CHECK,
 441     constants.HV_KVM_SPICE_BIND: hv_base.NO_CHECK, # will be checked later
 442     constants.HV_KVM_SPICE_IP_VERSION:
 443       (False, lambda x: (x == constants.IFACE_NO_IP_VERSION_SPECIFIED or
 444                          x in constants.VALID_IP_VERSIONS),
 445        "the SPICE IP version should be 4 or 6",
 446        None, None),
 447     constants.HV_KVM_SPICE_PASSWORD_FILE: hv_base.OPT_FILE_CHECK,
 448     constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR:
 449       hv_base.ParamInSet(False,
 450         constants.HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS),
 451     constants.HV_KVM_SPICE_JPEG_IMG_COMPR:
 452       hv_base.ParamInSet(False,
 453         constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
 454     constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR:
 455       hv_base.ParamInSet(False,
 456         constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
 457     constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION:
 458       hv_base.ParamInSet(False,
 459         constants.HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS),
 460     constants.HV_KVM_SPICE_AUDIO_COMPR: hv_base.NO_CHECK,
 461     constants.HV_KVM_SPICE_USE_TLS: hv_base.NO_CHECK,
 462     constants.HV_KVM_SPICE_TLS_CIPHERS: hv_base.NO_CHECK,
 463     constants.HV_KVM_SPICE_USE_VDAGENT: hv_base.NO_CHECK,
 464     constants.HV_KVM_FLOPPY_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
 465     constants.HV_CDROM_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
 466     constants.HV_KVM_CDROM2_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
 467     constants.HV_BOOT_ORDER:
 468       hv_base.ParamInSet(True, constants.HT_KVM_VALID_BO_TYPES),
 469     constants.HV_NIC_TYPE:
 470       hv_base.ParamInSet(True, constants.HT_KVM_VALID_NIC_TYPES),
 471     constants.HV_DISK_TYPE:
 472       hv_base.ParamInSet(True, constants.HT_KVM_VALID_DISK_TYPES),
 473     constants.HV_KVM_CDROM_DISK_TYPE:
 474       hv_base.ParamInSet(False, constants.HT_KVM_VALID_DISK_TYPES),
 475     constants.HV_USB_MOUSE:
 476       hv_base.ParamInSet(False, constants.HT_KVM_VALID_MOUSE_TYPES),
 477     constants.HV_KEYMAP: hv_base.NO_CHECK,
 478     constants.HV_MIGRATION_PORT: hv_base.REQ_NET_PORT_CHECK,
 479     constants.HV_MIGRATION_BANDWIDTH: hv_base.NO_CHECK,
 480     constants.HV_MIGRATION_DOWNTIME: hv_base.NO_CHECK,
 481     constants.HV_MIGRATION_MODE: hv_base.MIGRATION_MODE_CHECK,
 482     constants.HV_USE_LOCALTIME: hv_base.NO_CHECK,
 483     constants.HV_DISK_CACHE:
 484       hv_base.ParamInSet(True, constants.HT_VALID_CACHE_TYPES),
 485     constants.HV_SECURITY_MODEL:
 486       hv_base.ParamInSet(True, constants.HT_KVM_VALID_SM_TYPES),
 487     constants.HV_SECURITY_DOMAIN: hv_base.NO_CHECK,
 488     constants.HV_KVM_FLAG:
 489       hv_base.ParamInSet(False, constants.HT_KVM_FLAG_VALUES),
 490     constants.HV_VHOST_NET: hv_base.NO_CHECK,
 491     constants.HV_KVM_USE_CHROOT: hv_base.NO_CHECK,
 492     constants.HV_MEM_PATH: hv_base.OPT_DIR_CHECK,
 493     constants.HV_REBOOT_BEHAVIOR:
 494       hv_base.ParamInSet(True, constants.REBOOT_BEHAVIORS),
 495     constants.HV_CPU_MASK: hv_base.OPT_MULTI_CPU_MASK_CHECK,
 496     }
 497
 498   _MIGRATION_STATUS_RE = re.compile("Migration\s+status:\s+(\w+)",
 499                                     re.M | re.I)
 500   _MIGRATION_PROGRESS_RE = \
 501     re.compile("\s*transferred\s+ram:\s+(?P<transferred>\d+)\s+kbytes\s*\n"
 502                "\s*remaining\s+ram:\s+(?P<remaining>\d+)\s+kbytes\s*\n"
 503                "\s*total\s+ram:\s+(?P<total>\d+)\s+kbytes\s*\n", re.I)
 504
 505   _MIGRATION_INFO_MAX_BAD_ANSWERS = 5
 506   _MIGRATION_INFO_RETRY_DELAY = 2
 507
 508   _VERSION_RE = re.compile(r"\b(\d+)\.(\d+)\.(\d+)\b")
 509
 510   _CPU_INFO_RE = re.compile(r"cpu\s+\#(\d+).*thread_id\s*=\s*(\d+)", re.I)
 511   _CPU_INFO_CMD = "info cpus"
 512   _CONT_CMD = "cont"
 513
 514   ANCILLARY_FILES = [
 515     _KVM_NETWORK_SCRIPT,
 516     ]
 517   ANCILLARY_FILES_OPT = [
 518     _KVM_NETWORK_SCRIPT,
 519     ]
 520
 521   def __init__(self):
 522     hv_base.BaseHypervisor.__init__(self)
 523     # Let's make sure the directories we need exist, even if the RUN_DIR lives
 524     # in a tmpfs filesystem or has been otherwise wiped out.
 525     dirs = [(dname, constants.RUN_DIRS_MODE) for dname in self._DIRS]
 526     utils.EnsureDirs(dirs)
 527
 528   @classmethod
 529   def _InstancePidFile(cls, instance_name):
 530     """Returns the instance pidfile.
 531
 532     """
 533     return utils.PathJoin(cls._PIDS_DIR, instance_name)
 534
 535   @classmethod
 536   def _InstanceUidFile(cls, instance_name):
 537     """Returns the instance uidfile.
 538
 539     """
 540     return utils.PathJoin(cls._UIDS_DIR, instance_name)
 541
 542   @classmethod
 543   def _InstancePidInfo(cls, pid):
 544     """Check pid file for instance information.
 545
 546     Check that a pid file is associated with an instance, and retrieve
 547     information from its command line.
 548
 549     @type pid: string or int
 550     @param pid: process id of the instance to check
 551     @rtype: tuple
 552     @return: (instance_name, memory, vcpus)
 553     @raise errors.HypervisorError: when an instance cannot be found
 554
 555     """
 556     alive = utils.IsProcessAlive(pid)
 557     if not alive:
 558       raise errors.HypervisorError("Cannot get info for pid %s" % pid)
 559
 560     cmdline_file = utils.PathJoin("/proc", str(pid), "cmdline")
 561     try:
 562       cmdline = utils.ReadFile(cmdline_file)
 563     except EnvironmentError, err:
 564       raise errors.HypervisorError("Can't open cmdline file for pid %s: %s" %
 565                                    (pid, err))
 566
 567     instance = None
 568     memory = 0
 569     vcpus = 0
 570
 571     arg_list = cmdline.split("\x00")
 572     while arg_list:
 573       arg = arg_list.pop(0)
 574       if arg == "-name":
 575         instance = arg_list.pop(0)
 576       elif arg == "-m":
 577         memory = int(arg_list.pop(0))
 578       elif arg == "-smp":
 579         vcpus = int(arg_list.pop(0))
 580
 581     if instance is None:
 582       raise errors.HypervisorError("Pid %s doesn't contain a ganeti kvm"
 583                                    " instance" % pid)
 584
 585     return (instance, memory, vcpus)
 586
 587   def _InstancePidAlive(self, instance_name):
 588     """Returns the instance pidfile, pid, and liveness.
 589
 590     @type instance_name: string
 591     @param instance_name: instance name
 592     @rtype: tuple
 593     @return: (pid file name, pid, liveness)
 594
 595     """
 596     pidfile = self._InstancePidFile(instance_name)
 597     pid = utils.ReadPidFile(pidfile)
 598
 599     alive = False
 600     try:
 601       cmd_instance = self._InstancePidInfo(pid)[0]
 602       alive = (cmd_instance == instance_name)
 603     except errors.HypervisorError:
 604       pass
 605
 606     return (pidfile, pid, alive)
 607
 608   def _CheckDown(self, instance_name):
 609     """Raises an error unless the given instance is down.
 610
 611     """
 612     alive = self._InstancePidAlive(instance_name)[2]
 613     if alive:
 614       raise errors.HypervisorError("Failed to start instance %s: %s" %
 615                                    (instance_name, "already running"))
 616
 617   @classmethod
 618   def _InstanceMonitor(cls, instance_name):
 619     """Returns the instance monitor socket name
 620
 621     """
 622     return utils.PathJoin(cls._CTRL_DIR, "%s.monitor" % instance_name)
 623
 624   @classmethod
 625   def _InstanceSerial(cls, instance_name):
 626     """Returns the instance serial socket name
 627
 628     """
 629     return utils.PathJoin(cls._CTRL_DIR, "%s.serial" % instance_name)
 630
 631   @classmethod
 632   def _InstanceQmpMonitor(cls, instance_name):
 633     """Returns the instance serial QMP socket name
 634
 635     """
 636     return utils.PathJoin(cls._CTRL_DIR, "%s.qmp" % instance_name)
 637
 638   @staticmethod
 639   def _SocatUnixConsoleParams():
 640     """Returns the correct parameters for socat
 641
 642     If we have a new-enough socat we can use raw mode with an escape character.
 643
 644     """
 645     if constants.SOCAT_USE_ESCAPE:
 646       return "raw,echo=0,escape=%s" % constants.SOCAT_ESCAPE_CODE
 647     else:
 648       return "echo=0,icanon=0"
 649
 650   @classmethod
 651   def _InstanceKVMRuntime(cls, instance_name):
 652     """Returns the instance KVM runtime filename
 653
 654     """
 655     return utils.PathJoin(cls._CONF_DIR, "%s.runtime" % instance_name)
 656
 657   @classmethod
 658   def _InstanceChrootDir(cls, instance_name):
 659     """Returns the name of the KVM chroot dir of the instance
 660
 661     """
 662     return utils.PathJoin(cls._CHROOT_DIR, instance_name)
 663
 664   @classmethod
 665   def _InstanceNICDir(cls, instance_name):
 666     """Returns the name of the directory holding the tap device files for a
 667     given instance.
 668
 669     """
 670     return utils.PathJoin(cls._NICS_DIR, instance_name)
 671
 672   @classmethod
 673   def _InstanceNICFile(cls, instance_name, seq):
 674     """Returns the name of the file containing the tap device for a given NIC
 675
 676     """
 677     return utils.PathJoin(cls._InstanceNICDir(instance_name), str(seq))
 678
 679   @classmethod
 680   def _InstanceKeymapFile(cls, instance_name):
 681     """Returns the name of the file containing the keymap for a given instance
 682
 683     """
 684     return utils.PathJoin(cls._KEYMAP_DIR, instance_name)
 685
 686   @classmethod
 687   def _TryReadUidFile(cls, uid_file):
 688     """Try to read a uid file
 689
 690     """
 691     if os.path.exists(uid_file):
 692       try:
 693         uid = int(utils.ReadOneLineFile(uid_file))
 694         return uid
 695       except EnvironmentError:
 696         logging.warning("Can't read uid file", exc_info=True)
 697       except (TypeError, ValueError):
 698         logging.warning("Can't parse uid file contents", exc_info=True)
 699     return None
 700
 701   @classmethod
 702   def _RemoveInstanceRuntimeFiles(cls, pidfile, instance_name):
 703     """Removes an instance's rutime sockets/files/dirs.
 704
 705     """
 706     utils.RemoveFile(pidfile)
 707     utils.RemoveFile(cls._InstanceMonitor(instance_name))
 708     utils.RemoveFile(cls._InstanceSerial(instance_name))
 709     utils.RemoveFile(cls._InstanceQmpMonitor(instance_name))
 710     utils.RemoveFile(cls._InstanceKVMRuntime(instance_name))
 711     utils.RemoveFile(cls._InstanceKeymapFile(instance_name))
 712     uid_file = cls._InstanceUidFile(instance_name)
 713     uid = cls._TryReadUidFile(uid_file)
 714     utils.RemoveFile(uid_file)
 715     if uid is not None:
 716       uidpool.ReleaseUid(uid)
 717     try:
 718       shutil.rmtree(cls._InstanceNICDir(instance_name))
 719     except OSError, err:
 720       if err.errno != errno.ENOENT:
 721         raise
 722     try:
 723       chroot_dir = cls._InstanceChrootDir(instance_name)
 724       utils.RemoveDir(chroot_dir)
 725     except OSError, err:
 726       if err.errno == errno.ENOTEMPTY:
 727         # The chroot directory is expected to be empty, but it isn't.
 728         new_chroot_dir = tempfile.mkdtemp(dir=cls._CHROOT_QUARANTINE_DIR,
 729                                           prefix="%s-%s-" %
 730                                           (instance_name,
 731                                            utils.TimestampForFilename()))
 732         logging.warning("The chroot directory of instance %s can not be"
 733                         " removed as it is not empty. Moving it to the"
 734                         " quarantine instead. Please investigate the"
 735                         " contents (%s) and clean up manually",
 736                         instance_name, new_chroot_dir)
 737         utils.RenameFile(chroot_dir, new_chroot_dir)
 738       else:
 739         raise
 740
 741   @staticmethod
 742   def _ConfigureNIC(instance, seq, nic, tap):
 743     """Run the network configuration script for a specified NIC
 744
 745     @param instance: instance we're acting on
 746     @type instance: instance object
 747     @param seq: nic sequence number
 748     @type seq: int
 749     @param nic: nic we're acting on
 750     @type nic: nic object
 751     @param tap: the host's tap interface this NIC corresponds to
 752     @type tap: str
 753
 754     """
 755     if instance.tags:
 756       tags = " ".join(instance.tags)
 757     else:
 758       tags = ""
 759
 760     env = {
 761       "PATH": "%s:/sbin:/usr/sbin" % os.environ["PATH"],
 762       "INSTANCE": instance.name,
 763       "MAC": nic.mac,
 764       "MODE": nic.nicparams[constants.NIC_MODE],
 765       "INTERFACE": tap,
 766       "INTERFACE_INDEX": str(seq),
 767       "TAGS": tags,
 768     }
 769
 770     if nic.ip:
 771       env["IP"] = nic.ip
 772
 773     if nic.nicparams[constants.NIC_LINK]:
 774       env["LINK"] = nic.nicparams[constants.NIC_LINK]
 775
 776     if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
 777       env["BRIDGE"] = nic.nicparams[constants.NIC_LINK]
 778
 779     result = utils.RunCmd([constants.KVM_IFUP, tap], env=env)
 780     if result.failed:
 781       raise errors.HypervisorError("Failed to configure interface %s: %s."
 782                                    " Network configuration script output: %s" %
 783                                    (tap, result.fail_reason, result.output))
 784
 785   @staticmethod
 786   def _VerifyAffinityPackage():
 787     if affinity is None:
 788       raise errors.HypervisorError("affinity Python package not"
 789         " found; cannot use CPU pinning under KVM")
 790
 791   @staticmethod
 792   def _BuildAffinityCpuMask(cpu_list):
 793     """Create a CPU mask suitable for sched_setaffinity from a list of
 794     CPUs.
 795
 796     See man taskset for more info on sched_setaffinity masks.
 797     For example: [ 0, 2, 5, 6 ] will return 101 (0x65, 0..01100101).
 798
 799     @type cpu_list: list of int
 800     @param cpu_list: list of physical CPU numbers to map to vCPUs in order
 801     @rtype: int
 802     @return: a bit mask of CPU affinities
 803
 804     """
 805     if cpu_list == constants.CPU_PINNING_OFF:
 806       return constants.CPU_PINNING_ALL_KVM
 807     else:
 808       return sum(2 ** cpu for cpu in cpu_list)
 809
 810   @classmethod
 811   def _AssignCpuAffinity(cls, cpu_mask, process_id, thread_dict):
 812     """Change CPU affinity for running VM according to given CPU mask.
 813
 814     @param cpu_mask: CPU mask as given by the user. e.g. "0-2,4:all:1,3"
 815     @type cpu_mask: string
 816     @param process_id: process ID of KVM process. Used to pin entire VM
 817                        to physical CPUs.
 818     @type process_id: int
 819     @param thread_dict: map of virtual CPUs to KVM thread IDs
 820     @type thread_dict: dict int:int
 821
 822     """
 823     # Convert the string CPU mask to a list of list of int's
 824     cpu_list = utils.ParseMultiCpuMask(cpu_mask)
 825
 826     if len(cpu_list) == 1:
 827       all_cpu_mapping = cpu_list[0]
 828       if all_cpu_mapping == constants.CPU_PINNING_OFF:
 829         # If CPU pinning has 1 entry that's "all", then do nothing
 830         pass
 831       else:
 832         # If CPU pinning has one non-all entry, map the entire VM to
 833         # one set of physical CPUs
 834         cls._VerifyAffinityPackage()
 835         affinity.set_process_affinity_mask(process_id,
 836           cls._BuildAffinityCpuMask(all_cpu_mapping))
 837     else:
 838       # The number of vCPUs mapped should match the number of vCPUs
 839       # reported by KVM. This was already verified earlier, so
 840       # here only as a sanity check.
 841       assert len(thread_dict) == len(cpu_list)
 842       cls._VerifyAffinityPackage()
 843
 844       # For each vCPU, map it to the proper list of physical CPUs
 845       for vcpu, i in zip(cpu_list, range(len(cpu_list))):
 846         affinity.set_process_affinity_mask(thread_dict[i],
 847           cls._BuildAffinityCpuMask(vcpu))
 848
 849   def _GetVcpuThreadIds(self, instance_name):
 850     """Get a mapping of vCPU no. to thread IDs for the instance
 851
 852     @type instance_name: string
 853     @param instance_name: instance in question
 854     @rtype: dictionary of int:int
 855     @return: a dictionary mapping vCPU numbers to thread IDs
 856
 857     """
 858     result = {}
 859     output = self._CallMonitorCommand(instance_name, self._CPU_INFO_CMD)
 860     for line in output.stdout.splitlines():
 861       match = self._CPU_INFO_RE.search(line)
 862       if not match:
 863         continue
 864       grp = map(int, match.groups())
 865       result[grp[0]] = grp[1]
 866
 867     return result
 868
 869   def _ExecuteCpuAffinity(self, instance_name, cpu_mask):
 870     """Complete CPU pinning.
 871
 872     @type instance_name: string
 873     @param instance_name: name of instance
 874     @type cpu_mask: string
 875     @param cpu_mask: CPU pinning mask as entered by user
 876
 877     """
 878     # Get KVM process ID, to be used if need to pin entire VM
 879     _, pid, _ = self._InstancePidAlive(instance_name)
 880     # Get vCPU thread IDs, to be used if need to pin vCPUs separately
 881     thread_dict = self._GetVcpuThreadIds(instance_name)
 882     # Run CPU pinning, based on configured mask
 883     self._AssignCpuAffinity(cpu_mask, pid, thread_dict)
 884
 885   def ListInstances(self):
 886     """Get the list of running instances.
 887
 888     We can do this by listing our live instances directory and
 889     checking whether the associated kvm process is still alive.
 890
 891     """
 892     result = []
 893     for name in os.listdir(self._PIDS_DIR):
 894       if self._InstancePidAlive(name)[2]:
 895         result.append(name)
 896     return result
 897
 898   def GetInstanceInfo(self, instance_name):
 899     """Get instance properties.
 900
 901     @type instance_name: string
 902     @param instance_name: the instance name
 903     @rtype: tuple of strings
 904     @return: (name, id, memory, vcpus, stat, times)
 905
 906     """
 907     _, pid, alive = self._InstancePidAlive(instance_name)
 908     if not alive:
 909       return None
 910
 911     _, memory, vcpus = self._InstancePidInfo(pid)
 912     istat = "---b-"
 913     times = "0"
 914
 915     try:
 916       qmp = QmpConnection(self._InstanceQmpMonitor(instance_name))
 917       qmp.connect()
 918       vcpus = len(qmp.Execute("query-cpus")[qmp.RETURN_KEY])
 919       # Will fail if ballooning is not enabled, but we can then just resort to
 920       # the value above.
 921       mem_bytes = qmp.Execute("query-balloon")[qmp.RETURN_KEY][qmp.ACTUAL_KEY]
 922       memory = mem_bytes / 1048576
 923     except errors.HypervisorError:
 924       pass
 925
 926     return (instance_name, pid, memory, vcpus, istat, times)
 927
 928   def GetAllInstancesInfo(self):
 929     """Get properties of all instances.
 930
 931     @return: list of tuples (name, id, memory, vcpus, stat, times)
 932
 933     """
 934     data = []
 935     for name in os.listdir(self._PIDS_DIR):
 936       try:
 937         info = self.GetInstanceInfo(name)
 938       except errors.HypervisorError:
 939         continue
 940       if info:
 941         data.append(info)
 942     return data
 943
 944   def _GenerateKVMRuntime(self, instance, block_devices, startup_paused):
 945     """Generate KVM information to start an instance.
 946
 947     """
 948     # pylint: disable=R0914,R0915
 949     _, v_major, v_min, _ = self._GetKVMVersion()
 950
 951     pidfile = self._InstancePidFile(instance.name)
 952     kvm = constants.KVM_PATH
 953     kvm_cmd = [kvm]
 954     # used just by the vnc server, if enabled
 955     kvm_cmd.extend(["-name", instance.name])
 956     kvm_cmd.extend(["-m", instance.beparams[constants.BE_MAXMEM]])
 957     kvm_cmd.extend(["-smp", instance.beparams[constants.BE_VCPUS]])
 958     kvm_cmd.extend(["-pidfile", pidfile])
 959     kvm_cmd.extend(["-balloon", "virtio"])
 960     kvm_cmd.extend(["-daemonize"])
 961     if not instance.hvparams[constants.HV_ACPI]:
 962       kvm_cmd.extend(["-no-acpi"])
 963     if instance.hvparams[constants.HV_REBOOT_BEHAVIOR] == \
 964         constants.INSTANCE_REBOOT_EXIT:
 965       kvm_cmd.extend(["-no-reboot"])
 966
 967     hvp = instance.hvparams
 968     boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
 969     boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
 970     boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
 971     boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
 972
 973     self.ValidateParameters(hvp)
 974
 975     if startup_paused:
 976       kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
 977
 978     if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
 979       kvm_cmd.extend(["-enable-kvm"])
 980     elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
 981       kvm_cmd.extend(["-disable-kvm"])
 982
 983     if boot_network:
 984       kvm_cmd.extend(["-boot", "n"])
 985
 986     disk_type = hvp[constants.HV_DISK_TYPE]
 987     if disk_type == constants.HT_DISK_PARAVIRTUAL:
 988       if_val = ",if=virtio"
 989     else:
 990       if_val = ",if=%s" % disk_type
 991     # Cache mode
 992     disk_cache = hvp[constants.HV_DISK_CACHE]
 993     if instance.disk_template in constants.DTS_EXT_MIRROR:
 994       if disk_cache != "none":
 995         # TODO: make this a hard error, instead of a silent overwrite
 996         logging.warning("KVM: overriding disk_cache setting '%s' with 'none'"
 997                         " to prevent shared storage corruption on migration",
 998                         disk_cache)
 999       cache_val = ",cache=none"
1000     elif disk_cache != constants.HT_CACHE_DEFAULT:
1001       cache_val = ",cache=%s" % disk_cache
1002     else:
1003       cache_val = ""
1004     for cfdev, dev_path in block_devices:
1005       if cfdev.mode != constants.DISK_RDWR:
1006         raise errors.HypervisorError("Instance has read-only disks which"
1007                                      " are not supported by KVM")
1008       # TODO: handle FD_LOOP and FD_BLKTAP (?)
1009       boot_val = ""
1010       if boot_disk:
1011         kvm_cmd.extend(["-boot", "c"])
1012         boot_disk = False
1013         if (v_major, v_min) < (0, 14) and disk_type != constants.HT_DISK_IDE:
1014           boot_val = ",boot=on"
1015
1016       drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
1017                                                 cache_val)
1018       kvm_cmd.extend(["-drive", drive_val])
1019
1020     #Now we can specify a different device type for CDROM devices.
1021     cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
1022     if not cdrom_disk_type:
1023       cdrom_disk_type = disk_type
1024
1025     iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
1026     if iso_image:
1027       options = ",format=raw,media=cdrom"
1028       if boot_cdrom:
1029         kvm_cmd.extend(["-boot", "d"])
1030         if cdrom_disk_type != constants.HT_DISK_IDE:
1031           options = "%s,boot=on,if=%s" % (options, constants.HT_DISK_IDE)
1032         else:
1033           options = "%s,boot=on" % options
1034       else:
1035         if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1036           if_val = ",if=virtio"
1037         else:
1038           if_val = ",if=%s" % cdrom_disk_type
1039         options = "%s%s" % (options, if_val)
1040       drive_val = "file=%s%s" % (iso_image, options)
1041       kvm_cmd.extend(["-drive", drive_val])
1042
1043     iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
1044     if iso_image2:
1045       options = ",format=raw,media=cdrom"
1046       if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1047         if_val = ",if=virtio"
1048       else:
1049         if_val = ",if=%s" % cdrom_disk_type
1050       options = "%s%s" % (options, if_val)
1051       drive_val = "file=%s%s" % (iso_image2, options)
1052       kvm_cmd.extend(["-drive", drive_val])
1053
1054     floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
1055     if floppy_image:
1056       options = ",format=raw,media=disk"
1057       if boot_floppy:
1058         kvm_cmd.extend(["-boot", "a"])
1059         options = "%s,boot=on" % options
1060       if_val = ",if=floppy"
1061       options = "%s%s" % (options, if_val)
1062       drive_val = "file=%s%s" % (floppy_image, options)
1063       kvm_cmd.extend(["-drive", drive_val])
1064
1065     kernel_path = hvp[constants.HV_KERNEL_PATH]
1066     if kernel_path:
1067       kvm_cmd.extend(["-kernel", kernel_path])
1068       initrd_path = hvp[constants.HV_INITRD_PATH]
1069       if initrd_path:
1070         kvm_cmd.extend(["-initrd", initrd_path])
1071       root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
1072                      hvp[constants.HV_KERNEL_ARGS]]
1073       if hvp[constants.HV_SERIAL_CONSOLE]:
1074         root_append.append("console=ttyS0,38400")
1075       kvm_cmd.extend(["-append", " ".join(root_append)])
1076
1077     mem_path = hvp[constants.HV_MEM_PATH]
1078     if mem_path:
1079       kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
1080
1081     mouse_type = hvp[constants.HV_USB_MOUSE]
1082     vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
1083
1084     if mouse_type:
1085       kvm_cmd.extend(["-usb"])
1086       kvm_cmd.extend(["-usbdevice", mouse_type])
1087     elif vnc_bind_address:
1088       kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
1089
1090     keymap = hvp[constants.HV_KEYMAP]
1091     if keymap:
1092       keymap_path = self._InstanceKeymapFile(instance.name)
1093       # If a keymap file is specified, KVM won't use its internal defaults. By
1094       # first including the "en-us" layout, an error on loading the actual
1095       # layout (e.g. because it can't be found) won't lead to a non-functional
1096       # keyboard. A keyboard with incorrect keys is still better than none.
1097       utils.WriteFile(keymap_path, data="include en-us\ninclude %s\n" % keymap)
1098       kvm_cmd.extend(["-k", keymap_path])
1099
1100     if vnc_bind_address:
1101       if netutils.IP4Address.IsValid(vnc_bind_address):
1102         if instance.network_port > constants.VNC_BASE_PORT:
1103           display = instance.network_port - constants.VNC_BASE_PORT
1104           if vnc_bind_address == constants.IP4_ADDRESS_ANY:
1105             vnc_arg = ":%d" % (display)
1106           else:
1107             vnc_arg = "%s:%d" % (vnc_bind_address, display)
1108         else:
1109           logging.error("Network port is not a valid VNC display (%d < %d)."
1110                         " Not starting VNC", instance.network_port,
1111                         constants.VNC_BASE_PORT)
1112           vnc_arg = "none"
1113
1114         # Only allow tls and other option when not binding to a file, for now.
1115         # kvm/qemu gets confused otherwise about the filename to use.
1116         vnc_append = ""
1117         if hvp[constants.HV_VNC_TLS]:
1118           vnc_append = "%s,tls" % vnc_append
1119           if hvp[constants.HV_VNC_X509_VERIFY]:
1120             vnc_append = "%s,x509verify=%s" % (vnc_append,
1121                                                hvp[constants.HV_VNC_X509])
1122           elif hvp[constants.HV_VNC_X509]:
1123             vnc_append = "%s,x509=%s" % (vnc_append,
1124                                          hvp[constants.HV_VNC_X509])
1125         if hvp[constants.HV_VNC_PASSWORD_FILE]:
1126           vnc_append = "%s,password" % vnc_append
1127
1128         vnc_arg = "%s%s" % (vnc_arg, vnc_append)
1129
1130       else:
1131         vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
1132
1133       kvm_cmd.extend(["-vnc", vnc_arg])
1134     else:
1135       kvm_cmd.extend(["-nographic"])
1136
1137     monitor_dev = ("unix:%s,server,nowait" %
1138                    self._InstanceMonitor(instance.name))
1139     kvm_cmd.extend(["-monitor", monitor_dev])
1140     if hvp[constants.HV_SERIAL_CONSOLE]:
1141       serial_dev = ("unix:%s,server,nowait" %
1142                     self._InstanceSerial(instance.name))
1143       kvm_cmd.extend(["-serial", serial_dev])
1144     else:
1145       kvm_cmd.extend(["-serial", "none"])
1146
1147     spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
1148     spice_ip_version = None
1149     if spice_bind:
1150       if netutils.IsValidInterface(spice_bind):
1151         # The user specified a network interface, we have to figure out the IP
1152         # address.
1153         addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1154         spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1155
1156         # if the user specified an IP version and the interface does not
1157         # have that kind of IP addresses, throw an exception
1158         if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1159           if not addresses[spice_ip_version]:
1160             raise errors.HypervisorError("spice: unable to get an IPv%s address"
1161                                          " for %s" % (spice_ip_version,
1162                                                       spice_bind))
1163
1164         # the user did not specify an IP version, we have to figure it out
1165         elif (addresses[constants.IP4_VERSION] and
1166               addresses[constants.IP6_VERSION]):
1167           # we have both ipv4 and ipv6, let's use the cluster default IP
1168           # version
1169           cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1170           spice_ip_version = \
1171             netutils.IPAddress.GetVersionFromAddressFamily(cluster_family)
1172         elif addresses[constants.IP4_VERSION]:
1173           spice_ip_version = constants.IP4_VERSION
1174         elif addresses[constants.IP6_VERSION]:
1175           spice_ip_version = constants.IP6_VERSION
1176         else:
1177           raise errors.HypervisorError("spice: unable to get an IP address"
1178                                        " for %s" % (spice_bind))
1179
1180         spice_address = addresses[spice_ip_version][0]
1181
1182       else:
1183         # spice_bind is known to be a valid IP address, because
1184         # ValidateParameters checked it.
1185         spice_address = spice_bind
1186
1187       spice_arg = "addr=%s" % spice_address
1188       if hvp[constants.HV_KVM_SPICE_USE_TLS]:
1189         spice_arg = "%s,tls-port=%s,x509-cacert-file=%s" % (spice_arg,
1190             instance.network_port, constants.SPICE_CACERT_FILE)
1191         spice_arg = "%s,x509-key-file=%s,x509-cert-file=%s" % (spice_arg,
1192             constants.SPICE_CERT_FILE, constants.SPICE_CERT_FILE)
1193         tls_ciphers = hvp[constants.HV_KVM_SPICE_TLS_CIPHERS]
1194         if tls_ciphers:
1195           spice_arg = "%s,tls-ciphers=%s" % (spice_arg, tls_ciphers)
1196       else:
1197         spice_arg = "%s,port=%s" % (spice_arg, instance.network_port)
1198
1199       if not hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]:
1200         spice_arg = "%s,disable-ticketing" % spice_arg
1201
1202       if spice_ip_version:
1203         spice_arg = "%s,ipv%s" % (spice_arg, spice_ip_version)
1204
1205       # Image compression options
1206       img_lossless = hvp[constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR]
1207       img_jpeg = hvp[constants.HV_KVM_SPICE_JPEG_IMG_COMPR]
1208       img_zlib_glz = hvp[constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR]
1209       if img_lossless:
1210         spice_arg = "%s,image-compression=%s" % (spice_arg, img_lossless)
1211       if img_jpeg:
1212         spice_arg = "%s,jpeg-wan-compression=%s" % (spice_arg, img_jpeg)
1213       if img_zlib_glz:
1214         spice_arg = "%s,zlib-glz-wan-compression=%s" % (spice_arg, img_zlib_glz)
1215
1216       # Video stream detection
1217       video_streaming = hvp[constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION]
1218       if video_streaming:
1219         spice_arg = "%s,streaming-video=%s" % (spice_arg, video_streaming)
1220
1221       # Audio compression, by default in qemu-kvm it is on
1222       if not hvp[constants.HV_KVM_SPICE_AUDIO_COMPR]:
1223         spice_arg = "%s,playback-compression=off" % spice_arg
1224       if not hvp[constants.HV_KVM_SPICE_USE_VDAGENT]:
1225         spice_arg = "%s,agent-mouse=off" % spice_arg
1226
1227       logging.info("KVM: SPICE will listen on port %s", instance.network_port)
1228       kvm_cmd.extend(["-spice", spice_arg])
1229
1230       # Tell kvm to use the paravirtualized graphic card, optimized for SPICE
1231       kvm_cmd.extend(["-vga", "qxl"])
1232
1233     if hvp[constants.HV_USE_LOCALTIME]:
1234       kvm_cmd.extend(["-localtime"])
1235
1236     if hvp[constants.HV_KVM_USE_CHROOT]:
1237       kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1238
1239     # Save the current instance nics, but defer their expansion as parameters,
1240     # as we'll need to generate executable temp files for them.
1241     kvm_nics = instance.nics
1242     hvparams = hvp
1243
1244     return (kvm_cmd, kvm_nics, hvparams)
1245
1246   def _WriteKVMRuntime(self, instance_name, data):
1247     """Write an instance's KVM runtime
1248
1249     """
1250     try:
1251       utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1252                       data=data)
1253     except EnvironmentError, err:
1254       raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1255
1256   def _ReadKVMRuntime(self, instance_name):
1257     """Read an instance's KVM runtime
1258
1259     """
1260     try:
1261       file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1262     except EnvironmentError, err:
1263       raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1264     return file_content
1265
1266   def _SaveKVMRuntime(self, instance, kvm_runtime):
1267     """Save an instance's KVM runtime
1268
1269     """
1270     kvm_cmd, kvm_nics, hvparams = kvm_runtime
1271     serialized_nics = [nic.ToDict() for nic in kvm_nics]
1272     serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1273     self._WriteKVMRuntime(instance.name, serialized_form)
1274
1275   def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1276     """Load an instance's KVM runtime
1277
1278     """
1279     if not serialized_runtime:
1280       serialized_runtime = self._ReadKVMRuntime(instance.name)
1281     loaded_runtime = serializer.Load(serialized_runtime)
1282     kvm_cmd, serialized_nics, hvparams = loaded_runtime
1283     kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1284     return (kvm_cmd, kvm_nics, hvparams)
1285
1286   def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1287     """Run the KVM cmd and check for errors
1288
1289     @type name: string
1290     @param name: instance name
1291     @type kvm_cmd: list of strings
1292     @param kvm_cmd: runcmd input for kvm
1293     @type tap_fds: list of int
1294     @param tap_fds: fds of tap devices opened by Ganeti
1295
1296     """
1297     try:
1298       result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1299     finally:
1300       for fd in tap_fds:
1301         utils_wrapper.CloseFdNoError(fd)
1302
1303     if result.failed:
1304       raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1305                                    (name, result.fail_reason, result.output))
1306     if not self._InstancePidAlive(name)[2]:
1307       raise errors.HypervisorError("Failed to start instance %s" % name)
1308
1309   def _ExecuteKVMRuntime(self, instance, kvm_runtime, incoming=None):
1310     """Execute a KVM cmd, after completing it with some last minute data
1311
1312     @type incoming: tuple of strings
1313     @param incoming: (target_host_ip, port)
1314
1315     """
1316     # Small _ExecuteKVMRuntime hv parameters programming howto:
1317     #  - conf_hvp contains the parameters as configured on ganeti. they might
1318     #    have changed since the instance started; only use them if the change
1319     #    won't affect the inside of the instance (which hasn't been rebooted).
1320     #  - up_hvp contains the parameters as they were when the instance was
1321     #    started, plus any new parameter which has been added between ganeti
1322     #    versions: it is paramount that those default to a value which won't
1323     #    affect the inside of the instance as well.
1324     conf_hvp = instance.hvparams
1325     name = instance.name
1326     self._CheckDown(name)
1327
1328     temp_files = []
1329
1330     kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1331     up_hvp = objects.FillDict(conf_hvp, up_hvp)
1332
1333     _, v_major, v_min, _ = self._GetKVMVersion()
1334
1335     # We know it's safe to run as a different user upon migration, so we'll use
1336     # the latest conf, from conf_hvp.
1337     security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1338     if security_model == constants.HT_SM_USER:
1339       kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1340
1341     # We have reasons to believe changing something like the nic driver/type
1342     # upon migration won't exactly fly with the instance kernel, so for nic
1343     # related parameters we'll use up_hvp
1344     tapfds = []
1345     taps = []
1346     if not kvm_nics:
1347       kvm_cmd.extend(["-net", "none"])
1348     else:
1349       vnet_hdr = False
1350       tap_extra = ""
1351       nic_type = up_hvp[constants.HV_NIC_TYPE]
1352       if nic_type == constants.HT_NIC_PARAVIRTUAL:
1353         # From version 0.12.0, kvm uses a new sintax for network configuration.
1354         if (v_major, v_min) >= (0, 12):
1355           nic_model = "virtio-net-pci"
1356           vnet_hdr = True
1357         else:
1358           nic_model = "virtio"
1359
1360         if up_hvp[constants.HV_VHOST_NET]:
1361           # vhost_net is only available from version 0.13.0 or newer
1362           if (v_major, v_min) >= (0, 13):
1363             tap_extra = ",vhost=on"
1364           else:
1365             raise errors.HypervisorError("vhost_net is configured"
1366                                         " but it is not available")
1367       else:
1368         nic_model = nic_type
1369
1370       for nic_seq, nic in enumerate(kvm_nics):
1371         tapname, tapfd = _OpenTap(vnet_hdr)
1372         tapfds.append(tapfd)
1373         taps.append(tapname)
1374         if (v_major, v_min) >= (0, 12):
1375           nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1376           tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1377           kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1378         else:
1379           nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1380                                                          nic.mac, nic_model)
1381           tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1382           kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1383
1384     if incoming:
1385       target, port = incoming
1386       kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1387
1388     # Changing the vnc password doesn't bother the guest that much. At most it
1389     # will surprise people who connect to it. Whether positively or negatively
1390     # it's debatable.
1391     vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1392     vnc_pwd = None
1393     if vnc_pwd_file:
1394       try:
1395         vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1396       except EnvironmentError, err:
1397         raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1398                                      % (vnc_pwd_file, err))
1399
1400     if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1401       utils.EnsureDirs([(self._InstanceChrootDir(name),
1402                          constants.SECURE_DIR_MODE)])
1403
1404     # Automatically enable QMP if version is >= 0.14
1405     if (v_major, v_min) >= (0, 14):
1406       logging.debug("Enabling QMP")
1407       kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1408                     self._InstanceQmpMonitor(instance.name)])
1409
1410     # Configure the network now for starting instances and bridged interfaces,
1411     # during FinalizeMigration for incoming instances' routed interfaces
1412     for nic_seq, nic in enumerate(kvm_nics):
1413       if (incoming and
1414           nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1415         continue
1416       self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1417
1418     # CPU affinity requires kvm to start paused, so we set this flag if the
1419     # instance is not already paused and if we are not going to accept a
1420     # migrating instance. In the latter case, pausing is not needed.
1421     start_kvm_paused = not (_KVM_START_PAUSED_FLAG in kvm_cmd) and not incoming
1422
1423     # Note: CPU pinning is using up_hvp since changes take effect
1424     # during instance startup anyway, and to avoid problems when soft
1425     # rebooting the instance.
1426     cpu_pinning = False
1427     if up_hvp.get(constants.HV_CPU_MASK, None):
1428       cpu_pinning = True
1429       if start_kvm_paused:
1430         kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
1431
1432     if security_model == constants.HT_SM_POOL:
1433       ss = ssconf.SimpleStore()
1434       uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1435       all_uids = set(uidpool.ExpandUidPool(uid_pool))
1436       uid = uidpool.RequestUnusedUid(all_uids)
1437       try:
1438         username = pwd.getpwuid(uid.GetUid()).pw_name
1439         kvm_cmd.extend(["-runas", username])
1440         self._RunKVMCmd(name, kvm_cmd, tapfds)
1441       except:
1442         uidpool.ReleaseUid(uid)
1443         raise
1444       else:
1445         uid.Unlock()
1446         utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1447     else:
1448       self._RunKVMCmd(name, kvm_cmd, tapfds)
1449
1450     utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1451                      constants.RUN_DIRS_MODE)])
1452     for nic_seq, tap in enumerate(taps):
1453       utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1454                       data=tap)
1455
1456     if vnc_pwd:
1457       change_cmd = "change vnc password %s" % vnc_pwd
1458       self._CallMonitorCommand(instance.name, change_cmd)
1459
1460     # Setting SPICE password. We are not vulnerable to malicious passwordless
1461     # connection attempts because SPICE by default does not allow connections
1462     # if neither a password nor the "disable_ticketing" options are specified.
1463     # As soon as we send the password via QMP, that password is a valid ticket
1464     # for connection.
1465     spice_password_file = conf_hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]
1466     if spice_password_file:
1467       spice_pwd = ""
1468       try:
1469         spice_pwd = utils.ReadOneLineFile(spice_password_file, strict=True)
1470       except EnvironmentError, err:
1471         raise errors.HypervisorError("Failed to open SPICE password file %s: %s"
1472                                      % (spice_password_file, err))
1473
1474       qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1475       qmp.connect()
1476       arguments = {
1477           "protocol": "spice",
1478           "password": spice_pwd,
1479       }
1480       qmp.Execute("set_password", arguments)
1481
1482     for filename in temp_files:
1483       utils.RemoveFile(filename)
1484
1485     # If requested, set CPU affinity and resume instance execution
1486     if cpu_pinning:
1487       try:
1488         self._ExecuteCpuAffinity(instance.name, up_hvp[constants.HV_CPU_MASK])
1489       finally:
1490         if start_kvm_paused:
1491           # To control CPU pinning, the VM was started frozen, so we need
1492           # to resume its execution, but only if freezing was not
1493           # explicitly requested.
1494           # Note: this is done even when an exception occurred so the VM
1495           # is not unintentionally frozen.
1496           self._CallMonitorCommand(instance.name, self._CONT_CMD)
1497
1498   def StartInstance(self, instance, block_devices, startup_paused):
1499     """Start an instance.
1500
1501     """
1502     self._CheckDown(instance.name)
1503     kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1504                                            startup_paused)
1505     self._SaveKVMRuntime(instance, kvm_runtime)
1506     self._ExecuteKVMRuntime(instance, kvm_runtime)
1507
1508   def _CallMonitorCommand(self, instance_name, command):
1509     """Invoke a command on the instance monitor.
1510
1511     """
1512     socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1513              (utils.ShellQuote(command),
1514               constants.SOCAT_PATH,
1515               utils.ShellQuote(self._InstanceMonitor(instance_name))))
1516     result = utils.RunCmd(socat)
1517     if result.failed:
1518       msg = ("Failed to send command '%s' to instance %s."
1519              " output: %s, error: %s, fail_reason: %s" %
1520              (command, instance_name,
1521               result.stdout, result.stderr, result.fail_reason))
1522       raise errors.HypervisorError(msg)
1523
1524     return result
1525
1526   @classmethod
1527   def _GetKVMVersion(cls):
1528     """Return the installed KVM version.
1529
1530     @return: (version, v_maj, v_min, v_rev)
1531     @raise L{errors.HypervisorError}: when the KVM version cannot be retrieved
1532
1533     """
1534     result = utils.RunCmd([constants.KVM_PATH, "--help"])
1535     if result.failed:
1536       raise errors.HypervisorError("Unable to get KVM version")
1537     match = cls._VERSION_RE.search(result.output.splitlines()[0])
1538     if not match:
1539       raise errors.HypervisorError("Unable to get KVM version")
1540
1541     return (match.group(0), int(match.group(1)), int(match.group(2)),
1542             int(match.group(3)))
1543
1544   def StopInstance(self, instance, force=False, retry=False, name=None):
1545     """Stop an instance.
1546
1547     """
1548     if name is not None and not force:
1549       raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1550     if name is None:
1551       name = instance.name
1552       acpi = instance.hvparams[constants.HV_ACPI]
1553     else:
1554       acpi = False
1555     _, pid, alive = self._InstancePidAlive(name)
1556     if pid > 0 and alive:
1557       if force or not acpi:
1558         utils.KillProcess(pid)
1559       else:
1560         self._CallMonitorCommand(name, "system_powerdown")
1561
1562   def CleanupInstance(self, instance_name):
1563     """Cleanup after a stopped instance
1564
1565     """
1566     pidfile, pid, alive = self._InstancePidAlive(instance_name)
1567     if pid > 0 and alive:
1568       raise errors.HypervisorError("Cannot cleanup a live instance")
1569     self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1570
1571   def RebootInstance(self, instance):
1572     """Reboot an instance.
1573
1574     """
1575     # For some reason if we do a 'send-key ctrl-alt-delete' to the control
1576     # socket the instance will stop, but now power up again. So we'll resort
1577     # to shutdown and restart.
1578     _, _, alive = self._InstancePidAlive(instance.name)
1579     if not alive:
1580       raise errors.HypervisorError("Failed to reboot instance %s:"
1581                                    " not running" % instance.name)
1582     # StopInstance will delete the saved KVM runtime so:
1583     # ...first load it...
1584     kvm_runtime = self._LoadKVMRuntime(instance)
1585     # ...now we can safely call StopInstance...
1586     if not self.StopInstance(instance):
1587       self.StopInstance(instance, force=True)
1588     # ...and finally we can save it again, and execute it...
1589     self._SaveKVMRuntime(instance, kvm_runtime)
1590     self._ExecuteKVMRuntime(instance, kvm_runtime)
1591
1592   def MigrationInfo(self, instance):
1593     """Get instance information to perform a migration.
1594
1595     @type instance: L{objects.Instance}
1596     @param instance: instance to be migrated
1597     @rtype: string
1598     @return: content of the KVM runtime file
1599
1600     """
1601     return self._ReadKVMRuntime(instance.name)
1602
1603   def AcceptInstance(self, instance, info, target):
1604     """Prepare to accept an instance.
1605
1606     @type instance: L{objects.Instance}
1607     @param instance: instance to be accepted
1608     @type info: string
1609     @param info: content of the KVM runtime file on the source node
1610     @type target: string
1611     @param target: target host (usually ip), on this node
1612
1613     """
1614     kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1615     incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1616     self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1617
1618   def FinalizeMigrationDst(self, instance, info, success):
1619     """Finalize the instance migration on the target node.
1620
1621     Stop the incoming mode KVM.
1622
1623     @type instance: L{objects.Instance}
1624     @param instance: instance whose migration is being finalized
1625
1626     """
1627     if success:
1628       kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1629       kvm_nics = kvm_runtime[1]
1630
1631       for nic_seq, nic in enumerate(kvm_nics):
1632         if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1633           # Bridged interfaces have already been configured
1634           continue
1635         try:
1636           tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1637         except EnvironmentError, err:
1638           logging.warning("Failed to find host interface for %s NIC #%d: %s",
1639                           instance.name, nic_seq, str(err))
1640           continue
1641         try:
1642           self._ConfigureNIC(instance, nic_seq, nic, tap)
1643         except errors.HypervisorError, err:
1644           logging.warning(str(err))
1645
1646       self._WriteKVMRuntime(instance.name, info)
1647     else:
1648       self.StopInstance(instance, force=True)
1649
1650   def MigrateInstance(self, instance, target, live):
1651     """Migrate an instance to a target node.
1652
1653     The migration will not be attempted if the instance is not
1654     currently running.
1655
1656     @type instance: L{objects.Instance}
1657     @param instance: the instance to be migrated
1658     @type target: string
1659     @param target: ip address of the target node
1660     @type live: boolean
1661     @param live: perform a live migration
1662
1663     """
1664     instance_name = instance.name
1665     port = instance.hvparams[constants.HV_MIGRATION_PORT]
1666     _, _, alive = self._InstancePidAlive(instance_name)
1667     if not alive:
1668       raise errors.HypervisorError("Instance not running, cannot migrate")
1669
1670     if not live:
1671       self._CallMonitorCommand(instance_name, "stop")
1672
1673     migrate_command = ("migrate_set_speed %dm" %
1674         instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1675     self._CallMonitorCommand(instance_name, migrate_command)
1676
1677     migrate_command = ("migrate_set_downtime %dms" %
1678         instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1679     self._CallMonitorCommand(instance_name, migrate_command)
1680
1681     migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1682     self._CallMonitorCommand(instance_name, migrate_command)
1683
1684   def FinalizeMigrationSource(self, instance, success, live):
1685     """Finalize the instance migration on the source node.
1686
1687     @type instance: L{objects.Instance}
1688     @param instance: the instance that was migrated
1689     @type success: bool
1690     @param success: whether the migration succeeded or not
1691     @type live: bool
1692     @param live: whether the user requested a live migration or not
1693
1694     """
1695     if success:
1696       pidfile, pid, _ = self._InstancePidAlive(instance.name)
1697       utils.KillProcess(pid)
1698       self._RemoveInstanceRuntimeFiles(pidfile, instance.name)
1699     elif live:
1700       self._CallMonitorCommand(instance.name, self._CONT_CMD)
1701
1702   def GetMigrationStatus(self, instance):
1703     """Get the migration status
1704
1705     @type instance: L{objects.Instance}
1706     @param instance: the instance that is being migrated
1707     @rtype: L{objects.MigrationStatus}
1708     @return: the status of the current migration (one of
1709              L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1710              progress info that can be retrieved from the hypervisor
1711
1712     """
1713     info_command = "info migrate"
1714     for _ in range(self._MIGRATION_INFO_MAX_BAD_ANSWERS):
1715       result = self._CallMonitorCommand(instance.name, info_command)
1716       match = self._MIGRATION_STATUS_RE.search(result.stdout)
1717       if not match:
1718         if not result.stdout:
1719           logging.info("KVM: empty 'info migrate' result")
1720         else:
1721           logging.warning("KVM: unknown 'info migrate' result: %s",
1722                           result.stdout)
1723       else:
1724         status = match.group(1)
1725         if status in constants.HV_KVM_MIGRATION_VALID_STATUSES:
1726           migration_status = objects.MigrationStatus(status=status)
1727           match = self._MIGRATION_PROGRESS_RE.search(result.stdout)
1728           if match:
1729             migration_status.transferred_ram = match.group("transferred")
1730             migration_status.total_ram = match.group("total")
1731
1732           return migration_status
1733
1734         logging.warning("KVM: unknown migration status '%s'", status)
1735
1736       time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1737
1738     return objects.MigrationStatus(status=constants.HV_MIGRATION_FAILED,
1739                                   info="Too many 'info migrate' broken answers")
1740
1741   def GetNodeInfo(self):
1742     """Return information about the node.
1743
1744     @return: a dict with the following keys (values in MiB):
1745           - memory_total: the total memory size on the node
1746           - memory_free: the available memory on the node for instances
1747           - memory_dom0: the memory used by the node itself, if available
1748           - hv_version: the hypervisor version in the form (major, minor,
1749                         revision)
1750
1751     """
1752     result = self.GetLinuxNodeInfo()
1753     _, v_major, v_min, v_rev = self._GetKVMVersion()
1754     result[constants.HV_NODEINFO_KEY_VERSION] = (v_major, v_min, v_rev)
1755     return result
1756
1757   @classmethod
1758   def GetInstanceConsole(cls, instance, hvparams, beparams):
1759     """Return a command for connecting to the console of an instance.
1760
1761     """
1762     if hvparams[constants.HV_SERIAL_CONSOLE]:
1763       cmd = [constants.KVM_CONSOLE_WRAPPER,
1764              constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1765              utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1766              "STDIO,%s" % cls._SocatUnixConsoleParams(),
1767              "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1768       return objects.InstanceConsole(instance=instance.name,
1769                                      kind=constants.CONS_SSH,
1770                                      host=instance.primary_node,
1771                                      user=constants.GANETI_RUNAS,
1772                                      command=cmd)
1773
1774     vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1775     if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1776       display = instance.network_port - constants.VNC_BASE_PORT
1777       return objects.InstanceConsole(instance=instance.name,
1778                                      kind=constants.CONS_VNC,
1779                                      host=vnc_bind_address,
1780                                      port=instance.network_port,
1781                                      display=display)
1782
1783     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1784     if spice_bind:
1785       return objects.InstanceConsole(instance=instance.name,
1786                                      kind=constants.CONS_SPICE,
1787                                      host=spice_bind,
1788                                      port=instance.network_port)
1789
1790     return objects.InstanceConsole(instance=instance.name,
1791                                    kind=constants.CONS_MESSAGE,
1792                                    message=("No serial shell for instance %s" %
1793                                             instance.name))
1794
1795   def Verify(self):
1796     """Verify the hypervisor.
1797
1798     Check that the binary exists.
1799
1800     """
1801     if not os.path.exists(constants.KVM_PATH):
1802       return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1803     if not os.path.exists(constants.SOCAT_PATH):
1804       return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1805
1806   @classmethod
1807   def CheckParameterSyntax(cls, hvparams):
1808     """Check the given parameters for validity.
1809
1810     @type hvparams:  dict
1811     @param hvparams: dictionary with parameter names/value
1812     @raise errors.HypervisorError: when a parameter is not valid
1813
1814     """
1815     super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1816
1817     kernel_path = hvparams[constants.HV_KERNEL_PATH]
1818     if kernel_path:
1819       if not hvparams[constants.HV_ROOT_PATH]:
1820         raise errors.HypervisorError("Need a root partition for the instance,"
1821                                      " if a kernel is defined")
1822
1823     if (hvparams[constants.HV_VNC_X509_VERIFY] and
1824         not hvparams[constants.HV_VNC_X509]):
1825       raise errors.HypervisorError("%s must be defined, if %s is" %
1826                                    (constants.HV_VNC_X509,
1827                                     constants.HV_VNC_X509_VERIFY))
1828
1829     boot_order = hvparams[constants.HV_BOOT_ORDER]
1830     if (boot_order == constants.HT_BO_CDROM and
1831         not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1832       raise errors.HypervisorError("Cannot boot from cdrom without an"
1833                                    " ISO path")
1834
1835     security_model = hvparams[constants.HV_SECURITY_MODEL]
1836     if security_model == constants.HT_SM_USER:
1837       if not hvparams[constants.HV_SECURITY_DOMAIN]:
1838         raise errors.HypervisorError("A security domain (user to run kvm as)"
1839                                      " must be specified")
1840     elif (security_model == constants.HT_SM_NONE or
1841           security_model == constants.HT_SM_POOL):
1842       if hvparams[constants.HV_SECURITY_DOMAIN]:
1843         raise errors.HypervisorError("Cannot have a security domain when the"
1844                                      " security model is 'none' or 'pool'")
1845
1846     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1847     spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1848     if spice_bind:
1849       if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1850         # if an IP version is specified, the spice_bind parameter must be an
1851         # IP of that family
1852         if (netutils.IP4Address.IsValid(spice_bind) and
1853             spice_ip_version != constants.IP4_VERSION):
1854           raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1855                                        " the specified IP version is %s" %
1856                                        (spice_bind, spice_ip_version))
1857
1858         if (netutils.IP6Address.IsValid(spice_bind) and
1859             spice_ip_version != constants.IP6_VERSION):
1860           raise errors.HypervisorError("spice: got an IPv6 address (%s), but"
1861                                        " the specified IP version is %s" %
1862                                        (spice_bind, spice_ip_version))
1863     else:
1864       # All the other SPICE parameters depend on spice_bind being set. Raise an
1865       # error if any of them is set without it.
1866       spice_additional_params = frozenset([
1867         constants.HV_KVM_SPICE_IP_VERSION,
1868         constants.HV_KVM_SPICE_PASSWORD_FILE,
1869         constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR,
1870         constants.HV_KVM_SPICE_JPEG_IMG_COMPR,
1871         constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR,
1872         constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION,
1873         constants.HV_KVM_SPICE_USE_TLS,
1874         ])
1875       for param in spice_additional_params:
1876         if hvparams[param]:
1877           raise errors.HypervisorError("spice: %s requires %s to be set" %
1878                                        (param, constants.HV_KVM_SPICE_BIND))
1879
1880   @classmethod
1881   def ValidateParameters(cls, hvparams):
1882     """Check the given parameters for validity.
1883
1884     @type hvparams:  dict
1885     @param hvparams: dictionary with parameter names/value
1886     @raise errors.HypervisorError: when a parameter is not valid
1887
1888     """
1889     super(KVMHypervisor, cls).ValidateParameters(hvparams)
1890
1891     security_model = hvparams[constants.HV_SECURITY_MODEL]
1892     if security_model == constants.HT_SM_USER:
1893       username = hvparams[constants.HV_SECURITY_DOMAIN]
1894       try:
1895         pwd.getpwnam(username)
1896       except KeyError:
1897         raise errors.HypervisorError("Unknown security domain user %s"
1898                                      % username)
1899
1900     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1901     if spice_bind:
1902       # only one of VNC and SPICE can be used currently.
1903       if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1904         raise errors.HypervisorError("both SPICE and VNC are configured, but"
1905                                      " only one of them can be used at a"
1906                                      " given time.")
1907
1908       # KVM version should be >= 0.14.0
1909       _, v_major, v_min, _ = cls._GetKVMVersion()
1910       if (v_major, v_min) < (0, 14):
1911         raise errors.HypervisorError("spice is configured, but it is not"
1912                                      " available in versions of KVM < 0.14")
1913
1914       # if spice_bind is not an IP address, it must be a valid interface
1915       bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1916                        or netutils.IP6Address.IsValid(spice_bind))
1917       if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1918         raise errors.HypervisorError("spice: the %s parameter must be either"
1919                                      " a valid IP address or interface name" %
1920                                      constants.HV_KVM_SPICE_BIND)
1921
1922   @classmethod
1923   def PowercycleNode(cls):
1924     """KVM powercycle, just a wrapper over Linux powercycle.
1925
1926     """
1927     cls.LinuxPowercycle()