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

   1 #
   2 #
   3
   4 # Copyright (C) 2008, 2009, 2010, 2011, 2012 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, _KEYMAP_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(r"\s*transferred\s+ram:\s+(?P<transferred>\d+)\s+kbytes\s*\n"
 502                r"\s*remaining\s+ram:\s+(?P<remaining>\d+)\s+kbytes\s*\n"
 503                r"\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     @attention: this function must not have any side-effects; for
 948         example, it must not write to the filesystem, or read values
 949         from the current system the are expected to differ between
 950         nodes, since it is only run once at instance startup;
 951         actions/kvm arguments that can vary between systems should be
 952         done in L{_ExecuteKVMRuntime}
 953
 954     """
 955     # pylint: disable=R0914,R0915
 956     _, v_major, v_min, _ = self._GetKVMVersion()
 957
 958     pidfile = self._InstancePidFile(instance.name)
 959     kvm = constants.KVM_PATH
 960     kvm_cmd = [kvm]
 961     # used just by the vnc server, if enabled
 962     kvm_cmd.extend(["-name", instance.name])
 963     kvm_cmd.extend(["-m", instance.beparams[constants.BE_MAXMEM]])
 964     kvm_cmd.extend(["-smp", instance.beparams[constants.BE_VCPUS]])
 965     kvm_cmd.extend(["-pidfile", pidfile])
 966     kvm_cmd.extend(["-balloon", "virtio"])
 967     kvm_cmd.extend(["-daemonize"])
 968     if not instance.hvparams[constants.HV_ACPI]:
 969       kvm_cmd.extend(["-no-acpi"])
 970     if instance.hvparams[constants.HV_REBOOT_BEHAVIOR] == \
 971         constants.INSTANCE_REBOOT_EXIT:
 972       kvm_cmd.extend(["-no-reboot"])
 973
 974     hvp = instance.hvparams
 975     boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
 976     boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
 977     boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
 978     boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
 979
 980     self.ValidateParameters(hvp)
 981
 982     if startup_paused:
 983       kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
 984
 985     if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
 986       kvm_cmd.extend(["-enable-kvm"])
 987     elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
 988       kvm_cmd.extend(["-disable-kvm"])
 989
 990     if boot_network:
 991       kvm_cmd.extend(["-boot", "n"])
 992
 993     disk_type = hvp[constants.HV_DISK_TYPE]
 994     if disk_type == constants.HT_DISK_PARAVIRTUAL:
 995       if_val = ",if=virtio"
 996     else:
 997       if_val = ",if=%s" % disk_type
 998     # Cache mode
 999     disk_cache = hvp[constants.HV_DISK_CACHE]
1000     if instance.disk_template in constants.DTS_EXT_MIRROR:
1001       if disk_cache != "none":
1002         # TODO: make this a hard error, instead of a silent overwrite
1003         logging.warning("KVM: overriding disk_cache setting '%s' with 'none'"
1004                         " to prevent shared storage corruption on migration",
1005                         disk_cache)
1006       cache_val = ",cache=none"
1007     elif disk_cache != constants.HT_CACHE_DEFAULT:
1008       cache_val = ",cache=%s" % disk_cache
1009     else:
1010       cache_val = ""
1011     for cfdev, dev_path in block_devices:
1012       if cfdev.mode != constants.DISK_RDWR:
1013         raise errors.HypervisorError("Instance has read-only disks which"
1014                                      " are not supported by KVM")
1015       # TODO: handle FD_LOOP and FD_BLKTAP (?)
1016       boot_val = ""
1017       if boot_disk:
1018         kvm_cmd.extend(["-boot", "c"])
1019         boot_disk = False
1020         if (v_major, v_min) < (0, 14) and disk_type != constants.HT_DISK_IDE:
1021           boot_val = ",boot=on"
1022
1023       drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
1024                                                 cache_val)
1025       kvm_cmd.extend(["-drive", drive_val])
1026
1027     #Now we can specify a different device type for CDROM devices.
1028     cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
1029     if not cdrom_disk_type:
1030       cdrom_disk_type = disk_type
1031
1032     iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
1033     if iso_image:
1034       options = ",format=raw,media=cdrom"
1035       if boot_cdrom:
1036         kvm_cmd.extend(["-boot", "d"])
1037         if cdrom_disk_type != constants.HT_DISK_IDE:
1038           options = "%s,boot=on,if=%s" % (options, constants.HT_DISK_IDE)
1039         else:
1040           options = "%s,boot=on" % options
1041       else:
1042         if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1043           if_val = ",if=virtio"
1044         else:
1045           if_val = ",if=%s" % cdrom_disk_type
1046         options = "%s%s" % (options, if_val)
1047       drive_val = "file=%s%s" % (iso_image, options)
1048       kvm_cmd.extend(["-drive", drive_val])
1049
1050     iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
1051     if iso_image2:
1052       options = ",format=raw,media=cdrom"
1053       if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1054         if_val = ",if=virtio"
1055       else:
1056         if_val = ",if=%s" % cdrom_disk_type
1057       options = "%s%s" % (options, if_val)
1058       drive_val = "file=%s%s" % (iso_image2, options)
1059       kvm_cmd.extend(["-drive", drive_val])
1060
1061     floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
1062     if floppy_image:
1063       options = ",format=raw,media=disk"
1064       if boot_floppy:
1065         kvm_cmd.extend(["-boot", "a"])
1066         options = "%s,boot=on" % options
1067       if_val = ",if=floppy"
1068       options = "%s%s" % (options, if_val)
1069       drive_val = "file=%s%s" % (floppy_image, options)
1070       kvm_cmd.extend(["-drive", drive_val])
1071
1072     kernel_path = hvp[constants.HV_KERNEL_PATH]
1073     if kernel_path:
1074       kvm_cmd.extend(["-kernel", kernel_path])
1075       initrd_path = hvp[constants.HV_INITRD_PATH]
1076       if initrd_path:
1077         kvm_cmd.extend(["-initrd", initrd_path])
1078       root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
1079                      hvp[constants.HV_KERNEL_ARGS]]
1080       if hvp[constants.HV_SERIAL_CONSOLE]:
1081         root_append.append("console=ttyS0,38400")
1082       kvm_cmd.extend(["-append", " ".join(root_append)])
1083
1084     mem_path = hvp[constants.HV_MEM_PATH]
1085     if mem_path:
1086       kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
1087
1088     monitor_dev = ("unix:%s,server,nowait" %
1089                    self._InstanceMonitor(instance.name))
1090     kvm_cmd.extend(["-monitor", monitor_dev])
1091     if hvp[constants.HV_SERIAL_CONSOLE]:
1092       serial_dev = ("unix:%s,server,nowait" %
1093                     self._InstanceSerial(instance.name))
1094       kvm_cmd.extend(["-serial", serial_dev])
1095     else:
1096       kvm_cmd.extend(["-serial", "none"])
1097
1098     mouse_type = hvp[constants.HV_USB_MOUSE]
1099     vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
1100     spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
1101     spice_ip_version = None
1102
1103     if mouse_type:
1104       kvm_cmd.extend(["-usb"])
1105       kvm_cmd.extend(["-usbdevice", mouse_type])
1106     elif vnc_bind_address:
1107       kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
1108
1109     if vnc_bind_address:
1110       if netutils.IP4Address.IsValid(vnc_bind_address):
1111         if instance.network_port > constants.VNC_BASE_PORT:
1112           display = instance.network_port - constants.VNC_BASE_PORT
1113           if vnc_bind_address == constants.IP4_ADDRESS_ANY:
1114             vnc_arg = ":%d" % (display)
1115           else:
1116             vnc_arg = "%s:%d" % (vnc_bind_address, display)
1117         else:
1118           logging.error("Network port is not a valid VNC display (%d < %d)."
1119                         " Not starting VNC", instance.network_port,
1120                         constants.VNC_BASE_PORT)
1121           vnc_arg = "none"
1122
1123         # Only allow tls and other option when not binding to a file, for now.
1124         # kvm/qemu gets confused otherwise about the filename to use.
1125         vnc_append = ""
1126         if hvp[constants.HV_VNC_TLS]:
1127           vnc_append = "%s,tls" % vnc_append
1128           if hvp[constants.HV_VNC_X509_VERIFY]:
1129             vnc_append = "%s,x509verify=%s" % (vnc_append,
1130                                                hvp[constants.HV_VNC_X509])
1131           elif hvp[constants.HV_VNC_X509]:
1132             vnc_append = "%s,x509=%s" % (vnc_append,
1133                                          hvp[constants.HV_VNC_X509])
1134         if hvp[constants.HV_VNC_PASSWORD_FILE]:
1135           vnc_append = "%s,password" % vnc_append
1136
1137         vnc_arg = "%s%s" % (vnc_arg, vnc_append)
1138
1139       else:
1140         vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
1141
1142       kvm_cmd.extend(["-vnc", vnc_arg])
1143     elif spice_bind:
1144       # FIXME: this is wrong here; the iface ip address differs
1145       # between systems, so it should be done in _ExecuteKVMRuntime
1146       if netutils.IsValidInterface(spice_bind):
1147         # The user specified a network interface, we have to figure out the IP
1148         # address.
1149         addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1150         spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1151
1152         # if the user specified an IP version and the interface does not
1153         # have that kind of IP addresses, throw an exception
1154         if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1155           if not addresses[spice_ip_version]:
1156             raise errors.HypervisorError("spice: unable to get an IPv%s address"
1157                                          " for %s" % (spice_ip_version,
1158                                                       spice_bind))
1159
1160         # the user did not specify an IP version, we have to figure it out
1161         elif (addresses[constants.IP4_VERSION] and
1162               addresses[constants.IP6_VERSION]):
1163           # we have both ipv4 and ipv6, let's use the cluster default IP
1164           # version
1165           cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1166           spice_ip_version = \
1167             netutils.IPAddress.GetVersionFromAddressFamily(cluster_family)
1168         elif addresses[constants.IP4_VERSION]:
1169           spice_ip_version = constants.IP4_VERSION
1170         elif addresses[constants.IP6_VERSION]:
1171           spice_ip_version = constants.IP6_VERSION
1172         else:
1173           raise errors.HypervisorError("spice: unable to get an IP address"
1174                                        " for %s" % (spice_bind))
1175
1176         spice_address = addresses[spice_ip_version][0]
1177
1178       else:
1179         # spice_bind is known to be a valid IP address, because
1180         # ValidateParameters checked it.
1181         spice_address = spice_bind
1182
1183       spice_arg = "addr=%s" % spice_address
1184       if hvp[constants.HV_KVM_SPICE_USE_TLS]:
1185         spice_arg = "%s,tls-port=%s,x509-cacert-file=%s" % (spice_arg,
1186             instance.network_port, constants.SPICE_CACERT_FILE)
1187         spice_arg = "%s,x509-key-file=%s,x509-cert-file=%s" % (spice_arg,
1188             constants.SPICE_CERT_FILE, constants.SPICE_CERT_FILE)
1189         tls_ciphers = hvp[constants.HV_KVM_SPICE_TLS_CIPHERS]
1190         if tls_ciphers:
1191           spice_arg = "%s,tls-ciphers=%s" % (spice_arg, tls_ciphers)
1192       else:
1193         spice_arg = "%s,port=%s" % (spice_arg, instance.network_port)
1194
1195       if not hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]:
1196         spice_arg = "%s,disable-ticketing" % spice_arg
1197
1198       if spice_ip_version:
1199         spice_arg = "%s,ipv%s" % (spice_arg, spice_ip_version)
1200
1201       # Image compression options
1202       img_lossless = hvp[constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR]
1203       img_jpeg = hvp[constants.HV_KVM_SPICE_JPEG_IMG_COMPR]
1204       img_zlib_glz = hvp[constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR]
1205       if img_lossless:
1206         spice_arg = "%s,image-compression=%s" % (spice_arg, img_lossless)
1207       if img_jpeg:
1208         spice_arg = "%s,jpeg-wan-compression=%s" % (spice_arg, img_jpeg)
1209       if img_zlib_glz:
1210         spice_arg = "%s,zlib-glz-wan-compression=%s" % (spice_arg, img_zlib_glz)
1211
1212       # Video stream detection
1213       video_streaming = hvp[constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION]
1214       if video_streaming:
1215         spice_arg = "%s,streaming-video=%s" % (spice_arg, video_streaming)
1216
1217       # Audio compression, by default in qemu-kvm it is on
1218       if not hvp[constants.HV_KVM_SPICE_AUDIO_COMPR]:
1219         spice_arg = "%s,playback-compression=off" % spice_arg
1220       if not hvp[constants.HV_KVM_SPICE_USE_VDAGENT]:
1221         spice_arg = "%s,agent-mouse=off" % spice_arg
1222       else:
1223         # Enable the spice agent communication channel between the host and the
1224         # agent.
1225         kvm_cmd.extend(["-device", "virtio-serial-pci"])
1226         kvm_cmd.extend(["-device", "virtserialport,chardev=spicechannel0,"
1227                                                    "name=com.redhat.spice.0"])
1228         kvm_cmd.extend(["-chardev", "spicevmc,id=spicechannel0,name=vdagent"])
1229
1230       logging.info("KVM: SPICE will listen on port %s", instance.network_port)
1231       kvm_cmd.extend(["-spice", spice_arg])
1232
1233       # Tell kvm to use the paravirtualized graphic card, optimized for SPICE
1234       kvm_cmd.extend(["-vga", "qxl"])
1235
1236     else:
1237       kvm_cmd.extend(["-nographic"])
1238
1239     if hvp[constants.HV_USE_LOCALTIME]:
1240       kvm_cmd.extend(["-localtime"])
1241
1242     if hvp[constants.HV_KVM_USE_CHROOT]:
1243       kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1244
1245     # Save the current instance nics, but defer their expansion as parameters,
1246     # as we'll need to generate executable temp files for them.
1247     kvm_nics = instance.nics
1248     hvparams = hvp
1249
1250     return (kvm_cmd, kvm_nics, hvparams)
1251
1252   def _WriteKVMRuntime(self, instance_name, data):
1253     """Write an instance's KVM runtime
1254
1255     """
1256     try:
1257       utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1258                       data=data)
1259     except EnvironmentError, err:
1260       raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1261
1262   def _ReadKVMRuntime(self, instance_name):
1263     """Read an instance's KVM runtime
1264
1265     """
1266     try:
1267       file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1268     except EnvironmentError, err:
1269       raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1270     return file_content
1271
1272   def _SaveKVMRuntime(self, instance, kvm_runtime):
1273     """Save an instance's KVM runtime
1274
1275     """
1276     kvm_cmd, kvm_nics, hvparams = kvm_runtime
1277     serialized_nics = [nic.ToDict() for nic in kvm_nics]
1278     serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1279     self._WriteKVMRuntime(instance.name, serialized_form)
1280
1281   def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1282     """Load an instance's KVM runtime
1283
1284     """
1285     if not serialized_runtime:
1286       serialized_runtime = self._ReadKVMRuntime(instance.name)
1287     loaded_runtime = serializer.Load(serialized_runtime)
1288     kvm_cmd, serialized_nics, hvparams = loaded_runtime
1289     kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1290     return (kvm_cmd, kvm_nics, hvparams)
1291
1292   def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1293     """Run the KVM cmd and check for errors
1294
1295     @type name: string
1296     @param name: instance name
1297     @type kvm_cmd: list of strings
1298     @param kvm_cmd: runcmd input for kvm
1299     @type tap_fds: list of int
1300     @param tap_fds: fds of tap devices opened by Ganeti
1301
1302     """
1303     try:
1304       result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1305     finally:
1306       for fd in tap_fds:
1307         utils_wrapper.CloseFdNoError(fd)
1308
1309     if result.failed:
1310       raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1311                                    (name, result.fail_reason, result.output))
1312     if not self._InstancePidAlive(name)[2]:
1313       raise errors.HypervisorError("Failed to start instance %s" % name)
1314
1315   def _ExecuteKVMRuntime(self, instance, kvm_runtime, incoming=None):
1316     """Execute a KVM cmd, after completing it with some last minute data.
1317
1318     @type incoming: tuple of strings
1319     @param incoming: (target_host_ip, port)
1320
1321     """
1322     # Small _ExecuteKVMRuntime hv parameters programming howto:
1323     #  - conf_hvp contains the parameters as configured on ganeti. they might
1324     #    have changed since the instance started; only use them if the change
1325     #    won't affect the inside of the instance (which hasn't been rebooted).
1326     #  - up_hvp contains the parameters as they were when the instance was
1327     #    started, plus any new parameter which has been added between ganeti
1328     #    versions: it is paramount that those default to a value which won't
1329     #    affect the inside of the instance as well.
1330     conf_hvp = instance.hvparams
1331     name = instance.name
1332     self._CheckDown(name)
1333
1334     temp_files = []
1335
1336     kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1337     up_hvp = objects.FillDict(conf_hvp, up_hvp)
1338
1339     _, v_major, v_min, _ = self._GetKVMVersion()
1340
1341     # We know it's safe to run as a different user upon migration, so we'll use
1342     # the latest conf, from conf_hvp.
1343     security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1344     if security_model == constants.HT_SM_USER:
1345       kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1346
1347     keymap = conf_hvp[constants.HV_KEYMAP]
1348     if keymap:
1349       keymap_path = self._InstanceKeymapFile(name)
1350       # If a keymap file is specified, KVM won't use its internal defaults. By
1351       # first including the "en-us" layout, an error on loading the actual
1352       # layout (e.g. because it can't be found) won't lead to a non-functional
1353       # keyboard. A keyboard with incorrect keys is still better than none.
1354       utils.WriteFile(keymap_path, data="include en-us\ninclude %s\n" % keymap)
1355       kvm_cmd.extend(["-k", keymap_path])
1356
1357     # We have reasons to believe changing something like the nic driver/type
1358     # upon migration won't exactly fly with the instance kernel, so for nic
1359     # related parameters we'll use up_hvp
1360     tapfds = []
1361     taps = []
1362     if not kvm_nics:
1363       kvm_cmd.extend(["-net", "none"])
1364     else:
1365       vnet_hdr = False
1366       tap_extra = ""
1367       nic_type = up_hvp[constants.HV_NIC_TYPE]
1368       if nic_type == constants.HT_NIC_PARAVIRTUAL:
1369         # From version 0.12.0, kvm uses a new sintax for network configuration.
1370         if (v_major, v_min) >= (0, 12):
1371           nic_model = "virtio-net-pci"
1372           vnet_hdr = True
1373         else:
1374           nic_model = "virtio"
1375
1376         if up_hvp[constants.HV_VHOST_NET]:
1377           # vhost_net is only available from version 0.13.0 or newer
1378           if (v_major, v_min) >= (0, 13):
1379             tap_extra = ",vhost=on"
1380           else:
1381             raise errors.HypervisorError("vhost_net is configured"
1382                                         " but it is not available")
1383       else:
1384         nic_model = nic_type
1385
1386       for nic_seq, nic in enumerate(kvm_nics):
1387         tapname, tapfd = _OpenTap(vnet_hdr)
1388         tapfds.append(tapfd)
1389         taps.append(tapname)
1390         if (v_major, v_min) >= (0, 12):
1391           nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1392           tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1393           kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1394         else:
1395           nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1396                                                          nic.mac, nic_model)
1397           tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1398           kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1399
1400     if incoming:
1401       target, port = incoming
1402       kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1403
1404     # Changing the vnc password doesn't bother the guest that much. At most it
1405     # will surprise people who connect to it. Whether positively or negatively
1406     # it's debatable.
1407     vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1408     vnc_pwd = None
1409     if vnc_pwd_file:
1410       try:
1411         vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1412       except EnvironmentError, err:
1413         raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1414                                      % (vnc_pwd_file, err))
1415
1416     if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1417       utils.EnsureDirs([(self._InstanceChrootDir(name),
1418                          constants.SECURE_DIR_MODE)])
1419
1420     # Automatically enable QMP if version is >= 0.14
1421     if (v_major, v_min) >= (0, 14):
1422       logging.debug("Enabling QMP")
1423       kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1424                     self._InstanceQmpMonitor(instance.name)])
1425
1426     # Configure the network now for starting instances and bridged interfaces,
1427     # during FinalizeMigration for incoming instances' routed interfaces
1428     for nic_seq, nic in enumerate(kvm_nics):
1429       if (incoming and
1430           nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1431         continue
1432       self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1433
1434     # CPU affinity requires kvm to start paused, so we set this flag if the
1435     # instance is not already paused and if we are not going to accept a
1436     # migrating instance. In the latter case, pausing is not needed.
1437     start_kvm_paused = not (_KVM_START_PAUSED_FLAG in kvm_cmd) and not incoming
1438     if start_kvm_paused:
1439       kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
1440
1441     # Note: CPU pinning is using up_hvp since changes take effect
1442     # during instance startup anyway, and to avoid problems when soft
1443     # rebooting the instance.
1444     cpu_pinning = False
1445     if up_hvp.get(constants.HV_CPU_MASK, None):
1446       cpu_pinning = True
1447
1448     if security_model == constants.HT_SM_POOL:
1449       ss = ssconf.SimpleStore()
1450       uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1451       all_uids = set(uidpool.ExpandUidPool(uid_pool))
1452       uid = uidpool.RequestUnusedUid(all_uids)
1453       try:
1454         username = pwd.getpwuid(uid.GetUid()).pw_name
1455         kvm_cmd.extend(["-runas", username])
1456         self._RunKVMCmd(name, kvm_cmd, tapfds)
1457       except:
1458         uidpool.ReleaseUid(uid)
1459         raise
1460       else:
1461         uid.Unlock()
1462         utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1463     else:
1464       self._RunKVMCmd(name, kvm_cmd, tapfds)
1465
1466     utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1467                      constants.RUN_DIRS_MODE)])
1468     for nic_seq, tap in enumerate(taps):
1469       utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1470                       data=tap)
1471
1472     if vnc_pwd:
1473       change_cmd = "change vnc password %s" % vnc_pwd
1474       self._CallMonitorCommand(instance.name, change_cmd)
1475
1476     # Setting SPICE password. We are not vulnerable to malicious passwordless
1477     # connection attempts because SPICE by default does not allow connections
1478     # if neither a password nor the "disable_ticketing" options are specified.
1479     # As soon as we send the password via QMP, that password is a valid ticket
1480     # for connection.
1481     spice_password_file = conf_hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]
1482     if spice_password_file:
1483       spice_pwd = ""
1484       try:
1485         spice_pwd = utils.ReadOneLineFile(spice_password_file, strict=True)
1486       except EnvironmentError, err:
1487         raise errors.HypervisorError("Failed to open SPICE password file %s: %s"
1488                                      % (spice_password_file, err))
1489
1490       qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1491       qmp.connect()
1492       arguments = {
1493           "protocol": "spice",
1494           "password": spice_pwd,
1495       }
1496       qmp.Execute("set_password", arguments)
1497
1498     for filename in temp_files:
1499       utils.RemoveFile(filename)
1500
1501     # If requested, set CPU affinity and resume instance execution
1502     if cpu_pinning:
1503       self._ExecuteCpuAffinity(instance.name, up_hvp[constants.HV_CPU_MASK])
1504
1505     start_memory = self._InstanceStartupMemory(instance)
1506     if start_memory < instance.beparams[constants.BE_MAXMEM]:
1507       self.BalloonInstanceMemory(instance, start_memory)
1508
1509     if start_kvm_paused:
1510       # To control CPU pinning, ballooning, and vnc/spice passwords the VM was
1511       # started in a frozen state. If freezing was not explicitely requested
1512       # resume the vm status.
1513       self._CallMonitorCommand(instance.name, self._CONT_CMD)
1514
1515   def StartInstance(self, instance, block_devices, startup_paused):
1516     """Start an instance.
1517
1518     """
1519     self._CheckDown(instance.name)
1520     kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1521                                            startup_paused)
1522     self._SaveKVMRuntime(instance, kvm_runtime)
1523     self._ExecuteKVMRuntime(instance, kvm_runtime)
1524
1525   def _CallMonitorCommand(self, instance_name, command):
1526     """Invoke a command on the instance monitor.
1527
1528     """
1529     socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1530              (utils.ShellQuote(command),
1531               constants.SOCAT_PATH,
1532               utils.ShellQuote(self._InstanceMonitor(instance_name))))
1533     result = utils.RunCmd(socat)
1534     if result.failed:
1535       msg = ("Failed to send command '%s' to instance %s."
1536              " output: %s, error: %s, fail_reason: %s" %
1537              (command, instance_name,
1538               result.stdout, result.stderr, result.fail_reason))
1539       raise errors.HypervisorError(msg)
1540
1541     return result
1542
1543   @classmethod
1544   def _ParseKVMVersion(cls, text):
1545     """Parse the KVM version from the --help output.
1546
1547     @type text: string
1548     @param text: output of kvm --help
1549     @return: (version, v_maj, v_min, v_rev)
1550     @raise L{errors.HypervisorError}: when the KVM version cannot be retrieved
1551
1552     """
1553     match = cls._VERSION_RE.search(text.splitlines()[0])
1554     if not match:
1555       raise errors.HypervisorError("Unable to get KVM version")
1556
1557     v_all = match.group(0)
1558     v_maj = int(match.group(1))
1559     v_min = int(match.group(2))
1560     if match.group(4):
1561       v_rev = int(match.group(4))
1562     else:
1563       v_rev = 0
1564     return (v_all, v_maj, v_min, v_rev)
1565
1566   @classmethod
1567   def _GetKVMVersion(cls):
1568     """Return the installed KVM version.
1569
1570     @return: (version, v_maj, v_min, v_rev)
1571     @raise L{errors.HypervisorError}: when the KVM version cannot be retrieved
1572
1573     """
1574     result = utils.RunCmd([constants.KVM_PATH, "--help"])
1575     if result.failed:
1576       raise errors.HypervisorError("Unable to get KVM version")
1577     return cls._ParseKVMVersion(result.output)
1578
1579   def StopInstance(self, instance, force=False, retry=False, name=None):
1580     """Stop an instance.
1581
1582     """
1583     if name is not None and not force:
1584       raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1585     if name is None:
1586       name = instance.name
1587       acpi = instance.hvparams[constants.HV_ACPI]
1588     else:
1589       acpi = False
1590     _, pid, alive = self._InstancePidAlive(name)
1591     if pid > 0 and alive:
1592       if force or not acpi:
1593         utils.KillProcess(pid)
1594       else:
1595         self._CallMonitorCommand(name, "system_powerdown")
1596
1597   def CleanupInstance(self, instance_name):
1598     """Cleanup after a stopped instance
1599
1600     """
1601     pidfile, pid, alive = self._InstancePidAlive(instance_name)
1602     if pid > 0 and alive:
1603       raise errors.HypervisorError("Cannot cleanup a live instance")
1604     self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1605
1606   def RebootInstance(self, instance):
1607     """Reboot an instance.
1608
1609     """
1610     # For some reason if we do a 'send-key ctrl-alt-delete' to the control
1611     # socket the instance will stop, but now power up again. So we'll resort
1612     # to shutdown and restart.
1613     _, _, alive = self._InstancePidAlive(instance.name)
1614     if not alive:
1615       raise errors.HypervisorError("Failed to reboot instance %s:"
1616                                    " not running" % instance.name)
1617     # StopInstance will delete the saved KVM runtime so:
1618     # ...first load it...
1619     kvm_runtime = self._LoadKVMRuntime(instance)
1620     # ...now we can safely call StopInstance...
1621     if not self.StopInstance(instance):
1622       self.StopInstance(instance, force=True)
1623     # ...and finally we can save it again, and execute it...
1624     self._SaveKVMRuntime(instance, kvm_runtime)
1625     self._ExecuteKVMRuntime(instance, kvm_runtime)
1626
1627   def MigrationInfo(self, instance):
1628     """Get instance information to perform a migration.
1629
1630     @type instance: L{objects.Instance}
1631     @param instance: instance to be migrated
1632     @rtype: string
1633     @return: content of the KVM runtime file
1634
1635     """
1636     return self._ReadKVMRuntime(instance.name)
1637
1638   def AcceptInstance(self, instance, info, target):
1639     """Prepare to accept an instance.
1640
1641     @type instance: L{objects.Instance}
1642     @param instance: instance to be accepted
1643     @type info: string
1644     @param info: content of the KVM runtime file on the source node
1645     @type target: string
1646     @param target: target host (usually ip), on this node
1647
1648     """
1649     kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1650     incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1651     self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1652
1653   def FinalizeMigrationDst(self, instance, info, success):
1654     """Finalize the instance migration on the target node.
1655
1656     Stop the incoming mode KVM.
1657
1658     @type instance: L{objects.Instance}
1659     @param instance: instance whose migration is being finalized
1660
1661     """
1662     if success:
1663       kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1664       kvm_nics = kvm_runtime[1]
1665
1666       for nic_seq, nic in enumerate(kvm_nics):
1667         if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1668           # Bridged interfaces have already been configured
1669           continue
1670         try:
1671           tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1672         except EnvironmentError, err:
1673           logging.warning("Failed to find host interface for %s NIC #%d: %s",
1674                           instance.name, nic_seq, str(err))
1675           continue
1676         try:
1677           self._ConfigureNIC(instance, nic_seq, nic, tap)
1678         except errors.HypervisorError, err:
1679           logging.warning(str(err))
1680
1681       self._WriteKVMRuntime(instance.name, info)
1682     else:
1683       self.StopInstance(instance, force=True)
1684
1685   def MigrateInstance(self, instance, target, live):
1686     """Migrate an instance to a target node.
1687
1688     The migration will not be attempted if the instance is not
1689     currently running.
1690
1691     @type instance: L{objects.Instance}
1692     @param instance: the instance to be migrated
1693     @type target: string
1694     @param target: ip address of the target node
1695     @type live: boolean
1696     @param live: perform a live migration
1697
1698     """
1699     instance_name = instance.name
1700     port = instance.hvparams[constants.HV_MIGRATION_PORT]
1701     _, _, alive = self._InstancePidAlive(instance_name)
1702     if not alive:
1703       raise errors.HypervisorError("Instance not running, cannot migrate")
1704
1705     if not live:
1706       self._CallMonitorCommand(instance_name, "stop")
1707
1708     migrate_command = ("migrate_set_speed %dm" %
1709         instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1710     self._CallMonitorCommand(instance_name, migrate_command)
1711
1712     migrate_command = ("migrate_set_downtime %dms" %
1713         instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1714     self._CallMonitorCommand(instance_name, migrate_command)
1715
1716     migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1717     self._CallMonitorCommand(instance_name, migrate_command)
1718
1719   def FinalizeMigrationSource(self, instance, success, live):
1720     """Finalize the instance migration on the source node.
1721
1722     @type instance: L{objects.Instance}
1723     @param instance: the instance that was migrated
1724     @type success: bool
1725     @param success: whether the migration succeeded or not
1726     @type live: bool
1727     @param live: whether the user requested a live migration or not
1728
1729     """
1730     if success:
1731       pidfile, pid, _ = self._InstancePidAlive(instance.name)
1732       utils.KillProcess(pid)
1733       self._RemoveInstanceRuntimeFiles(pidfile, instance.name)
1734     elif live:
1735       self._CallMonitorCommand(instance.name, self._CONT_CMD)
1736
1737   def GetMigrationStatus(self, instance):
1738     """Get the migration status
1739
1740     @type instance: L{objects.Instance}
1741     @param instance: the instance that is being migrated
1742     @rtype: L{objects.MigrationStatus}
1743     @return: the status of the current migration (one of
1744              L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1745              progress info that can be retrieved from the hypervisor
1746
1747     """
1748     info_command = "info migrate"
1749     for _ in range(self._MIGRATION_INFO_MAX_BAD_ANSWERS):
1750       result = self._CallMonitorCommand(instance.name, info_command)
1751       match = self._MIGRATION_STATUS_RE.search(result.stdout)
1752       if not match:
1753         if not result.stdout:
1754           logging.info("KVM: empty 'info migrate' result")
1755         else:
1756           logging.warning("KVM: unknown 'info migrate' result: %s",
1757                           result.stdout)
1758       else:
1759         status = match.group(1)
1760         if status in constants.HV_KVM_MIGRATION_VALID_STATUSES:
1761           migration_status = objects.MigrationStatus(status=status)
1762           match = self._MIGRATION_PROGRESS_RE.search(result.stdout)
1763           if match:
1764             migration_status.transferred_ram = match.group("transferred")
1765             migration_status.total_ram = match.group("total")
1766
1767           return migration_status
1768
1769         logging.warning("KVM: unknown migration status '%s'", status)
1770
1771       time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1772
1773     return objects.MigrationStatus(status=constants.HV_MIGRATION_FAILED,
1774                                   info="Too many 'info migrate' broken answers")
1775
1776   def BalloonInstanceMemory(self, instance, mem):
1777     """Balloon an instance memory to a certain value.
1778
1779     @type instance: L{objects.Instance}
1780     @param instance: instance to be accepted
1781     @type mem: int
1782     @param mem: actual memory size to use for instance runtime
1783
1784     """
1785     self._CallMonitorCommand(instance.name, "balloon %d" % mem)
1786
1787   def GetNodeInfo(self):
1788     """Return information about the node.
1789
1790     @return: a dict with the following keys (values in MiB):
1791           - memory_total: the total memory size on the node
1792           - memory_free: the available memory on the node for instances
1793           - memory_dom0: the memory used by the node itself, if available
1794           - hv_version: the hypervisor version in the form (major, minor,
1795                         revision)
1796
1797     """
1798     result = self.GetLinuxNodeInfo()
1799     _, v_major, v_min, v_rev = self._GetKVMVersion()
1800     result[constants.HV_NODEINFO_KEY_VERSION] = (v_major, v_min, v_rev)
1801     return result
1802
1803   @classmethod
1804   def GetInstanceConsole(cls, instance, hvparams, beparams):
1805     """Return a command for connecting to the console of an instance.
1806
1807     """
1808     if hvparams[constants.HV_SERIAL_CONSOLE]:
1809       cmd = [constants.KVM_CONSOLE_WRAPPER,
1810              constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1811              utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1812              "STDIO,%s" % cls._SocatUnixConsoleParams(),
1813              "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1814       return objects.InstanceConsole(instance=instance.name,
1815                                      kind=constants.CONS_SSH,
1816                                      host=instance.primary_node,
1817                                      user=constants.GANETI_RUNAS,
1818                                      command=cmd)
1819
1820     vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1821     if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1822       display = instance.network_port - constants.VNC_BASE_PORT
1823       return objects.InstanceConsole(instance=instance.name,
1824                                      kind=constants.CONS_VNC,
1825                                      host=vnc_bind_address,
1826                                      port=instance.network_port,
1827                                      display=display)
1828
1829     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1830     if spice_bind:
1831       return objects.InstanceConsole(instance=instance.name,
1832                                      kind=constants.CONS_SPICE,
1833                                      host=spice_bind,
1834                                      port=instance.network_port)
1835
1836     return objects.InstanceConsole(instance=instance.name,
1837                                    kind=constants.CONS_MESSAGE,
1838                                    message=("No serial shell for instance %s" %
1839                                             instance.name))
1840
1841   def Verify(self):
1842     """Verify the hypervisor.
1843
1844     Check that the binary exists.
1845
1846     """
1847     if not os.path.exists(constants.KVM_PATH):
1848       return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1849     if not os.path.exists(constants.SOCAT_PATH):
1850       return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1851
1852   @classmethod
1853   def CheckParameterSyntax(cls, hvparams):
1854     """Check the given parameters for validity.
1855
1856     @type hvparams:  dict
1857     @param hvparams: dictionary with parameter names/value
1858     @raise errors.HypervisorError: when a parameter is not valid
1859
1860     """
1861     super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1862
1863     kernel_path = hvparams[constants.HV_KERNEL_PATH]
1864     if kernel_path:
1865       if not hvparams[constants.HV_ROOT_PATH]:
1866         raise errors.HypervisorError("Need a root partition for the instance,"
1867                                      " if a kernel is defined")
1868
1869     if (hvparams[constants.HV_VNC_X509_VERIFY] and
1870         not hvparams[constants.HV_VNC_X509]):
1871       raise errors.HypervisorError("%s must be defined, if %s is" %
1872                                    (constants.HV_VNC_X509,
1873                                     constants.HV_VNC_X509_VERIFY))
1874
1875     boot_order = hvparams[constants.HV_BOOT_ORDER]
1876     if (boot_order == constants.HT_BO_CDROM and
1877         not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1878       raise errors.HypervisorError("Cannot boot from cdrom without an"
1879                                    " ISO path")
1880
1881     security_model = hvparams[constants.HV_SECURITY_MODEL]
1882     if security_model == constants.HT_SM_USER:
1883       if not hvparams[constants.HV_SECURITY_DOMAIN]:
1884         raise errors.HypervisorError("A security domain (user to run kvm as)"
1885                                      " must be specified")
1886     elif (security_model == constants.HT_SM_NONE or
1887           security_model == constants.HT_SM_POOL):
1888       if hvparams[constants.HV_SECURITY_DOMAIN]:
1889         raise errors.HypervisorError("Cannot have a security domain when the"
1890                                      " security model is 'none' or 'pool'")
1891
1892     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1893     spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1894     if spice_bind:
1895       if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1896         # if an IP version is specified, the spice_bind parameter must be an
1897         # IP of that family
1898         if (netutils.IP4Address.IsValid(spice_bind) and
1899             spice_ip_version != constants.IP4_VERSION):
1900           raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1901                                        " the specified IP version is %s" %
1902                                        (spice_bind, spice_ip_version))
1903
1904         if (netutils.IP6Address.IsValid(spice_bind) and
1905             spice_ip_version != constants.IP6_VERSION):
1906           raise errors.HypervisorError("spice: got an IPv6 address (%s), but"
1907                                        " the specified IP version is %s" %
1908                                        (spice_bind, spice_ip_version))
1909     else:
1910       # All the other SPICE parameters depend on spice_bind being set. Raise an
1911       # error if any of them is set without it.
1912       spice_additional_params = frozenset([
1913         constants.HV_KVM_SPICE_IP_VERSION,
1914         constants.HV_KVM_SPICE_PASSWORD_FILE,
1915         constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR,
1916         constants.HV_KVM_SPICE_JPEG_IMG_COMPR,
1917         constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR,
1918         constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION,
1919         constants.HV_KVM_SPICE_USE_TLS,
1920         ])
1921       for param in spice_additional_params:
1922         if hvparams[param]:
1923           raise errors.HypervisorError("spice: %s requires %s to be set" %
1924                                        (param, constants.HV_KVM_SPICE_BIND))
1925
1926   @classmethod
1927   def ValidateParameters(cls, hvparams):
1928     """Check the given parameters for validity.
1929
1930     @type hvparams:  dict
1931     @param hvparams: dictionary with parameter names/value
1932     @raise errors.HypervisorError: when a parameter is not valid
1933
1934     """
1935     super(KVMHypervisor, cls).ValidateParameters(hvparams)
1936
1937     security_model = hvparams[constants.HV_SECURITY_MODEL]
1938     if security_model == constants.HT_SM_USER:
1939       username = hvparams[constants.HV_SECURITY_DOMAIN]
1940       try:
1941         pwd.getpwnam(username)
1942       except KeyError:
1943         raise errors.HypervisorError("Unknown security domain user %s"
1944                                      % username)
1945
1946     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1947     if spice_bind:
1948       # only one of VNC and SPICE can be used currently.
1949       if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1950         raise errors.HypervisorError("both SPICE and VNC are configured, but"
1951                                      " only one of them can be used at a"
1952                                      " given time.")
1953
1954       # KVM version should be >= 0.14.0
1955       _, v_major, v_min, _ = cls._GetKVMVersion()
1956       if (v_major, v_min) < (0, 14):
1957         raise errors.HypervisorError("spice is configured, but it is not"
1958                                      " available in versions of KVM < 0.14")
1959
1960       # if spice_bind is not an IP address, it must be a valid interface
1961       bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1962                        or netutils.IP6Address.IsValid(spice_bind))
1963       if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1964         raise errors.HypervisorError("spice: the %s parameter must be either"
1965                                      " a valid IP address or interface name" %
1966                                      constants.HV_KVM_SPICE_BIND)
1967
1968   @classmethod
1969   def PowercycleNode(cls):
1970     """KVM powercycle, just a wrapper over Linux powercycle.
1971
1972     """
1973     cls.LinuxPowercycle()