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(
 450         False, constants.HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS),
 451     constants.HV_KVM_SPICE_JPEG_IMG_COMPR:
 452       hv_base.ParamInSet(
 453         False, constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
 454     constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR:
 455       hv_base.ParamInSet(
 456         False, constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
 457     constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION:
 458       hv_base.ParamInSet(
 459         False, 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     constants.HV_CPU_TYPE: hv_base.NO_CHECK
 497     }
 498
 499   _MIGRATION_STATUS_RE = re.compile("Migration\s+status:\s+(\w+)",
 500                                     re.M | re.I)
 501   _MIGRATION_PROGRESS_RE = \
 502     re.compile(r"\s*transferred\s+ram:\s+(?P<transferred>\d+)\s+kbytes\s*\n"
 503                r"\s*remaining\s+ram:\s+(?P<remaining>\d+)\s+kbytes\s*\n"
 504                r"\s*total\s+ram:\s+(?P<total>\d+)\s+kbytes\s*\n", re.I)
 505
 506   _MIGRATION_INFO_MAX_BAD_ANSWERS = 5
 507   _MIGRATION_INFO_RETRY_DELAY = 2
 508
 509   _VERSION_RE = re.compile(r"\b(\d+)\.(\d+)(\.(\d+))?\b")
 510
 511   _CPU_INFO_RE = re.compile(r"cpu\s+\#(\d+).*thread_id\s*=\s*(\d+)", re.I)
 512   _CPU_INFO_CMD = "info cpus"
 513   _CONT_CMD = "cont"
 514
 515   ANCILLARY_FILES = [
 516     _KVM_NETWORK_SCRIPT,
 517     ]
 518   ANCILLARY_FILES_OPT = [
 519     _KVM_NETWORK_SCRIPT,
 520     ]
 521
 522   def __init__(self):
 523     hv_base.BaseHypervisor.__init__(self)
 524     # Let's make sure the directories we need exist, even if the RUN_DIR lives
 525     # in a tmpfs filesystem or has been otherwise wiped out.
 526     dirs = [(dname, constants.RUN_DIRS_MODE) for dname in self._DIRS]
 527     utils.EnsureDirs(dirs)
 528
 529   @classmethod
 530   def _InstancePidFile(cls, instance_name):
 531     """Returns the instance pidfile.
 532
 533     """
 534     return utils.PathJoin(cls._PIDS_DIR, instance_name)
 535
 536   @classmethod
 537   def _InstanceUidFile(cls, instance_name):
 538     """Returns the instance uidfile.
 539
 540     """
 541     return utils.PathJoin(cls._UIDS_DIR, instance_name)
 542
 543   @classmethod
 544   def _InstancePidInfo(cls, pid):
 545     """Check pid file for instance information.
 546
 547     Check that a pid file is associated with an instance, and retrieve
 548     information from its command line.
 549
 550     @type pid: string or int
 551     @param pid: process id of the instance to check
 552     @rtype: tuple
 553     @return: (instance_name, memory, vcpus)
 554     @raise errors.HypervisorError: when an instance cannot be found
 555
 556     """
 557     alive = utils.IsProcessAlive(pid)
 558     if not alive:
 559       raise errors.HypervisorError("Cannot get info for pid %s" % pid)
 560
 561     cmdline_file = utils.PathJoin("/proc", str(pid), "cmdline")
 562     try:
 563       cmdline = utils.ReadFile(cmdline_file)
 564     except EnvironmentError, err:
 565       raise errors.HypervisorError("Can't open cmdline file for pid %s: %s" %
 566                                    (pid, err))
 567
 568     instance = None
 569     memory = 0
 570     vcpus = 0
 571
 572     arg_list = cmdline.split("\x00")
 573     while arg_list:
 574       arg = arg_list.pop(0)
 575       if arg == "-name":
 576         instance = arg_list.pop(0)
 577       elif arg == "-m":
 578         memory = int(arg_list.pop(0))
 579       elif arg == "-smp":
 580         vcpus = int(arg_list.pop(0))
 581
 582     if instance is None:
 583       raise errors.HypervisorError("Pid %s doesn't contain a ganeti kvm"
 584                                    " instance" % pid)
 585
 586     return (instance, memory, vcpus)
 587
 588   def _InstancePidAlive(self, instance_name):
 589     """Returns the instance pidfile, pid, and liveness.
 590
 591     @type instance_name: string
 592     @param instance_name: instance name
 593     @rtype: tuple
 594     @return: (pid file name, pid, liveness)
 595
 596     """
 597     pidfile = self._InstancePidFile(instance_name)
 598     pid = utils.ReadPidFile(pidfile)
 599
 600     alive = False
 601     try:
 602       cmd_instance = self._InstancePidInfo(pid)[0]
 603       alive = (cmd_instance == instance_name)
 604     except errors.HypervisorError:
 605       pass
 606
 607     return (pidfile, pid, alive)
 608
 609   def _CheckDown(self, instance_name):
 610     """Raises an error unless the given instance is down.
 611
 612     """
 613     alive = self._InstancePidAlive(instance_name)[2]
 614     if alive:
 615       raise errors.HypervisorError("Failed to start instance %s: %s" %
 616                                    (instance_name, "already running"))
 617
 618   @classmethod
 619   def _InstanceMonitor(cls, instance_name):
 620     """Returns the instance monitor socket name
 621
 622     """
 623     return utils.PathJoin(cls._CTRL_DIR, "%s.monitor" % instance_name)
 624
 625   @classmethod
 626   def _InstanceSerial(cls, instance_name):
 627     """Returns the instance serial socket name
 628
 629     """
 630     return utils.PathJoin(cls._CTRL_DIR, "%s.serial" % instance_name)
 631
 632   @classmethod
 633   def _InstanceQmpMonitor(cls, instance_name):
 634     """Returns the instance serial QMP socket name
 635
 636     """
 637     return utils.PathJoin(cls._CTRL_DIR, "%s.qmp" % instance_name)
 638
 639   @staticmethod
 640   def _SocatUnixConsoleParams():
 641     """Returns the correct parameters for socat
 642
 643     If we have a new-enough socat we can use raw mode with an escape character.
 644
 645     """
 646     if constants.SOCAT_USE_ESCAPE:
 647       return "raw,echo=0,escape=%s" % constants.SOCAT_ESCAPE_CODE
 648     else:
 649       return "echo=0,icanon=0"
 650
 651   @classmethod
 652   def _InstanceKVMRuntime(cls, instance_name):
 653     """Returns the instance KVM runtime filename
 654
 655     """
 656     return utils.PathJoin(cls._CONF_DIR, "%s.runtime" % instance_name)
 657
 658   @classmethod
 659   def _InstanceChrootDir(cls, instance_name):
 660     """Returns the name of the KVM chroot dir of the instance
 661
 662     """
 663     return utils.PathJoin(cls._CHROOT_DIR, instance_name)
 664
 665   @classmethod
 666   def _InstanceNICDir(cls, instance_name):
 667     """Returns the name of the directory holding the tap device files for a
 668     given instance.
 669
 670     """
 671     return utils.PathJoin(cls._NICS_DIR, instance_name)
 672
 673   @classmethod
 674   def _InstanceNICFile(cls, instance_name, seq):
 675     """Returns the name of the file containing the tap device for a given NIC
 676
 677     """
 678     return utils.PathJoin(cls._InstanceNICDir(instance_name), str(seq))
 679
 680   @classmethod
 681   def _InstanceKeymapFile(cls, instance_name):
 682     """Returns the name of the file containing the keymap for a given instance
 683
 684     """
 685     return utils.PathJoin(cls._KEYMAP_DIR, instance_name)
 686
 687   @classmethod
 688   def _TryReadUidFile(cls, uid_file):
 689     """Try to read a uid file
 690
 691     """
 692     if os.path.exists(uid_file):
 693       try:
 694         uid = int(utils.ReadOneLineFile(uid_file))
 695         return uid
 696       except EnvironmentError:
 697         logging.warning("Can't read uid file", exc_info=True)
 698       except (TypeError, ValueError):
 699         logging.warning("Can't parse uid file contents", exc_info=True)
 700     return None
 701
 702   @classmethod
 703   def _RemoveInstanceRuntimeFiles(cls, pidfile, instance_name):
 704     """Removes an instance's rutime sockets/files/dirs.
 705
 706     """
 707     utils.RemoveFile(pidfile)
 708     utils.RemoveFile(cls._InstanceMonitor(instance_name))
 709     utils.RemoveFile(cls._InstanceSerial(instance_name))
 710     utils.RemoveFile(cls._InstanceQmpMonitor(instance_name))
 711     utils.RemoveFile(cls._InstanceKVMRuntime(instance_name))
 712     utils.RemoveFile(cls._InstanceKeymapFile(instance_name))
 713     uid_file = cls._InstanceUidFile(instance_name)
 714     uid = cls._TryReadUidFile(uid_file)
 715     utils.RemoveFile(uid_file)
 716     if uid is not None:
 717       uidpool.ReleaseUid(uid)
 718     try:
 719       shutil.rmtree(cls._InstanceNICDir(instance_name))
 720     except OSError, err:
 721       if err.errno != errno.ENOENT:
 722         raise
 723     try:
 724       chroot_dir = cls._InstanceChrootDir(instance_name)
 725       utils.RemoveDir(chroot_dir)
 726     except OSError, err:
 727       if err.errno == errno.ENOTEMPTY:
 728         # The chroot directory is expected to be empty, but it isn't.
 729         new_chroot_dir = tempfile.mkdtemp(dir=cls._CHROOT_QUARANTINE_DIR,
 730                                           prefix="%s-%s-" %
 731                                           (instance_name,
 732                                            utils.TimestampForFilename()))
 733         logging.warning("The chroot directory of instance %s can not be"
 734                         " removed as it is not empty. Moving it to the"
 735                         " quarantine instead. Please investigate the"
 736                         " contents (%s) and clean up manually",
 737                         instance_name, new_chroot_dir)
 738         utils.RenameFile(chroot_dir, new_chroot_dir)
 739       else:
 740         raise
 741
 742   @staticmethod
 743   def _ConfigureNIC(instance, seq, nic, tap):
 744     """Run the network configuration script for a specified NIC
 745
 746     @param instance: instance we're acting on
 747     @type instance: instance object
 748     @param seq: nic sequence number
 749     @type seq: int
 750     @param nic: nic we're acting on
 751     @type nic: nic object
 752     @param tap: the host's tap interface this NIC corresponds to
 753     @type tap: str
 754
 755     """
 756     if instance.tags:
 757       tags = " ".join(instance.tags)
 758     else:
 759       tags = ""
 760
 761     env = {
 762       "PATH": "%s:/sbin:/usr/sbin" % os.environ["PATH"],
 763       "INSTANCE": instance.name,
 764       "MAC": nic.mac,
 765       "MODE": nic.nicparams[constants.NIC_MODE],
 766       "INTERFACE": tap,
 767       "INTERFACE_INDEX": str(seq),
 768       "TAGS": tags,
 769     }
 770
 771     if nic.ip:
 772       env["IP"] = nic.ip
 773
 774     if nic.nicparams[constants.NIC_LINK]:
 775       env["LINK"] = nic.nicparams[constants.NIC_LINK]
 776
 777     if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
 778       env["BRIDGE"] = nic.nicparams[constants.NIC_LINK]
 779
 780     result = utils.RunCmd([constants.KVM_IFUP, tap], env=env)
 781     if result.failed:
 782       raise errors.HypervisorError("Failed to configure interface %s: %s."
 783                                    " Network configuration script output: %s" %
 784                                    (tap, result.fail_reason, result.output))
 785
 786   @staticmethod
 787   def _VerifyAffinityPackage():
 788     if affinity is None:
 789       raise errors.HypervisorError("affinity Python package not"
 790                                    " found; cannot use CPU pinning under KVM")
 791
 792   @staticmethod
 793   def _BuildAffinityCpuMask(cpu_list):
 794     """Create a CPU mask suitable for sched_setaffinity from a list of
 795     CPUs.
 796
 797     See man taskset for more info on sched_setaffinity masks.
 798     For example: [ 0, 2, 5, 6 ] will return 101 (0x65, 0..01100101).
 799
 800     @type cpu_list: list of int
 801     @param cpu_list: list of physical CPU numbers to map to vCPUs in order
 802     @rtype: int
 803     @return: a bit mask of CPU affinities
 804
 805     """
 806     if cpu_list == constants.CPU_PINNING_OFF:
 807       return constants.CPU_PINNING_ALL_KVM
 808     else:
 809       return sum(2 ** cpu for cpu in cpu_list)
 810
 811   @classmethod
 812   def _AssignCpuAffinity(cls, cpu_mask, process_id, thread_dict):
 813     """Change CPU affinity for running VM according to given CPU mask.
 814
 815     @param cpu_mask: CPU mask as given by the user. e.g. "0-2,4:all:1,3"
 816     @type cpu_mask: string
 817     @param process_id: process ID of KVM process. Used to pin entire VM
 818                        to physical CPUs.
 819     @type process_id: int
 820     @param thread_dict: map of virtual CPUs to KVM thread IDs
 821     @type thread_dict: dict int:int
 822
 823     """
 824     # Convert the string CPU mask to a list of list of int's
 825     cpu_list = utils.ParseMultiCpuMask(cpu_mask)
 826
 827     if len(cpu_list) == 1:
 828       all_cpu_mapping = cpu_list[0]
 829       if all_cpu_mapping == constants.CPU_PINNING_OFF:
 830         # If CPU pinning has 1 entry that's "all", then do nothing
 831         pass
 832       else:
 833         # If CPU pinning has one non-all entry, map the entire VM to
 834         # one set of physical CPUs
 835         cls._VerifyAffinityPackage()
 836         affinity.set_process_affinity_mask(
 837           process_id, cls._BuildAffinityCpuMask(all_cpu_mapping))
 838     else:
 839       # The number of vCPUs mapped should match the number of vCPUs
 840       # reported by KVM. This was already verified earlier, so
 841       # here only as a sanity check.
 842       assert len(thread_dict) == len(cpu_list)
 843       cls._VerifyAffinityPackage()
 844
 845       # For each vCPU, map it to the proper list of physical CPUs
 846       for vcpu, i in zip(cpu_list, range(len(cpu_list))):
 847         affinity.set_process_affinity_mask(thread_dict[i],
 848                                            cls._BuildAffinityCpuMask(vcpu))
 849
 850   def _GetVcpuThreadIds(self, instance_name):
 851     """Get a mapping of vCPU no. to thread IDs for the instance
 852
 853     @type instance_name: string
 854     @param instance_name: instance in question
 855     @rtype: dictionary of int:int
 856     @return: a dictionary mapping vCPU numbers to thread IDs
 857
 858     """
 859     result = {}
 860     output = self._CallMonitorCommand(instance_name, self._CPU_INFO_CMD)
 861     for line in output.stdout.splitlines():
 862       match = self._CPU_INFO_RE.search(line)
 863       if not match:
 864         continue
 865       grp = map(int, match.groups())
 866       result[grp[0]] = grp[1]
 867
 868     return result
 869
 870   def _ExecuteCpuAffinity(self, instance_name, cpu_mask):
 871     """Complete CPU pinning.
 872
 873     @type instance_name: string
 874     @param instance_name: name of instance
 875     @type cpu_mask: string
 876     @param cpu_mask: CPU pinning mask as entered by user
 877
 878     """
 879     # Get KVM process ID, to be used if need to pin entire VM
 880     _, pid, _ = self._InstancePidAlive(instance_name)
 881     # Get vCPU thread IDs, to be used if need to pin vCPUs separately
 882     thread_dict = self._GetVcpuThreadIds(instance_name)
 883     # Run CPU pinning, based on configured mask
 884     self._AssignCpuAffinity(cpu_mask, pid, thread_dict)
 885
 886   def ListInstances(self):
 887     """Get the list of running instances.
 888
 889     We can do this by listing our live instances directory and
 890     checking whether the associated kvm process is still alive.
 891
 892     """
 893     result = []
 894     for name in os.listdir(self._PIDS_DIR):
 895       if self._InstancePidAlive(name)[2]:
 896         result.append(name)
 897     return result
 898
 899   def GetInstanceInfo(self, instance_name):
 900     """Get instance properties.
 901
 902     @type instance_name: string
 903     @param instance_name: the instance name
 904     @rtype: tuple of strings
 905     @return: (name, id, memory, vcpus, stat, times)
 906
 907     """
 908     _, pid, alive = self._InstancePidAlive(instance_name)
 909     if not alive:
 910       return None
 911
 912     _, memory, vcpus = self._InstancePidInfo(pid)
 913     istat = "---b-"
 914     times = "0"
 915
 916     try:
 917       qmp = QmpConnection(self._InstanceQmpMonitor(instance_name))
 918       qmp.connect()
 919       vcpus = len(qmp.Execute("query-cpus")[qmp.RETURN_KEY])
 920       # Will fail if ballooning is not enabled, but we can then just resort to
 921       # the value above.
 922       mem_bytes = qmp.Execute("query-balloon")[qmp.RETURN_KEY][qmp.ACTUAL_KEY]
 923       memory = mem_bytes / 1048576
 924     except errors.HypervisorError:
 925       pass
 926
 927     return (instance_name, pid, memory, vcpus, istat, times)
 928
 929   def GetAllInstancesInfo(self):
 930     """Get properties of all instances.
 931
 932     @return: list of tuples (name, id, memory, vcpus, stat, times)
 933
 934     """
 935     data = []
 936     for name in os.listdir(self._PIDS_DIR):
 937       try:
 938         info = self.GetInstanceInfo(name)
 939       except errors.HypervisorError:
 940         # Ignore exceptions due to instances being shut down
 941         continue
 942       if info:
 943         data.append(info)
 944     return data
 945
 946   def _GenerateKVMRuntime(self, instance, block_devices, startup_paused):
 947     """Generate KVM information to start an instance.
 948
 949     @attention: this function must not have any side-effects; for
 950         example, it must not write to the filesystem, or read values
 951         from the current system the are expected to differ between
 952         nodes, since it is only run once at instance startup;
 953         actions/kvm arguments that can vary between systems should be
 954         done in L{_ExecuteKVMRuntime}
 955
 956     """
 957     # pylint: disable=R0914,R0915
 958     _, v_major, v_min, _ = self._GetKVMVersion()
 959
 960     pidfile = self._InstancePidFile(instance.name)
 961     kvm = constants.KVM_PATH
 962     kvm_cmd = [kvm]
 963     # used just by the vnc server, if enabled
 964     kvm_cmd.extend(["-name", instance.name])
 965     kvm_cmd.extend(["-m", instance.beparams[constants.BE_MAXMEM]])
 966     kvm_cmd.extend(["-smp", instance.beparams[constants.BE_VCPUS]])
 967     kvm_cmd.extend(["-pidfile", pidfile])
 968     kvm_cmd.extend(["-balloon", "virtio"])
 969     kvm_cmd.extend(["-daemonize"])
 970     if not instance.hvparams[constants.HV_ACPI]:
 971       kvm_cmd.extend(["-no-acpi"])
 972     if instance.hvparams[constants.HV_REBOOT_BEHAVIOR] == \
 973         constants.INSTANCE_REBOOT_EXIT:
 974       kvm_cmd.extend(["-no-reboot"])
 975
 976     hvp = instance.hvparams
 977     boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
 978     boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
 979     boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
 980     boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
 981
 982     self.ValidateParameters(hvp)
 983
 984     if startup_paused:
 985       kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
 986
 987     if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
 988       kvm_cmd.extend(["-enable-kvm"])
 989     elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
 990       kvm_cmd.extend(["-disable-kvm"])
 991
 992     if boot_network:
 993       kvm_cmd.extend(["-boot", "n"])
 994
 995     disk_type = hvp[constants.HV_DISK_TYPE]
 996     if disk_type == constants.HT_DISK_PARAVIRTUAL:
 997       if_val = ",if=virtio"
 998     else:
 999       if_val = ",if=%s" % disk_type
1000     # Cache mode
1001     disk_cache = hvp[constants.HV_DISK_CACHE]
1002     if instance.disk_template in constants.DTS_EXT_MIRROR:
1003       if disk_cache != "none":
1004         # TODO: make this a hard error, instead of a silent overwrite
1005         logging.warning("KVM: overriding disk_cache setting '%s' with 'none'"
1006                         " to prevent shared storage corruption on migration",
1007                         disk_cache)
1008       cache_val = ",cache=none"
1009     elif disk_cache != constants.HT_CACHE_DEFAULT:
1010       cache_val = ",cache=%s" % disk_cache
1011     else:
1012       cache_val = ""
1013     for cfdev, dev_path in block_devices:
1014       if cfdev.mode != constants.DISK_RDWR:
1015         raise errors.HypervisorError("Instance has read-only disks which"
1016                                      " are not supported by KVM")
1017       # TODO: handle FD_LOOP and FD_BLKTAP (?)
1018       boot_val = ""
1019       if boot_disk:
1020         kvm_cmd.extend(["-boot", "c"])
1021         boot_disk = False
1022         if (v_major, v_min) < (0, 14) and disk_type != constants.HT_DISK_IDE:
1023           boot_val = ",boot=on"
1024
1025       drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
1026                                                 cache_val)
1027       kvm_cmd.extend(["-drive", drive_val])
1028
1029     #Now we can specify a different device type for CDROM devices.
1030     cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
1031     if not cdrom_disk_type:
1032       cdrom_disk_type = disk_type
1033
1034     iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
1035     if iso_image:
1036       options = ",format=raw,media=cdrom"
1037       if boot_cdrom:
1038         kvm_cmd.extend(["-boot", "d"])
1039         if cdrom_disk_type != constants.HT_DISK_IDE:
1040           options = "%s,boot=on,if=%s" % (options, constants.HT_DISK_IDE)
1041         else:
1042           options = "%s,boot=on" % options
1043       else:
1044         if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1045           if_val = ",if=virtio"
1046         else:
1047           if_val = ",if=%s" % cdrom_disk_type
1048         options = "%s%s" % (options, if_val)
1049       drive_val = "file=%s%s" % (iso_image, options)
1050       kvm_cmd.extend(["-drive", drive_val])
1051
1052     iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
1053     if iso_image2:
1054       options = ",format=raw,media=cdrom"
1055       if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1056         if_val = ",if=virtio"
1057       else:
1058         if_val = ",if=%s" % cdrom_disk_type
1059       options = "%s%s" % (options, if_val)
1060       drive_val = "file=%s%s" % (iso_image2, options)
1061       kvm_cmd.extend(["-drive", drive_val])
1062
1063     floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
1064     if floppy_image:
1065       options = ",format=raw,media=disk"
1066       if boot_floppy:
1067         kvm_cmd.extend(["-boot", "a"])
1068         options = "%s,boot=on" % options
1069       if_val = ",if=floppy"
1070       options = "%s%s" % (options, if_val)
1071       drive_val = "file=%s%s" % (floppy_image, options)
1072       kvm_cmd.extend(["-drive", drive_val])
1073
1074     kernel_path = hvp[constants.HV_KERNEL_PATH]
1075     if kernel_path:
1076       kvm_cmd.extend(["-kernel", kernel_path])
1077       initrd_path = hvp[constants.HV_INITRD_PATH]
1078       if initrd_path:
1079         kvm_cmd.extend(["-initrd", initrd_path])
1080       root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
1081                      hvp[constants.HV_KERNEL_ARGS]]
1082       if hvp[constants.HV_SERIAL_CONSOLE]:
1083         root_append.append("console=ttyS0,38400")
1084       kvm_cmd.extend(["-append", " ".join(root_append)])
1085
1086     mem_path = hvp[constants.HV_MEM_PATH]
1087     if mem_path:
1088       kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
1089
1090     monitor_dev = ("unix:%s,server,nowait" %
1091                    self._InstanceMonitor(instance.name))
1092     kvm_cmd.extend(["-monitor", monitor_dev])
1093     if hvp[constants.HV_SERIAL_CONSOLE]:
1094       serial_dev = ("unix:%s,server,nowait" %
1095                     self._InstanceSerial(instance.name))
1096       kvm_cmd.extend(["-serial", serial_dev])
1097     else:
1098       kvm_cmd.extend(["-serial", "none"])
1099
1100     mouse_type = hvp[constants.HV_USB_MOUSE]
1101     vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
1102     spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
1103     spice_ip_version = None
1104
1105     if mouse_type:
1106       kvm_cmd.extend(["-usb"])
1107       kvm_cmd.extend(["-usbdevice", mouse_type])
1108     elif vnc_bind_address:
1109       kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
1110
1111     if vnc_bind_address:
1112       if netutils.IP4Address.IsValid(vnc_bind_address):
1113         if instance.network_port > constants.VNC_BASE_PORT:
1114           display = instance.network_port - constants.VNC_BASE_PORT
1115           if vnc_bind_address == constants.IP4_ADDRESS_ANY:
1116             vnc_arg = ":%d" % (display)
1117           else:
1118             vnc_arg = "%s:%d" % (vnc_bind_address, display)
1119         else:
1120           logging.error("Network port is not a valid VNC display (%d < %d)."
1121                         " Not starting VNC", instance.network_port,
1122                         constants.VNC_BASE_PORT)
1123           vnc_arg = "none"
1124
1125         # Only allow tls and other option when not binding to a file, for now.
1126         # kvm/qemu gets confused otherwise about the filename to use.
1127         vnc_append = ""
1128         if hvp[constants.HV_VNC_TLS]:
1129           vnc_append = "%s,tls" % vnc_append
1130           if hvp[constants.HV_VNC_X509_VERIFY]:
1131             vnc_append = "%s,x509verify=%s" % (vnc_append,
1132                                                hvp[constants.HV_VNC_X509])
1133           elif hvp[constants.HV_VNC_X509]:
1134             vnc_append = "%s,x509=%s" % (vnc_append,
1135                                          hvp[constants.HV_VNC_X509])
1136         if hvp[constants.HV_VNC_PASSWORD_FILE]:
1137           vnc_append = "%s,password" % vnc_append
1138
1139         vnc_arg = "%s%s" % (vnc_arg, vnc_append)
1140
1141       else:
1142         vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
1143
1144       kvm_cmd.extend(["-vnc", vnc_arg])
1145     elif spice_bind:
1146       # FIXME: this is wrong here; the iface ip address differs
1147       # between systems, so it should be done in _ExecuteKVMRuntime
1148       if netutils.IsValidInterface(spice_bind):
1149         # The user specified a network interface, we have to figure out the IP
1150         # address.
1151         addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1152         spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1153
1154         # if the user specified an IP version and the interface does not
1155         # have that kind of IP addresses, throw an exception
1156         if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1157           if not addresses[spice_ip_version]:
1158             raise errors.HypervisorError("spice: unable to get an IPv%s address"
1159                                          " for %s" % (spice_ip_version,
1160                                                       spice_bind))
1161
1162         # the user did not specify an IP version, we have to figure it out
1163         elif (addresses[constants.IP4_VERSION] and
1164               addresses[constants.IP6_VERSION]):
1165           # we have both ipv4 and ipv6, let's use the cluster default IP
1166           # version
1167           cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1168           spice_ip_version = \
1169             netutils.IPAddress.GetVersionFromAddressFamily(cluster_family)
1170         elif addresses[constants.IP4_VERSION]:
1171           spice_ip_version = constants.IP4_VERSION
1172         elif addresses[constants.IP6_VERSION]:
1173           spice_ip_version = constants.IP6_VERSION
1174         else:
1175           raise errors.HypervisorError("spice: unable to get an IP address"
1176                                        " for %s" % (spice_bind))
1177
1178         spice_address = addresses[spice_ip_version][0]
1179
1180       else:
1181         # spice_bind is known to be a valid IP address, because
1182         # ValidateParameters checked it.
1183         spice_address = spice_bind
1184
1185       spice_arg = "addr=%s" % spice_address
1186       if hvp[constants.HV_KVM_SPICE_USE_TLS]:
1187         spice_arg = ("%s,tls-port=%s,x509-cacert-file=%s" %
1188                      (spice_arg, instance.network_port,
1189                       constants.SPICE_CACERT_FILE))
1190         spice_arg = ("%s,x509-key-file=%s,x509-cert-file=%s" %
1191                      (spice_arg, constants.SPICE_CERT_FILE,
1192                       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       else:
1227         # Enable the spice agent communication channel between the host and the
1228         # agent.
1229         kvm_cmd.extend(["-device", "virtio-serial-pci"])
1230         kvm_cmd.extend(["-device", "virtserialport,chardev=spicechannel0,"
1231                                                    "name=com.redhat.spice.0"])
1232         kvm_cmd.extend(["-chardev", "spicevmc,id=spicechannel0,name=vdagent"])
1233
1234       logging.info("KVM: SPICE will listen on port %s", instance.network_port)
1235       kvm_cmd.extend(["-spice", spice_arg])
1236
1237       # Tell kvm to use the paravirtualized graphic card, optimized for SPICE
1238       kvm_cmd.extend(["-vga", "qxl"])
1239
1240     else:
1241       kvm_cmd.extend(["-nographic"])
1242
1243     if hvp[constants.HV_USE_LOCALTIME]:
1244       kvm_cmd.extend(["-localtime"])
1245
1246     if hvp[constants.HV_KVM_USE_CHROOT]:
1247       kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1248
1249     # Add qemu-KVM -cpu param
1250     if hvp[constants.HV_CPU_TYPE]:
1251       kvm_cmd.extend(["-cpu", hvp[constants.HV_CPU_TYPE]])
1252
1253     # Save the current instance nics, but defer their expansion as parameters,
1254     # as we'll need to generate executable temp files for them.
1255     kvm_nics = instance.nics
1256     hvparams = hvp
1257
1258     return (kvm_cmd, kvm_nics, hvparams)
1259
1260   def _WriteKVMRuntime(self, instance_name, data):
1261     """Write an instance's KVM runtime
1262
1263     """
1264     try:
1265       utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1266                       data=data)
1267     except EnvironmentError, err:
1268       raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1269
1270   def _ReadKVMRuntime(self, instance_name):
1271     """Read an instance's KVM runtime
1272
1273     """
1274     try:
1275       file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1276     except EnvironmentError, err:
1277       raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1278     return file_content
1279
1280   def _SaveKVMRuntime(self, instance, kvm_runtime):
1281     """Save an instance's KVM runtime
1282
1283     """
1284     kvm_cmd, kvm_nics, hvparams = kvm_runtime
1285     serialized_nics = [nic.ToDict() for nic in kvm_nics]
1286     serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1287     self._WriteKVMRuntime(instance.name, serialized_form)
1288
1289   def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1290     """Load an instance's KVM runtime
1291
1292     """
1293     if not serialized_runtime:
1294       serialized_runtime = self._ReadKVMRuntime(instance.name)
1295     loaded_runtime = serializer.Load(serialized_runtime)
1296     kvm_cmd, serialized_nics, hvparams = loaded_runtime
1297     kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1298     return (kvm_cmd, kvm_nics, hvparams)
1299
1300   def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1301     """Run the KVM cmd and check for errors
1302
1303     @type name: string
1304     @param name: instance name
1305     @type kvm_cmd: list of strings
1306     @param kvm_cmd: runcmd input for kvm
1307     @type tap_fds: list of int
1308     @param tap_fds: fds of tap devices opened by Ganeti
1309
1310     """
1311     try:
1312       result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1313     finally:
1314       for fd in tap_fds:
1315         utils_wrapper.CloseFdNoError(fd)
1316
1317     if result.failed:
1318       raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1319                                    (name, result.fail_reason, result.output))
1320     if not self._InstancePidAlive(name)[2]:
1321       raise errors.HypervisorError("Failed to start instance %s" % name)
1322
1323   def _ExecuteKVMRuntime(self, instance, kvm_runtime, incoming=None):
1324     """Execute a KVM cmd, after completing it with some last minute data.
1325
1326     @type incoming: tuple of strings
1327     @param incoming: (target_host_ip, port)
1328
1329     """
1330     # Small _ExecuteKVMRuntime hv parameters programming howto:
1331     #  - conf_hvp contains the parameters as configured on ganeti. they might
1332     #    have changed since the instance started; only use them if the change
1333     #    won't affect the inside of the instance (which hasn't been rebooted).
1334     #  - up_hvp contains the parameters as they were when the instance was
1335     #    started, plus any new parameter which has been added between ganeti
1336     #    versions: it is paramount that those default to a value which won't
1337     #    affect the inside of the instance as well.
1338     conf_hvp = instance.hvparams
1339     name = instance.name
1340     self._CheckDown(name)
1341
1342     temp_files = []
1343
1344     kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1345     up_hvp = objects.FillDict(conf_hvp, up_hvp)
1346
1347     _, v_major, v_min, _ = self._GetKVMVersion()
1348
1349     # We know it's safe to run as a different user upon migration, so we'll use
1350     # the latest conf, from conf_hvp.
1351     security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1352     if security_model == constants.HT_SM_USER:
1353       kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1354
1355     keymap = conf_hvp[constants.HV_KEYMAP]
1356     if keymap:
1357       keymap_path = self._InstanceKeymapFile(name)
1358       # If a keymap file is specified, KVM won't use its internal defaults. By
1359       # first including the "en-us" layout, an error on loading the actual
1360       # layout (e.g. because it can't be found) won't lead to a non-functional
1361       # keyboard. A keyboard with incorrect keys is still better than none.
1362       utils.WriteFile(keymap_path, data="include en-us\ninclude %s\n" % keymap)
1363       kvm_cmd.extend(["-k", keymap_path])
1364
1365     # We have reasons to believe changing something like the nic driver/type
1366     # upon migration won't exactly fly with the instance kernel, so for nic
1367     # related parameters we'll use up_hvp
1368     tapfds = []
1369     taps = []
1370     if not kvm_nics:
1371       kvm_cmd.extend(["-net", "none"])
1372     else:
1373       vnet_hdr = False
1374       tap_extra = ""
1375       nic_type = up_hvp[constants.HV_NIC_TYPE]
1376       if nic_type == constants.HT_NIC_PARAVIRTUAL:
1377         # From version 0.12.0, kvm uses a new sintax for network configuration.
1378         if (v_major, v_min) >= (0, 12):
1379           nic_model = "virtio-net-pci"
1380           vnet_hdr = True
1381         else:
1382           nic_model = "virtio"
1383
1384         if up_hvp[constants.HV_VHOST_NET]:
1385           # vhost_net is only available from version 0.13.0 or newer
1386           if (v_major, v_min) >= (0, 13):
1387             tap_extra = ",vhost=on"
1388           else:
1389             raise errors.HypervisorError("vhost_net is configured"
1390                                          " but it is not available")
1391       else:
1392         nic_model = nic_type
1393
1394       for nic_seq, nic in enumerate(kvm_nics):
1395         tapname, tapfd = _OpenTap(vnet_hdr)
1396         tapfds.append(tapfd)
1397         taps.append(tapname)
1398         if (v_major, v_min) >= (0, 12):
1399           nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1400           tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1401           kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1402         else:
1403           nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1404                                                          nic.mac, nic_model)
1405           tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1406           kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1407
1408     if incoming:
1409       target, port = incoming
1410       kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1411
1412     # Changing the vnc password doesn't bother the guest that much. At most it
1413     # will surprise people who connect to it. Whether positively or negatively
1414     # it's debatable.
1415     vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1416     vnc_pwd = None
1417     if vnc_pwd_file:
1418       try:
1419         vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1420       except EnvironmentError, err:
1421         raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1422                                      % (vnc_pwd_file, err))
1423
1424     if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1425       utils.EnsureDirs([(self._InstanceChrootDir(name),
1426                          constants.SECURE_DIR_MODE)])
1427
1428     # Automatically enable QMP if version is >= 0.14
1429     if (v_major, v_min) >= (0, 14):
1430       logging.debug("Enabling QMP")
1431       kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1432                       self._InstanceQmpMonitor(instance.name)])
1433
1434     # Configure the network now for starting instances and bridged interfaces,
1435     # during FinalizeMigration for incoming instances' routed interfaces
1436     for nic_seq, nic in enumerate(kvm_nics):
1437       if (incoming and
1438           nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1439         continue
1440       self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1441
1442     # CPU affinity requires kvm to start paused, so we set this flag if the
1443     # instance is not already paused and if we are not going to accept a
1444     # migrating instance. In the latter case, pausing is not needed.
1445     start_kvm_paused = not (_KVM_START_PAUSED_FLAG in kvm_cmd) and not incoming
1446     if start_kvm_paused:
1447       kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
1448
1449     # Note: CPU pinning is using up_hvp since changes take effect
1450     # during instance startup anyway, and to avoid problems when soft
1451     # rebooting the instance.
1452     cpu_pinning = False
1453     if up_hvp.get(constants.HV_CPU_MASK, None):
1454       cpu_pinning = True
1455
1456     if security_model == constants.HT_SM_POOL:
1457       ss = ssconf.SimpleStore()
1458       uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1459       all_uids = set(uidpool.ExpandUidPool(uid_pool))
1460       uid = uidpool.RequestUnusedUid(all_uids)
1461       try:
1462         username = pwd.getpwuid(uid.GetUid()).pw_name
1463         kvm_cmd.extend(["-runas", username])
1464         self._RunKVMCmd(name, kvm_cmd, tapfds)
1465       except:
1466         uidpool.ReleaseUid(uid)
1467         raise
1468       else:
1469         uid.Unlock()
1470         utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1471     else:
1472       self._RunKVMCmd(name, kvm_cmd, tapfds)
1473
1474     utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1475                      constants.RUN_DIRS_MODE)])
1476     for nic_seq, tap in enumerate(taps):
1477       utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1478                       data=tap)
1479
1480     if vnc_pwd:
1481       change_cmd = "change vnc password %s" % vnc_pwd
1482       self._CallMonitorCommand(instance.name, change_cmd)
1483
1484     # Setting SPICE password. We are not vulnerable to malicious passwordless
1485     # connection attempts because SPICE by default does not allow connections
1486     # if neither a password nor the "disable_ticketing" options are specified.
1487     # As soon as we send the password via QMP, that password is a valid ticket
1488     # for connection.
1489     spice_password_file = conf_hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]
1490     if spice_password_file:
1491       spice_pwd = ""
1492       try:
1493         spice_pwd = utils.ReadOneLineFile(spice_password_file, strict=True)
1494       except EnvironmentError, err:
1495         raise errors.HypervisorError("Failed to open SPICE password file %s: %s"
1496                                      % (spice_password_file, err))
1497
1498       qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1499       qmp.connect()
1500       arguments = {
1501           "protocol": "spice",
1502           "password": spice_pwd,
1503       }
1504       qmp.Execute("set_password", arguments)
1505
1506     for filename in temp_files:
1507       utils.RemoveFile(filename)
1508
1509     # If requested, set CPU affinity and resume instance execution
1510     if cpu_pinning:
1511       self._ExecuteCpuAffinity(instance.name, up_hvp[constants.HV_CPU_MASK])
1512
1513     start_memory = self._InstanceStartupMemory(instance)
1514     if start_memory < instance.beparams[constants.BE_MAXMEM]:
1515       self.BalloonInstanceMemory(instance, start_memory)
1516
1517     if start_kvm_paused:
1518       # To control CPU pinning, ballooning, and vnc/spice passwords the VM was
1519       # started in a frozen state. If freezing was not explicitely requested
1520       # resume the vm status.
1521       self._CallMonitorCommand(instance.name, self._CONT_CMD)
1522
1523   def StartInstance(self, instance, block_devices, startup_paused):
1524     """Start an instance.
1525
1526     """
1527     self._CheckDown(instance.name)
1528     kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1529                                            startup_paused)
1530     self._SaveKVMRuntime(instance, kvm_runtime)
1531     self._ExecuteKVMRuntime(instance, kvm_runtime)
1532
1533   def _CallMonitorCommand(self, instance_name, command):
1534     """Invoke a command on the instance monitor.
1535
1536     """
1537     socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1538              (utils.ShellQuote(command),
1539               constants.SOCAT_PATH,
1540               utils.ShellQuote(self._InstanceMonitor(instance_name))))
1541     result = utils.RunCmd(socat)
1542     if result.failed:
1543       msg = ("Failed to send command '%s' to instance %s."
1544              " output: %s, error: %s, fail_reason: %s" %
1545              (command, instance_name,
1546               result.stdout, result.stderr, result.fail_reason))
1547       raise errors.HypervisorError(msg)
1548
1549     return result
1550
1551   @classmethod
1552   def _ParseKVMVersion(cls, text):
1553     """Parse the KVM version from the --help output.
1554
1555     @type text: string
1556     @param text: output of kvm --help
1557     @return: (version, v_maj, v_min, v_rev)
1558     @raise errors.HypervisorError: when the KVM version cannot be retrieved
1559
1560     """
1561     match = cls._VERSION_RE.search(text.splitlines()[0])
1562     if not match:
1563       raise errors.HypervisorError("Unable to get KVM version")
1564
1565     v_all = match.group(0)
1566     v_maj = int(match.group(1))
1567     v_min = int(match.group(2))
1568     if match.group(4):
1569       v_rev = int(match.group(4))
1570     else:
1571       v_rev = 0
1572     return (v_all, v_maj, v_min, v_rev)
1573
1574   @classmethod
1575   def _GetKVMVersion(cls):
1576     """Return the installed KVM version.
1577
1578     @return: (version, v_maj, v_min, v_rev)
1579     @raise errors.HypervisorError: when the KVM version cannot be retrieved
1580
1581     """
1582     result = utils.RunCmd([constants.KVM_PATH, "--help"])
1583     if result.failed:
1584       raise errors.HypervisorError("Unable to get KVM version")
1585     return cls._ParseKVMVersion(result.output)
1586
1587   def StopInstance(self, instance, force=False, retry=False, name=None):
1588     """Stop an instance.
1589
1590     """
1591     if name is not None and not force:
1592       raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1593     if name is None:
1594       name = instance.name
1595       acpi = instance.hvparams[constants.HV_ACPI]
1596     else:
1597       acpi = False
1598     _, pid, alive = self._InstancePidAlive(name)
1599     if pid > 0 and alive:
1600       if force or not acpi:
1601         utils.KillProcess(pid)
1602       else:
1603         self._CallMonitorCommand(name, "system_powerdown")
1604
1605   def CleanupInstance(self, instance_name):
1606     """Cleanup after a stopped instance
1607
1608     """
1609     pidfile, pid, alive = self._InstancePidAlive(instance_name)
1610     if pid > 0 and alive:
1611       raise errors.HypervisorError("Cannot cleanup a live instance")
1612     self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1613
1614   def RebootInstance(self, instance):
1615     """Reboot an instance.
1616
1617     """
1618     # For some reason if we do a 'send-key ctrl-alt-delete' to the control
1619     # socket the instance will stop, but now power up again. So we'll resort
1620     # to shutdown and restart.
1621     _, _, alive = self._InstancePidAlive(instance.name)
1622     if not alive:
1623       raise errors.HypervisorError("Failed to reboot instance %s:"
1624                                    " not running" % instance.name)
1625     # StopInstance will delete the saved KVM runtime so:
1626     # ...first load it...
1627     kvm_runtime = self._LoadKVMRuntime(instance)
1628     # ...now we can safely call StopInstance...
1629     if not self.StopInstance(instance):
1630       self.StopInstance(instance, force=True)
1631     # ...and finally we can save it again, and execute it...
1632     self._SaveKVMRuntime(instance, kvm_runtime)
1633     self._ExecuteKVMRuntime(instance, kvm_runtime)
1634
1635   def MigrationInfo(self, instance):
1636     """Get instance information to perform a migration.
1637
1638     @type instance: L{objects.Instance}
1639     @param instance: instance to be migrated
1640     @rtype: string
1641     @return: content of the KVM runtime file
1642
1643     """
1644     return self._ReadKVMRuntime(instance.name)
1645
1646   def AcceptInstance(self, instance, info, target):
1647     """Prepare to accept an instance.
1648
1649     @type instance: L{objects.Instance}
1650     @param instance: instance to be accepted
1651     @type info: string
1652     @param info: content of the KVM runtime file on the source node
1653     @type target: string
1654     @param target: target host (usually ip), on this node
1655
1656     """
1657     kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1658     incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1659     self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1660
1661   def FinalizeMigrationDst(self, instance, info, success):
1662     """Finalize the instance migration on the target node.
1663
1664     Stop the incoming mode KVM.
1665
1666     @type instance: L{objects.Instance}
1667     @param instance: instance whose migration is being finalized
1668
1669     """
1670     if success:
1671       kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1672       kvm_nics = kvm_runtime[1]
1673
1674       for nic_seq, nic in enumerate(kvm_nics):
1675         if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1676           # Bridged interfaces have already been configured
1677           continue
1678         try:
1679           tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1680         except EnvironmentError, err:
1681           logging.warning("Failed to find host interface for %s NIC #%d: %s",
1682                           instance.name, nic_seq, str(err))
1683           continue
1684         try:
1685           self._ConfigureNIC(instance, nic_seq, nic, tap)
1686         except errors.HypervisorError, err:
1687           logging.warning(str(err))
1688
1689       self._WriteKVMRuntime(instance.name, info)
1690     else:
1691       self.StopInstance(instance, force=True)
1692
1693   def MigrateInstance(self, instance, target, live):
1694     """Migrate an instance to a target node.
1695
1696     The migration will not be attempted if the instance is not
1697     currently running.
1698
1699     @type instance: L{objects.Instance}
1700     @param instance: the instance to be migrated
1701     @type target: string
1702     @param target: ip address of the target node
1703     @type live: boolean
1704     @param live: perform a live migration
1705
1706     """
1707     instance_name = instance.name
1708     port = instance.hvparams[constants.HV_MIGRATION_PORT]
1709     _, _, alive = self._InstancePidAlive(instance_name)
1710     if not alive:
1711       raise errors.HypervisorError("Instance not running, cannot migrate")
1712
1713     if not live:
1714       self._CallMonitorCommand(instance_name, "stop")
1715
1716     migrate_command = ("migrate_set_speed %dm" %
1717                        instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1718     self._CallMonitorCommand(instance_name, migrate_command)
1719
1720     migrate_command = ("migrate_set_downtime %dms" %
1721                        instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1722     self._CallMonitorCommand(instance_name, migrate_command)
1723
1724     migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1725     self._CallMonitorCommand(instance_name, migrate_command)
1726
1727   def FinalizeMigrationSource(self, instance, success, live):
1728     """Finalize the instance migration on the source node.
1729
1730     @type instance: L{objects.Instance}
1731     @param instance: the instance that was migrated
1732     @type success: bool
1733     @param success: whether the migration succeeded or not
1734     @type live: bool
1735     @param live: whether the user requested a live migration or not
1736
1737     """
1738     if success:
1739       pidfile, pid, _ = self._InstancePidAlive(instance.name)
1740       utils.KillProcess(pid)
1741       self._RemoveInstanceRuntimeFiles(pidfile, instance.name)
1742     elif live:
1743       self._CallMonitorCommand(instance.name, self._CONT_CMD)
1744
1745   def GetMigrationStatus(self, instance):
1746     """Get the migration status
1747
1748     @type instance: L{objects.Instance}
1749     @param instance: the instance that is being migrated
1750     @rtype: L{objects.MigrationStatus}
1751     @return: the status of the current migration (one of
1752              L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1753              progress info that can be retrieved from the hypervisor
1754
1755     """
1756     info_command = "info migrate"
1757     for _ in range(self._MIGRATION_INFO_MAX_BAD_ANSWERS):
1758       result = self._CallMonitorCommand(instance.name, info_command)
1759       match = self._MIGRATION_STATUS_RE.search(result.stdout)
1760       if not match:
1761         if not result.stdout:
1762           logging.info("KVM: empty 'info migrate' result")
1763         else:
1764           logging.warning("KVM: unknown 'info migrate' result: %s",
1765                           result.stdout)
1766       else:
1767         status = match.group(1)
1768         if status in constants.HV_KVM_MIGRATION_VALID_STATUSES:
1769           migration_status = objects.MigrationStatus(status=status)
1770           match = self._MIGRATION_PROGRESS_RE.search(result.stdout)
1771           if match:
1772             migration_status.transferred_ram = match.group("transferred")
1773             migration_status.total_ram = match.group("total")
1774
1775           return migration_status
1776
1777         logging.warning("KVM: unknown migration status '%s'", status)
1778
1779       time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1780
1781     return objects.MigrationStatus(status=constants.HV_MIGRATION_FAILED,
1782                                    info="Too many 'info migrate'"
1783                                    " broken answers")
1784
1785   def BalloonInstanceMemory(self, instance, mem):
1786     """Balloon an instance memory to a certain value.
1787
1788     @type instance: L{objects.Instance}
1789     @param instance: instance to be accepted
1790     @type mem: int
1791     @param mem: actual memory size to use for instance runtime
1792
1793     """
1794     self._CallMonitorCommand(instance.name, "balloon %d" % mem)
1795
1796   def GetNodeInfo(self):
1797     """Return information about the node.
1798
1799     @return: a dict with the following keys (values in MiB):
1800           - memory_total: the total memory size on the node
1801           - memory_free: the available memory on the node for instances
1802           - memory_dom0: the memory used by the node itself, if available
1803           - hv_version: the hypervisor version in the form (major, minor,
1804                         revision)
1805
1806     """
1807     result = self.GetLinuxNodeInfo()
1808     _, v_major, v_min, v_rev = self._GetKVMVersion()
1809     result[constants.HV_NODEINFO_KEY_VERSION] = (v_major, v_min, v_rev)
1810     return result
1811
1812   @classmethod
1813   def GetInstanceConsole(cls, instance, hvparams, beparams):
1814     """Return a command for connecting to the console of an instance.
1815
1816     """
1817     if hvparams[constants.HV_SERIAL_CONSOLE]:
1818       cmd = [constants.KVM_CONSOLE_WRAPPER,
1819              constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1820              utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1821              "STDIO,%s" % cls._SocatUnixConsoleParams(),
1822              "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1823       return objects.InstanceConsole(instance=instance.name,
1824                                      kind=constants.CONS_SSH,
1825                                      host=instance.primary_node,
1826                                      user=constants.GANETI_RUNAS,
1827                                      command=cmd)
1828
1829     vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1830     if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1831       display = instance.network_port - constants.VNC_BASE_PORT
1832       return objects.InstanceConsole(instance=instance.name,
1833                                      kind=constants.CONS_VNC,
1834                                      host=vnc_bind_address,
1835                                      port=instance.network_port,
1836                                      display=display)
1837
1838     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1839     if spice_bind:
1840       return objects.InstanceConsole(instance=instance.name,
1841                                      kind=constants.CONS_SPICE,
1842                                      host=spice_bind,
1843                                      port=instance.network_port)
1844
1845     return objects.InstanceConsole(instance=instance.name,
1846                                    kind=constants.CONS_MESSAGE,
1847                                    message=("No serial shell for instance %s" %
1848                                             instance.name))
1849
1850   def Verify(self):
1851     """Verify the hypervisor.
1852
1853     Check that the binary exists.
1854
1855     """
1856     if not os.path.exists(constants.KVM_PATH):
1857       return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1858     if not os.path.exists(constants.SOCAT_PATH):
1859       return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1860
1861   @classmethod
1862   def CheckParameterSyntax(cls, hvparams):
1863     """Check the given parameters for validity.
1864
1865     @type hvparams:  dict
1866     @param hvparams: dictionary with parameter names/value
1867     @raise errors.HypervisorError: when a parameter is not valid
1868
1869     """
1870     super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1871
1872     kernel_path = hvparams[constants.HV_KERNEL_PATH]
1873     if kernel_path:
1874       if not hvparams[constants.HV_ROOT_PATH]:
1875         raise errors.HypervisorError("Need a root partition for the instance,"
1876                                      " if a kernel is defined")
1877
1878     if (hvparams[constants.HV_VNC_X509_VERIFY] and
1879         not hvparams[constants.HV_VNC_X509]):
1880       raise errors.HypervisorError("%s must be defined, if %s is" %
1881                                    (constants.HV_VNC_X509,
1882                                     constants.HV_VNC_X509_VERIFY))
1883
1884     boot_order = hvparams[constants.HV_BOOT_ORDER]
1885     if (boot_order == constants.HT_BO_CDROM and
1886         not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1887       raise errors.HypervisorError("Cannot boot from cdrom without an"
1888                                    " ISO path")
1889
1890     security_model = hvparams[constants.HV_SECURITY_MODEL]
1891     if security_model == constants.HT_SM_USER:
1892       if not hvparams[constants.HV_SECURITY_DOMAIN]:
1893         raise errors.HypervisorError("A security domain (user to run kvm as)"
1894                                      " must be specified")
1895     elif (security_model == constants.HT_SM_NONE or
1896           security_model == constants.HT_SM_POOL):
1897       if hvparams[constants.HV_SECURITY_DOMAIN]:
1898         raise errors.HypervisorError("Cannot have a security domain when the"
1899                                      " security model is 'none' or 'pool'")
1900
1901     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1902     spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1903     if spice_bind:
1904       if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1905         # if an IP version is specified, the spice_bind parameter must be an
1906         # IP of that family
1907         if (netutils.IP4Address.IsValid(spice_bind) and
1908             spice_ip_version != constants.IP4_VERSION):
1909           raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1910                                        " the specified IP version is %s" %
1911                                        (spice_bind, spice_ip_version))
1912
1913         if (netutils.IP6Address.IsValid(spice_bind) and
1914             spice_ip_version != constants.IP6_VERSION):
1915           raise errors.HypervisorError("spice: got an IPv6 address (%s), but"
1916                                        " the specified IP version is %s" %
1917                                        (spice_bind, spice_ip_version))
1918     else:
1919       # All the other SPICE parameters depend on spice_bind being set. Raise an
1920       # error if any of them is set without it.
1921       spice_additional_params = frozenset([
1922         constants.HV_KVM_SPICE_IP_VERSION,
1923         constants.HV_KVM_SPICE_PASSWORD_FILE,
1924         constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR,
1925         constants.HV_KVM_SPICE_JPEG_IMG_COMPR,
1926         constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR,
1927         constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION,
1928         constants.HV_KVM_SPICE_USE_TLS,
1929         ])
1930       for param in spice_additional_params:
1931         if hvparams[param]:
1932           raise errors.HypervisorError("spice: %s requires %s to be set" %
1933                                        (param, constants.HV_KVM_SPICE_BIND))
1934
1935   @classmethod
1936   def ValidateParameters(cls, hvparams):
1937     """Check the given parameters for validity.
1938
1939     @type hvparams:  dict
1940     @param hvparams: dictionary with parameter names/value
1941     @raise errors.HypervisorError: when a parameter is not valid
1942
1943     """
1944     super(KVMHypervisor, cls).ValidateParameters(hvparams)
1945
1946     security_model = hvparams[constants.HV_SECURITY_MODEL]
1947     if security_model == constants.HT_SM_USER:
1948       username = hvparams[constants.HV_SECURITY_DOMAIN]
1949       try:
1950         pwd.getpwnam(username)
1951       except KeyError:
1952         raise errors.HypervisorError("Unknown security domain user %s"
1953                                      % username)
1954
1955     spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1956     if spice_bind:
1957       # only one of VNC and SPICE can be used currently.
1958       if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1959         raise errors.HypervisorError("both SPICE and VNC are configured, but"
1960                                      " only one of them can be used at a"
1961                                      " given time.")
1962
1963       # KVM version should be >= 0.14.0
1964       _, v_major, v_min, _ = cls._GetKVMVersion()
1965       if (v_major, v_min) < (0, 14):
1966         raise errors.HypervisorError("spice is configured, but it is not"
1967                                      " available in versions of KVM < 0.14")
1968
1969       # if spice_bind is not an IP address, it must be a valid interface
1970       bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1971                        or netutils.IP6Address.IsValid(spice_bind))
1972       if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1973         raise errors.HypervisorError("spice: the %s parameter must be either"
1974                                      " a valid IP address or interface name" %
1975                                      constants.HV_KVM_SPICE_BIND)
1976
1977   @classmethod
1978   def PowercycleNode(cls):
1979     """KVM powercycle, just a wrapper over Linux powercycle.
1980
1981     """
1982     cls.LinuxPowercycle()