Statistics
| Branch: | Tag: | Revision:

root / lib / hypervisor / hv_kvm.py @ d45473fb

History | View | Annotate | Download (71.7 kB)

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.network:
777
      env["NETWORK"] = nic.network
778

    
779
    if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
780
      env["BRIDGE"] = nic.nicparams[constants.NIC_LINK]
781

    
782
    result = utils.RunCmd([constants.KVM_IFUP, tap], env=env)
783
    if result.failed:
784
      raise errors.HypervisorError("Failed to configure interface %s: %s."
785
                                   " Network configuration script output: %s" %
786
                                   (tap, result.fail_reason, result.output))
787

    
788
  @staticmethod
789
  def _VerifyAffinityPackage():
790
    if affinity is None:
791
      raise errors.HypervisorError("affinity Python package not"
792
        " found; cannot use CPU pinning under KVM")
793

    
794
  @staticmethod
795
  def _BuildAffinityCpuMask(cpu_list):
796
    """Create a CPU mask suitable for sched_setaffinity from a list of
797
    CPUs.
798

799
    See man taskset for more info on sched_setaffinity masks.
800
    For example: [ 0, 2, 5, 6 ] will return 101 (0x65, 0..01100101).
801

802
    @type cpu_list: list of int
803
    @param cpu_list: list of physical CPU numbers to map to vCPUs in order
804
    @rtype: int
805
    @return: a bit mask of CPU affinities
806

807
    """
808
    if cpu_list == constants.CPU_PINNING_OFF:
809
      return constants.CPU_PINNING_ALL_KVM
810
    else:
811
      return sum(2 ** cpu for cpu in cpu_list)
812

    
813
  @classmethod
814
  def _AssignCpuAffinity(cls, cpu_mask, process_id, thread_dict):
815
    """Change CPU affinity for running VM according to given CPU mask.
816

817
    @param cpu_mask: CPU mask as given by the user. e.g. "0-2,4:all:1,3"
818
    @type cpu_mask: string
819
    @param process_id: process ID of KVM process. Used to pin entire VM
820
                       to physical CPUs.
821
    @type process_id: int
822
    @param thread_dict: map of virtual CPUs to KVM thread IDs
823
    @type thread_dict: dict int:int
824

825
    """
826
    # Convert the string CPU mask to a list of list of int's
827
    cpu_list = utils.ParseMultiCpuMask(cpu_mask)
828

    
829
    if len(cpu_list) == 1:
830
      all_cpu_mapping = cpu_list[0]
831
      if all_cpu_mapping == constants.CPU_PINNING_OFF:
832
        # If CPU pinning has 1 entry that's "all", then do nothing
833
        pass
834
      else:
835
        # If CPU pinning has one non-all entry, map the entire VM to
836
        # one set of physical CPUs
837
        cls._VerifyAffinityPackage()
838
        affinity.set_process_affinity_mask(process_id,
839
          cls._BuildAffinityCpuMask(all_cpu_mapping))
840
    else:
841
      # The number of vCPUs mapped should match the number of vCPUs
842
      # reported by KVM. This was already verified earlier, so
843
      # here only as a sanity check.
844
      assert len(thread_dict) == len(cpu_list)
845
      cls._VerifyAffinityPackage()
846

    
847
      # For each vCPU, map it to the proper list of physical CPUs
848
      for vcpu, i in zip(cpu_list, range(len(cpu_list))):
849
        affinity.set_process_affinity_mask(thread_dict[i],
850
          cls._BuildAffinityCpuMask(vcpu))
851

    
852
  def _GetVcpuThreadIds(self, instance_name):
853
    """Get a mapping of vCPU no. to thread IDs for the instance
854

855
    @type instance_name: string
856
    @param instance_name: instance in question
857
    @rtype: dictionary of int:int
858
    @return: a dictionary mapping vCPU numbers to thread IDs
859

860
    """
861
    result = {}
862
    output = self._CallMonitorCommand(instance_name, self._CPU_INFO_CMD)
863
    for line in output.stdout.splitlines():
864
      match = self._CPU_INFO_RE.search(line)
865
      if not match:
866
        continue
867
      grp = map(int, match.groups())
868
      result[grp[0]] = grp[1]
869

    
870
    return result
871

    
872
  def _ExecuteCpuAffinity(self, instance_name, cpu_mask):
873
    """Complete CPU pinning.
874

875
    @type instance_name: string
876
    @param instance_name: name of instance
877
    @type cpu_mask: string
878
    @param cpu_mask: CPU pinning mask as entered by user
879

880
    """
881
    # Get KVM process ID, to be used if need to pin entire VM
882
    _, pid, _ = self._InstancePidAlive(instance_name)
883
    # Get vCPU thread IDs, to be used if need to pin vCPUs separately
884
    thread_dict = self._GetVcpuThreadIds(instance_name)
885
    # Run CPU pinning, based on configured mask
886
    self._AssignCpuAffinity(cpu_mask, pid, thread_dict)
887

    
888
  def ListInstances(self):
889
    """Get the list of running instances.
890

891
    We can do this by listing our live instances directory and
892
    checking whether the associated kvm process is still alive.
893

894
    """
895
    result = []
896
    for name in os.listdir(self._PIDS_DIR):
897
      if self._InstancePidAlive(name)[2]:
898
        result.append(name)
899
    return result
900

    
901
  def GetInstanceInfo(self, instance_name):
902
    """Get instance properties.
903

904
    @type instance_name: string
905
    @param instance_name: the instance name
906
    @rtype: tuple of strings
907
    @return: (name, id, memory, vcpus, stat, times)
908

909
    """
910
    _, pid, alive = self._InstancePidAlive(instance_name)
911
    if not alive:
912
      return None
913

    
914
    _, memory, vcpus = self._InstancePidInfo(pid)
915
    istat = "---b-"
916
    times = "0"
917

    
918
    try:
919
      qmp = QmpConnection(self._InstanceQmpMonitor(instance_name))
920
      qmp.connect()
921
      vcpus = len(qmp.Execute("query-cpus")[qmp.RETURN_KEY])
922
      # Will fail if ballooning is not enabled, but we can then just resort to
923
      # the value above.
924
      mem_bytes = qmp.Execute("query-balloon")[qmp.RETURN_KEY][qmp.ACTUAL_KEY]
925
      memory = mem_bytes / 1048576
926
    except errors.HypervisorError:
927
      pass
928

    
929
    return (instance_name, pid, memory, vcpus, istat, times)
930

    
931
  def GetAllInstancesInfo(self):
932
    """Get properties of all instances.
933

934
    @return: list of tuples (name, id, memory, vcpus, stat, times)
935

936
    """
937
    data = []
938
    for name in os.listdir(self._PIDS_DIR):
939
      try:
940
        info = self.GetInstanceInfo(name)
941
      except errors.HypervisorError:
942
        # Ignore exceptions due to instances being shut down
943
        continue
944
      if info:
945
        data.append(info)
946
    return data
947

    
948
  def _GenerateKVMRuntime(self, instance, block_devices, startup_paused):
949
    """Generate KVM information to start an instance.
950

951
    @attention: this function must not have any side-effects; for
952
        example, it must not write to the filesystem, or read values
953
        from the current system the are expected to differ between
954
        nodes, since it is only run once at instance startup;
955
        actions/kvm arguments that can vary between systems should be
956
        done in L{_ExecuteKVMRuntime}
957

958
    """
959
    # pylint: disable=R0914,R0915
960
    _, v_major, v_min, _ = self._GetKVMVersion()
961

    
962
    pidfile = self._InstancePidFile(instance.name)
963
    kvm = constants.KVM_PATH
964
    kvm_cmd = [kvm]
965
    # used just by the vnc server, if enabled
966
    kvm_cmd.extend(["-name", instance.name])
967
    kvm_cmd.extend(["-m", instance.beparams[constants.BE_MAXMEM]])
968
    kvm_cmd.extend(["-smp", instance.beparams[constants.BE_VCPUS]])
969
    kvm_cmd.extend(["-pidfile", pidfile])
970
    kvm_cmd.extend(["-balloon", "virtio"])
971
    kvm_cmd.extend(["-daemonize"])
972
    if not instance.hvparams[constants.HV_ACPI]:
973
      kvm_cmd.extend(["-no-acpi"])
974
    if instance.hvparams[constants.HV_REBOOT_BEHAVIOR] == \
975
        constants.INSTANCE_REBOOT_EXIT:
976
      kvm_cmd.extend(["-no-reboot"])
977

    
978
    hvp = instance.hvparams
979
    kernel_path = hvp[constants.HV_KERNEL_PATH]
980
    if kernel_path:
981
      boot_disk = boot_cdrom = boot_floppy = boot_network = False
982
    else:
983
      boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
984
      boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
985
      boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
986
      boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
987

    
988
    self.ValidateParameters(hvp)
989

    
990
    if startup_paused:
991
      kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
992

    
993
    if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
994
      kvm_cmd.extend(["-enable-kvm"])
995
    elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
996
      kvm_cmd.extend(["-disable-kvm"])
997

    
998
    if boot_network:
999
      kvm_cmd.extend(["-boot", "n"])
1000

    
1001
    # whether this is an older KVM version that uses the boot=on flag
1002
    # on devices
1003
    needs_boot_flag = (v_major, v_min) < (0, 14)
1004

    
1005
    disk_type = hvp[constants.HV_DISK_TYPE]
1006
    if disk_type == constants.HT_DISK_PARAVIRTUAL:
1007
      if_val = ",if=virtio"
1008
    else:
1009
      if_val = ",if=%s" % disk_type
1010
    # Cache mode
1011
    disk_cache = hvp[constants.HV_DISK_CACHE]
1012
    if instance.disk_template in constants.DTS_EXT_MIRROR:
1013
      if disk_cache != "none":
1014
        # TODO: make this a hard error, instead of a silent overwrite
1015
        logging.warning("KVM: overriding disk_cache setting '%s' with 'none'"
1016
                        " to prevent shared storage corruption on migration",
1017
                        disk_cache)
1018
      cache_val = ",cache=none"
1019
    elif disk_cache != constants.HT_CACHE_DEFAULT:
1020
      cache_val = ",cache=%s" % disk_cache
1021
    else:
1022
      cache_val = ""
1023
    for cfdev, dev_path in block_devices:
1024
      if cfdev.mode != constants.DISK_RDWR:
1025
        raise errors.HypervisorError("Instance has read-only disks which"
1026
                                     " are not supported by KVM")
1027
      # TODO: handle FD_LOOP and FD_BLKTAP (?)
1028
      boot_val = ""
1029
      if boot_disk:
1030
        kvm_cmd.extend(["-boot", "c"])
1031
        boot_disk = False
1032
        if needs_boot_flag and disk_type != constants.HT_DISK_IDE:
1033
          boot_val = ",boot=on"
1034

    
1035
      drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
1036
                                                cache_val)
1037
      kvm_cmd.extend(["-drive", drive_val])
1038

    
1039
    #Now we can specify a different device type for CDROM devices.
1040
    cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
1041
    if not cdrom_disk_type:
1042
      cdrom_disk_type = disk_type
1043

    
1044
    iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
1045
    if iso_image:
1046
      options = ",format=raw,media=cdrom"
1047
      # set cdrom 'if' type
1048
      if boot_cdrom:
1049
        actual_cdrom_type = constants.HT_DISK_IDE
1050
      elif cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1051
        actual_cdrom_type = "virtio"
1052
      else:
1053
        actual_cdrom_type = cdrom_disk_type
1054
      if_val = ",if=%s" % actual_cdrom_type
1055
      # set boot flag, if needed
1056
      boot_val = ""
1057
      if boot_cdrom:
1058
        kvm_cmd.extend(["-boot", "d"])
1059
        if needs_boot_flag:
1060
          boot_val = ",boot=on"
1061
      # and finally build the entire '-drive' value
1062
      drive_val = "file=%s%s%s%s" % (iso_image, options, if_val, boot_val)
1063
      kvm_cmd.extend(["-drive", drive_val])
1064

    
1065
    iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
1066
    if iso_image2:
1067
      options = ",format=raw,media=cdrom"
1068
      if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1069
        if_val = ",if=virtio"
1070
      else:
1071
        if_val = ",if=%s" % cdrom_disk_type
1072
      drive_val = "file=%s%s%s" % (iso_image2, options, if_val)
1073
      kvm_cmd.extend(["-drive", drive_val])
1074

    
1075
    floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
1076
    if floppy_image:
1077
      options = ",format=raw,media=disk"
1078
      if boot_floppy:
1079
        kvm_cmd.extend(["-boot", "a"])
1080
        options = "%s,boot=on" % options
1081
      if_val = ",if=floppy"
1082
      options = "%s%s" % (options, if_val)
1083
      drive_val = "file=%s%s" % (floppy_image, options)
1084
      kvm_cmd.extend(["-drive", drive_val])
1085

    
1086
    if kernel_path:
1087
      kvm_cmd.extend(["-kernel", kernel_path])
1088
      initrd_path = hvp[constants.HV_INITRD_PATH]
1089
      if initrd_path:
1090
        kvm_cmd.extend(["-initrd", initrd_path])
1091
      root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
1092
                     hvp[constants.HV_KERNEL_ARGS]]
1093
      if hvp[constants.HV_SERIAL_CONSOLE]:
1094
        root_append.append("console=ttyS0,38400")
1095
      kvm_cmd.extend(["-append", " ".join(root_append)])
1096

    
1097
    mem_path = hvp[constants.HV_MEM_PATH]
1098
    if mem_path:
1099
      kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
1100

    
1101
    monitor_dev = ("unix:%s,server,nowait" %
1102
                   self._InstanceMonitor(instance.name))
1103
    kvm_cmd.extend(["-monitor", monitor_dev])
1104
    if hvp[constants.HV_SERIAL_CONSOLE]:
1105
      serial_dev = ("unix:%s,server,nowait" %
1106
                    self._InstanceSerial(instance.name))
1107
      kvm_cmd.extend(["-serial", serial_dev])
1108
    else:
1109
      kvm_cmd.extend(["-serial", "none"])
1110

    
1111
    mouse_type = hvp[constants.HV_USB_MOUSE]
1112
    vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
1113
    spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
1114
    spice_ip_version = None
1115

    
1116
    if mouse_type:
1117
      kvm_cmd.extend(["-usb"])
1118
      kvm_cmd.extend(["-usbdevice", mouse_type])
1119
    elif vnc_bind_address:
1120
      kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
1121

    
1122
    if vnc_bind_address:
1123
      if netutils.IP4Address.IsValid(vnc_bind_address):
1124
        if instance.network_port > constants.VNC_BASE_PORT:
1125
          display = instance.network_port - constants.VNC_BASE_PORT
1126
          if vnc_bind_address == constants.IP4_ADDRESS_ANY:
1127
            vnc_arg = ":%d" % (display)
1128
          else:
1129
            vnc_arg = "%s:%d" % (vnc_bind_address, display)
1130
        else:
1131
          logging.error("Network port is not a valid VNC display (%d < %d)."
1132
                        " Not starting VNC", instance.network_port,
1133
                        constants.VNC_BASE_PORT)
1134
          vnc_arg = "none"
1135

    
1136
        # Only allow tls and other option when not binding to a file, for now.
1137
        # kvm/qemu gets confused otherwise about the filename to use.
1138
        vnc_append = ""
1139
        if hvp[constants.HV_VNC_TLS]:
1140
          vnc_append = "%s,tls" % vnc_append
1141
          if hvp[constants.HV_VNC_X509_VERIFY]:
1142
            vnc_append = "%s,x509verify=%s" % (vnc_append,
1143
                                               hvp[constants.HV_VNC_X509])
1144
          elif hvp[constants.HV_VNC_X509]:
1145
            vnc_append = "%s,x509=%s" % (vnc_append,
1146
                                         hvp[constants.HV_VNC_X509])
1147
        if hvp[constants.HV_VNC_PASSWORD_FILE]:
1148
          vnc_append = "%s,password" % vnc_append
1149

    
1150
        vnc_arg = "%s%s" % (vnc_arg, vnc_append)
1151

    
1152
      else:
1153
        vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
1154

    
1155
      kvm_cmd.extend(["-vnc", vnc_arg])
1156
    elif spice_bind:
1157
      # FIXME: this is wrong here; the iface ip address differs
1158
      # between systems, so it should be done in _ExecuteKVMRuntime
1159
      if netutils.IsValidInterface(spice_bind):
1160
        # The user specified a network interface, we have to figure out the IP
1161
        # address.
1162
        addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1163
        spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1164

    
1165
        # if the user specified an IP version and the interface does not
1166
        # have that kind of IP addresses, throw an exception
1167
        if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1168
          if not addresses[spice_ip_version]:
1169
            raise errors.HypervisorError("spice: unable to get an IPv%s address"
1170
                                         " for %s" % (spice_ip_version,
1171
                                                      spice_bind))
1172

    
1173
        # the user did not specify an IP version, we have to figure it out
1174
        elif (addresses[constants.IP4_VERSION] and
1175
              addresses[constants.IP6_VERSION]):
1176
          # we have both ipv4 and ipv6, let's use the cluster default IP
1177
          # version
1178
          cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1179
          spice_ip_version = \
1180
            netutils.IPAddress.GetVersionFromAddressFamily(cluster_family)
1181
        elif addresses[constants.IP4_VERSION]:
1182
          spice_ip_version = constants.IP4_VERSION
1183
        elif addresses[constants.IP6_VERSION]:
1184
          spice_ip_version = constants.IP6_VERSION
1185
        else:
1186
          raise errors.HypervisorError("spice: unable to get an IP address"
1187
                                       " for %s" % (spice_bind))
1188

    
1189
        spice_address = addresses[spice_ip_version][0]
1190

    
1191
      else:
1192
        # spice_bind is known to be a valid IP address, because
1193
        # ValidateParameters checked it.
1194
        spice_address = spice_bind
1195

    
1196
      spice_arg = "addr=%s" % spice_address
1197
      if hvp[constants.HV_KVM_SPICE_USE_TLS]:
1198
        spice_arg = "%s,tls-port=%s,x509-cacert-file=%s" % (spice_arg,
1199
            instance.network_port, constants.SPICE_CACERT_FILE)
1200
        spice_arg = "%s,x509-key-file=%s,x509-cert-file=%s" % (spice_arg,
1201
            constants.SPICE_CERT_FILE, constants.SPICE_CERT_FILE)
1202
        tls_ciphers = hvp[constants.HV_KVM_SPICE_TLS_CIPHERS]
1203
        if tls_ciphers:
1204
          spice_arg = "%s,tls-ciphers=%s" % (spice_arg, tls_ciphers)
1205
      else:
1206
        spice_arg = "%s,port=%s" % (spice_arg, instance.network_port)
1207

    
1208
      if not hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]:
1209
        spice_arg = "%s,disable-ticketing" % spice_arg
1210

    
1211
      if spice_ip_version:
1212
        spice_arg = "%s,ipv%s" % (spice_arg, spice_ip_version)
1213

    
1214
      # Image compression options
1215
      img_lossless = hvp[constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR]
1216
      img_jpeg = hvp[constants.HV_KVM_SPICE_JPEG_IMG_COMPR]
1217
      img_zlib_glz = hvp[constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR]
1218
      if img_lossless:
1219
        spice_arg = "%s,image-compression=%s" % (spice_arg, img_lossless)
1220
      if img_jpeg:
1221
        spice_arg = "%s,jpeg-wan-compression=%s" % (spice_arg, img_jpeg)
1222
      if img_zlib_glz:
1223
        spice_arg = "%s,zlib-glz-wan-compression=%s" % (spice_arg, img_zlib_glz)
1224

    
1225
      # Video stream detection
1226
      video_streaming = hvp[constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION]
1227
      if video_streaming:
1228
        spice_arg = "%s,streaming-video=%s" % (spice_arg, video_streaming)
1229

    
1230
      # Audio compression, by default in qemu-kvm it is on
1231
      if not hvp[constants.HV_KVM_SPICE_AUDIO_COMPR]:
1232
        spice_arg = "%s,playback-compression=off" % spice_arg
1233
      if not hvp[constants.HV_KVM_SPICE_USE_VDAGENT]:
1234
        spice_arg = "%s,agent-mouse=off" % spice_arg
1235
      else:
1236
        # Enable the spice agent communication channel between the host and the
1237
        # agent.
1238
        kvm_cmd.extend(["-device", "virtio-serial-pci"])
1239
        kvm_cmd.extend(["-device", "virtserialport,chardev=spicechannel0,"
1240
                                                   "name=com.redhat.spice.0"])
1241
        kvm_cmd.extend(["-chardev", "spicevmc,id=spicechannel0,name=vdagent"])
1242

    
1243
      logging.info("KVM: SPICE will listen on port %s", instance.network_port)
1244
      kvm_cmd.extend(["-spice", spice_arg])
1245

    
1246
      # Tell kvm to use the paravirtualized graphic card, optimized for SPICE
1247
      kvm_cmd.extend(["-vga", "qxl"])
1248

    
1249
    else:
1250
      kvm_cmd.extend(["-nographic"])
1251

    
1252
    if hvp[constants.HV_USE_LOCALTIME]:
1253
      kvm_cmd.extend(["-localtime"])
1254

    
1255
    if hvp[constants.HV_KVM_USE_CHROOT]:
1256
      kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1257

    
1258
    # Save the current instance nics, but defer their expansion as parameters,
1259
    # as we'll need to generate executable temp files for them.
1260
    kvm_nics = instance.nics
1261
    hvparams = hvp
1262

    
1263
    return (kvm_cmd, kvm_nics, hvparams)
1264

    
1265
  def _WriteKVMRuntime(self, instance_name, data):
1266
    """Write an instance's KVM runtime
1267

1268
    """
1269
    try:
1270
      utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1271
                      data=data)
1272
    except EnvironmentError, err:
1273
      raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1274

    
1275
  def _ReadKVMRuntime(self, instance_name):
1276
    """Read an instance's KVM runtime
1277

1278
    """
1279
    try:
1280
      file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1281
    except EnvironmentError, err:
1282
      raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1283
    return file_content
1284

    
1285
  def _SaveKVMRuntime(self, instance, kvm_runtime):
1286
    """Save an instance's KVM runtime
1287

1288
    """
1289
    kvm_cmd, kvm_nics, hvparams = kvm_runtime
1290
    serialized_nics = [nic.ToDict() for nic in kvm_nics]
1291
    serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1292
    self._WriteKVMRuntime(instance.name, serialized_form)
1293

    
1294
  def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1295
    """Load an instance's KVM runtime
1296

1297
    """
1298
    if not serialized_runtime:
1299
      serialized_runtime = self._ReadKVMRuntime(instance.name)
1300
    loaded_runtime = serializer.Load(serialized_runtime)
1301
    kvm_cmd, serialized_nics, hvparams = loaded_runtime
1302
    kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1303
    return (kvm_cmd, kvm_nics, hvparams)
1304

    
1305
  def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1306
    """Run the KVM cmd and check for errors
1307

1308
    @type name: string
1309
    @param name: instance name
1310
    @type kvm_cmd: list of strings
1311
    @param kvm_cmd: runcmd input for kvm
1312
    @type tap_fds: list of int
1313
    @param tap_fds: fds of tap devices opened by Ganeti
1314

1315
    """
1316
    try:
1317
      result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1318
    finally:
1319
      for fd in tap_fds:
1320
        utils_wrapper.CloseFdNoError(fd)
1321

    
1322
    if result.failed:
1323
      raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1324
                                   (name, result.fail_reason, result.output))
1325
    if not self._InstancePidAlive(name)[2]:
1326
      raise errors.HypervisorError("Failed to start instance %s" % name)
1327

    
1328
  def _ExecuteKVMRuntime(self, instance, kvm_runtime, incoming=None):
1329
    """Execute a KVM cmd, after completing it with some last minute data.
1330

1331
    @type incoming: tuple of strings
1332
    @param incoming: (target_host_ip, port)
1333

1334
    """
1335
    # Small _ExecuteKVMRuntime hv parameters programming howto:
1336
    #  - conf_hvp contains the parameters as configured on ganeti. they might
1337
    #    have changed since the instance started; only use them if the change
1338
    #    won't affect the inside of the instance (which hasn't been rebooted).
1339
    #  - up_hvp contains the parameters as they were when the instance was
1340
    #    started, plus any new parameter which has been added between ganeti
1341
    #    versions: it is paramount that those default to a value which won't
1342
    #    affect the inside of the instance as well.
1343
    conf_hvp = instance.hvparams
1344
    name = instance.name
1345
    self._CheckDown(name)
1346

    
1347
    temp_files = []
1348

    
1349
    kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1350
    up_hvp = objects.FillDict(conf_hvp, up_hvp)
1351

    
1352
    _, v_major, v_min, _ = self._GetKVMVersion()
1353

    
1354
    # We know it's safe to run as a different user upon migration, so we'll use
1355
    # the latest conf, from conf_hvp.
1356
    security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1357
    if security_model == constants.HT_SM_USER:
1358
      kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1359

    
1360
    keymap = conf_hvp[constants.HV_KEYMAP]
1361
    if keymap:
1362
      keymap_path = self._InstanceKeymapFile(name)
1363
      # If a keymap file is specified, KVM won't use its internal defaults. By
1364
      # first including the "en-us" layout, an error on loading the actual
1365
      # layout (e.g. because it can't be found) won't lead to a non-functional
1366
      # keyboard. A keyboard with incorrect keys is still better than none.
1367
      utils.WriteFile(keymap_path, data="include en-us\ninclude %s\n" % keymap)
1368
      kvm_cmd.extend(["-k", keymap_path])
1369

    
1370
    # We have reasons to believe changing something like the nic driver/type
1371
    # upon migration won't exactly fly with the instance kernel, so for nic
1372
    # related parameters we'll use up_hvp
1373
    tapfds = []
1374
    taps = []
1375
    if not kvm_nics:
1376
      kvm_cmd.extend(["-net", "none"])
1377
    else:
1378
      vnet_hdr = False
1379
      tap_extra = ""
1380
      nic_type = up_hvp[constants.HV_NIC_TYPE]
1381
      if nic_type == constants.HT_NIC_PARAVIRTUAL:
1382
        # From version 0.12.0, kvm uses a new sintax for network configuration.
1383
        if (v_major, v_min) >= (0, 12):
1384
          nic_model = "virtio-net-pci"
1385
          vnet_hdr = True
1386
        else:
1387
          nic_model = "virtio"
1388

    
1389
        if up_hvp[constants.HV_VHOST_NET]:
1390
          # vhost_net is only available from version 0.13.0 or newer
1391
          if (v_major, v_min) >= (0, 13):
1392
            tap_extra = ",vhost=on"
1393
          else:
1394
            raise errors.HypervisorError("vhost_net is configured"
1395
                                        " but it is not available")
1396
      else:
1397
        nic_model = nic_type
1398

    
1399
      for nic_seq, nic in enumerate(kvm_nics):
1400
        tapname, tapfd = _OpenTap(vnet_hdr)
1401
        tapfds.append(tapfd)
1402
        taps.append(tapname)
1403
        if (v_major, v_min) >= (0, 12):
1404
          nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1405
          tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1406
          kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1407
        else:
1408
          nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1409
                                                         nic.mac, nic_model)
1410
          tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1411
          kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1412

    
1413
    if incoming:
1414
      target, port = incoming
1415
      kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1416

    
1417
    # Changing the vnc password doesn't bother the guest that much. At most it
1418
    # will surprise people who connect to it. Whether positively or negatively
1419
    # it's debatable.
1420
    vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1421
    vnc_pwd = None
1422
    if vnc_pwd_file:
1423
      try:
1424
        vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1425
      except EnvironmentError, err:
1426
        raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1427
                                     % (vnc_pwd_file, err))
1428

    
1429
    if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1430
      utils.EnsureDirs([(self._InstanceChrootDir(name),
1431
                         constants.SECURE_DIR_MODE)])
1432

    
1433
    # Automatically enable QMP if version is >= 0.14
1434
    if (v_major, v_min) >= (0, 14):
1435
      logging.debug("Enabling QMP")
1436
      kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1437
                    self._InstanceQmpMonitor(instance.name)])
1438

    
1439
    # Configure the network now for starting instances and bridged interfaces,
1440
    # during FinalizeMigration for incoming instances' routed interfaces
1441
    for nic_seq, nic in enumerate(kvm_nics):
1442
      if (incoming and
1443
          nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1444
        continue
1445
      self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1446

    
1447
    # CPU affinity requires kvm to start paused, so we set this flag if the
1448
    # instance is not already paused and if we are not going to accept a
1449
    # migrating instance. In the latter case, pausing is not needed.
1450
    start_kvm_paused = not (_KVM_START_PAUSED_FLAG in kvm_cmd) and not incoming
1451
    if start_kvm_paused:
1452
      kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
1453

    
1454
    # Note: CPU pinning is using up_hvp since changes take effect
1455
    # during instance startup anyway, and to avoid problems when soft
1456
    # rebooting the instance.
1457
    cpu_pinning = False
1458
    if up_hvp.get(constants.HV_CPU_MASK, None):
1459
      cpu_pinning = True
1460

    
1461
    if security_model == constants.HT_SM_POOL:
1462
      ss = ssconf.SimpleStore()
1463
      uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1464
      all_uids = set(uidpool.ExpandUidPool(uid_pool))
1465
      uid = uidpool.RequestUnusedUid(all_uids)
1466
      try:
1467
        username = pwd.getpwuid(uid.GetUid()).pw_name
1468
        kvm_cmd.extend(["-runas", username])
1469
        self._RunKVMCmd(name, kvm_cmd, tapfds)
1470
      except:
1471
        uidpool.ReleaseUid(uid)
1472
        raise
1473
      else:
1474
        uid.Unlock()
1475
        utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1476
    else:
1477
      self._RunKVMCmd(name, kvm_cmd, tapfds)
1478

    
1479
    utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1480
                     constants.RUN_DIRS_MODE)])
1481
    for nic_seq, tap in enumerate(taps):
1482
      utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1483
                      data=tap)
1484

    
1485
    if vnc_pwd:
1486
      change_cmd = "change vnc password %s" % vnc_pwd
1487
      self._CallMonitorCommand(instance.name, change_cmd)
1488

    
1489
    # Setting SPICE password. We are not vulnerable to malicious passwordless
1490
    # connection attempts because SPICE by default does not allow connections
1491
    # if neither a password nor the "disable_ticketing" options are specified.
1492
    # As soon as we send the password via QMP, that password is a valid ticket
1493
    # for connection.
1494
    spice_password_file = conf_hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]
1495
    if spice_password_file:
1496
      spice_pwd = ""
1497
      try:
1498
        spice_pwd = utils.ReadOneLineFile(spice_password_file, strict=True)
1499
      except EnvironmentError, err:
1500
        raise errors.HypervisorError("Failed to open SPICE password file %s: %s"
1501
                                     % (spice_password_file, err))
1502

    
1503
      qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1504
      qmp.connect()
1505
      arguments = {
1506
          "protocol": "spice",
1507
          "password": spice_pwd,
1508
      }
1509
      qmp.Execute("set_password", arguments)
1510

    
1511
    for filename in temp_files:
1512
      utils.RemoveFile(filename)
1513

    
1514
    # If requested, set CPU affinity and resume instance execution
1515
    if cpu_pinning:
1516
      self._ExecuteCpuAffinity(instance.name, up_hvp[constants.HV_CPU_MASK])
1517

    
1518
    start_memory = self._InstanceStartupMemory(instance)
1519
    if start_memory < instance.beparams[constants.BE_MAXMEM]:
1520
      self.BalloonInstanceMemory(instance, start_memory)
1521

    
1522
    if start_kvm_paused:
1523
      # To control CPU pinning, ballooning, and vnc/spice passwords
1524
      # the VM was started in a frozen state. If freezing was not
1525
      # explicitly requested resume the vm status.
1526
      self._CallMonitorCommand(instance.name, self._CONT_CMD)
1527

    
1528
  def StartInstance(self, instance, block_devices, startup_paused):
1529
    """Start an instance.
1530

1531
    """
1532
    self._CheckDown(instance.name)
1533
    kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1534
                                           startup_paused)
1535
    self._SaveKVMRuntime(instance, kvm_runtime)
1536
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1537

    
1538
  def _CallMonitorCommand(self, instance_name, command):
1539
    """Invoke a command on the instance monitor.
1540

1541
    """
1542
    socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1543
             (utils.ShellQuote(command),
1544
              constants.SOCAT_PATH,
1545
              utils.ShellQuote(self._InstanceMonitor(instance_name))))
1546
    result = utils.RunCmd(socat)
1547
    if result.failed:
1548
      msg = ("Failed to send command '%s' to instance %s."
1549
             " output: %s, error: %s, fail_reason: %s" %
1550
             (command, instance_name,
1551
              result.stdout, result.stderr, result.fail_reason))
1552
      raise errors.HypervisorError(msg)
1553

    
1554
    return result
1555

    
1556
  @classmethod
1557
  def _ParseKVMVersion(cls, text):
1558
    """Parse the KVM version from the --help output.
1559

1560
    @type text: string
1561
    @param text: output of kvm --help
1562
    @return: (version, v_maj, v_min, v_rev)
1563
    @raise errors.HypervisorError: when the KVM version cannot be retrieved
1564

1565
    """
1566
    match = cls._VERSION_RE.search(text.splitlines()[0])
1567
    if not match:
1568
      raise errors.HypervisorError("Unable to get KVM version")
1569

    
1570
    v_all = match.group(0)
1571
    v_maj = int(match.group(1))
1572
    v_min = int(match.group(2))
1573
    if match.group(4):
1574
      v_rev = int(match.group(4))
1575
    else:
1576
      v_rev = 0
1577
    return (v_all, v_maj, v_min, v_rev)
1578

    
1579
  @classmethod
1580
  def _GetKVMVersion(cls):
1581
    """Return the installed KVM version.
1582

1583
    @return: (version, v_maj, v_min, v_rev)
1584
    @raise errors.HypervisorError: when the KVM version cannot be retrieved
1585

1586
    """
1587
    result = utils.RunCmd([constants.KVM_PATH, "--help"])
1588
    if result.failed:
1589
      raise errors.HypervisorError("Unable to get KVM version")
1590
    return cls._ParseKVMVersion(result.output)
1591

    
1592
  def StopInstance(self, instance, force=False, retry=False, name=None):
1593
    """Stop an instance.
1594

1595
    """
1596
    if name is not None and not force:
1597
      raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1598
    if name is None:
1599
      name = instance.name
1600
      acpi = instance.hvparams[constants.HV_ACPI]
1601
    else:
1602
      acpi = False
1603
    _, pid, alive = self._InstancePidAlive(name)
1604
    if pid > 0 and alive:
1605
      if force or not acpi:
1606
        utils.KillProcess(pid)
1607
      else:
1608
        self._CallMonitorCommand(name, "system_powerdown")
1609

    
1610
  def CleanupInstance(self, instance_name):
1611
    """Cleanup after a stopped instance
1612

1613
    """
1614
    pidfile, pid, alive = self._InstancePidAlive(instance_name)
1615
    if pid > 0 and alive:
1616
      raise errors.HypervisorError("Cannot cleanup a live instance")
1617
    self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1618

    
1619
  def RebootInstance(self, instance):
1620
    """Reboot an instance.
1621

1622
    """
1623
    # For some reason if we do a 'send-key ctrl-alt-delete' to the control
1624
    # socket the instance will stop, but now power up again. So we'll resort
1625
    # to shutdown and restart.
1626
    _, _, alive = self._InstancePidAlive(instance.name)
1627
    if not alive:
1628
      raise errors.HypervisorError("Failed to reboot instance %s:"
1629
                                   " not running" % instance.name)
1630
    # StopInstance will delete the saved KVM runtime so:
1631
    # ...first load it...
1632
    kvm_runtime = self._LoadKVMRuntime(instance)
1633
    # ...now we can safely call StopInstance...
1634
    if not self.StopInstance(instance):
1635
      self.StopInstance(instance, force=True)
1636
    # ...and finally we can save it again, and execute it...
1637
    self._SaveKVMRuntime(instance, kvm_runtime)
1638
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1639

    
1640
  def MigrationInfo(self, instance):
1641
    """Get instance information to perform a migration.
1642

1643
    @type instance: L{objects.Instance}
1644
    @param instance: instance to be migrated
1645
    @rtype: string
1646
    @return: content of the KVM runtime file
1647

1648
    """
1649
    return self._ReadKVMRuntime(instance.name)
1650

    
1651
  def AcceptInstance(self, instance, info, target):
1652
    """Prepare to accept an instance.
1653

1654
    @type instance: L{objects.Instance}
1655
    @param instance: instance to be accepted
1656
    @type info: string
1657
    @param info: content of the KVM runtime file on the source node
1658
    @type target: string
1659
    @param target: target host (usually ip), on this node
1660

1661
    """
1662
    kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1663
    incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1664
    self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1665

    
1666
  def FinalizeMigrationDst(self, instance, info, success):
1667
    """Finalize the instance migration on the target node.
1668

1669
    Stop the incoming mode KVM.
1670

1671
    @type instance: L{objects.Instance}
1672
    @param instance: instance whose migration is being finalized
1673

1674
    """
1675
    if success:
1676
      kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1677
      kvm_nics = kvm_runtime[1]
1678

    
1679
      for nic_seq, nic in enumerate(kvm_nics):
1680
        if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1681
          # Bridged interfaces have already been configured
1682
          continue
1683
        try:
1684
          tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1685
        except EnvironmentError, err:
1686
          logging.warning("Failed to find host interface for %s NIC #%d: %s",
1687
                          instance.name, nic_seq, str(err))
1688
          continue
1689
        try:
1690
          self._ConfigureNIC(instance, nic_seq, nic, tap)
1691
        except errors.HypervisorError, err:
1692
          logging.warning(str(err))
1693

    
1694
      self._WriteKVMRuntime(instance.name, info)
1695
    else:
1696
      self.StopInstance(instance, force=True)
1697

    
1698
  def MigrateInstance(self, instance, target, live):
1699
    """Migrate an instance to a target node.
1700

1701
    The migration will not be attempted if the instance is not
1702
    currently running.
1703

1704
    @type instance: L{objects.Instance}
1705
    @param instance: the instance to be migrated
1706
    @type target: string
1707
    @param target: ip address of the target node
1708
    @type live: boolean
1709
    @param live: perform a live migration
1710

1711
    """
1712
    instance_name = instance.name
1713
    port = instance.hvparams[constants.HV_MIGRATION_PORT]
1714
    _, _, alive = self._InstancePidAlive(instance_name)
1715
    if not alive:
1716
      raise errors.HypervisorError("Instance not running, cannot migrate")
1717

    
1718
    if not live:
1719
      self._CallMonitorCommand(instance_name, "stop")
1720

    
1721
    migrate_command = ("migrate_set_speed %dm" %
1722
        instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1723
    self._CallMonitorCommand(instance_name, migrate_command)
1724

    
1725
    migrate_command = ("migrate_set_downtime %dms" %
1726
        instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1727
    self._CallMonitorCommand(instance_name, migrate_command)
1728

    
1729
    migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1730
    self._CallMonitorCommand(instance_name, migrate_command)
1731

    
1732
  def FinalizeMigrationSource(self, instance, success, live):
1733
    """Finalize the instance migration on the source node.
1734

1735
    @type instance: L{objects.Instance}
1736
    @param instance: the instance that was migrated
1737
    @type success: bool
1738
    @param success: whether the migration succeeded or not
1739
    @type live: bool
1740
    @param live: whether the user requested a live migration or not
1741

1742
    """
1743
    if success:
1744
      pidfile, pid, _ = self._InstancePidAlive(instance.name)
1745
      utils.KillProcess(pid)
1746
      self._RemoveInstanceRuntimeFiles(pidfile, instance.name)
1747
    elif live:
1748
      self._CallMonitorCommand(instance.name, self._CONT_CMD)
1749

    
1750
  def GetMigrationStatus(self, instance):
1751
    """Get the migration status
1752

1753
    @type instance: L{objects.Instance}
1754
    @param instance: the instance that is being migrated
1755
    @rtype: L{objects.MigrationStatus}
1756
    @return: the status of the current migration (one of
1757
             L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1758
             progress info that can be retrieved from the hypervisor
1759

1760
    """
1761
    info_command = "info migrate"
1762
    for _ in range(self._MIGRATION_INFO_MAX_BAD_ANSWERS):
1763
      result = self._CallMonitorCommand(instance.name, info_command)
1764
      match = self._MIGRATION_STATUS_RE.search(result.stdout)
1765
      if not match:
1766
        if not result.stdout:
1767
          logging.info("KVM: empty 'info migrate' result")
1768
        else:
1769
          logging.warning("KVM: unknown 'info migrate' result: %s",
1770
                          result.stdout)
1771
      else:
1772
        status = match.group(1)
1773
        if status in constants.HV_KVM_MIGRATION_VALID_STATUSES:
1774
          migration_status = objects.MigrationStatus(status=status)
1775
          match = self._MIGRATION_PROGRESS_RE.search(result.stdout)
1776
          if match:
1777
            migration_status.transferred_ram = match.group("transferred")
1778
            migration_status.total_ram = match.group("total")
1779

    
1780
          return migration_status
1781

    
1782
        logging.warning("KVM: unknown migration status '%s'", status)
1783

    
1784
      time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1785

    
1786
    return objects.MigrationStatus(status=constants.HV_MIGRATION_FAILED,
1787
                                  info="Too many 'info migrate' broken answers")
1788

    
1789
  def BalloonInstanceMemory(self, instance, mem):
1790
    """Balloon an instance memory to a certain value.
1791

1792
    @type instance: L{objects.Instance}
1793
    @param instance: instance to be accepted
1794
    @type mem: int
1795
    @param mem: actual memory size to use for instance runtime
1796

1797
    """
1798
    self._CallMonitorCommand(instance.name, "balloon %d" % mem)
1799

    
1800
  def GetNodeInfo(self):
1801
    """Return information about the node.
1802

1803
    @return: a dict with the following keys (values in MiB):
1804
          - memory_total: the total memory size on the node
1805
          - memory_free: the available memory on the node for instances
1806
          - memory_dom0: the memory used by the node itself, if available
1807
          - hv_version: the hypervisor version in the form (major, minor,
1808
                        revision)
1809

1810
    """
1811
    result = self.GetLinuxNodeInfo()
1812
    _, v_major, v_min, v_rev = self._GetKVMVersion()
1813
    result[constants.HV_NODEINFO_KEY_VERSION] = (v_major, v_min, v_rev)
1814
    return result
1815

    
1816
  @classmethod
1817
  def GetInstanceConsole(cls, instance, hvparams, beparams):
1818
    """Return a command for connecting to the console of an instance.
1819

1820
    """
1821
    if hvparams[constants.HV_SERIAL_CONSOLE]:
1822
      cmd = [constants.KVM_CONSOLE_WRAPPER,
1823
             constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1824
             utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1825
             "STDIO,%s" % cls._SocatUnixConsoleParams(),
1826
             "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1827
      return objects.InstanceConsole(instance=instance.name,
1828
                                     kind=constants.CONS_SSH,
1829
                                     host=instance.primary_node,
1830
                                     user=constants.GANETI_RUNAS,
1831
                                     command=cmd)
1832

    
1833
    vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1834
    if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1835
      display = instance.network_port - constants.VNC_BASE_PORT
1836
      return objects.InstanceConsole(instance=instance.name,
1837
                                     kind=constants.CONS_VNC,
1838
                                     host=vnc_bind_address,
1839
                                     port=instance.network_port,
1840
                                     display=display)
1841

    
1842
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1843
    if spice_bind:
1844
      return objects.InstanceConsole(instance=instance.name,
1845
                                     kind=constants.CONS_SPICE,
1846
                                     host=spice_bind,
1847
                                     port=instance.network_port)
1848

    
1849
    return objects.InstanceConsole(instance=instance.name,
1850
                                   kind=constants.CONS_MESSAGE,
1851
                                   message=("No serial shell for instance %s" %
1852
                                            instance.name))
1853

    
1854
  def Verify(self):
1855
    """Verify the hypervisor.
1856

1857
    Check that the binary exists.
1858

1859
    """
1860
    if not os.path.exists(constants.KVM_PATH):
1861
      return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1862
    if not os.path.exists(constants.SOCAT_PATH):
1863
      return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1864

    
1865
  @classmethod
1866
  def CheckParameterSyntax(cls, hvparams):
1867
    """Check the given parameters for validity.
1868

1869
    @type hvparams:  dict
1870
    @param hvparams: dictionary with parameter names/value
1871
    @raise errors.HypervisorError: when a parameter is not valid
1872

1873
    """
1874
    super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1875

    
1876
    kernel_path = hvparams[constants.HV_KERNEL_PATH]
1877
    if kernel_path:
1878
      if not hvparams[constants.HV_ROOT_PATH]:
1879
        raise errors.HypervisorError("Need a root partition for the instance,"
1880
                                     " if a kernel is defined")
1881

    
1882
    if (hvparams[constants.HV_VNC_X509_VERIFY] and
1883
        not hvparams[constants.HV_VNC_X509]):
1884
      raise errors.HypervisorError("%s must be defined, if %s is" %
1885
                                   (constants.HV_VNC_X509,
1886
                                    constants.HV_VNC_X509_VERIFY))
1887

    
1888
    boot_order = hvparams[constants.HV_BOOT_ORDER]
1889
    if (boot_order == constants.HT_BO_CDROM and
1890
        not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1891
      raise errors.HypervisorError("Cannot boot from cdrom without an"
1892
                                   " ISO path")
1893

    
1894
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1895
    if security_model == constants.HT_SM_USER:
1896
      if not hvparams[constants.HV_SECURITY_DOMAIN]:
1897
        raise errors.HypervisorError("A security domain (user to run kvm as)"
1898
                                     " must be specified")
1899
    elif (security_model == constants.HT_SM_NONE or
1900
          security_model == constants.HT_SM_POOL):
1901
      if hvparams[constants.HV_SECURITY_DOMAIN]:
1902
        raise errors.HypervisorError("Cannot have a security domain when the"
1903
                                     " security model is 'none' or 'pool'")
1904

    
1905
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1906
    spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1907
    if spice_bind:
1908
      if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1909
        # if an IP version is specified, the spice_bind parameter must be an
1910
        # IP of that family
1911
        if (netutils.IP4Address.IsValid(spice_bind) and
1912
            spice_ip_version != constants.IP4_VERSION):
1913
          raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1914
                                       " the specified IP version is %s" %
1915
                                       (spice_bind, spice_ip_version))
1916

    
1917
        if (netutils.IP6Address.IsValid(spice_bind) and
1918
            spice_ip_version != constants.IP6_VERSION):
1919
          raise errors.HypervisorError("spice: got an IPv6 address (%s), but"
1920
                                       " the specified IP version is %s" %
1921
                                       (spice_bind, spice_ip_version))
1922
    else:
1923
      # All the other SPICE parameters depend on spice_bind being set. Raise an
1924
      # error if any of them is set without it.
1925
      spice_additional_params = frozenset([
1926
        constants.HV_KVM_SPICE_IP_VERSION,
1927
        constants.HV_KVM_SPICE_PASSWORD_FILE,
1928
        constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR,
1929
        constants.HV_KVM_SPICE_JPEG_IMG_COMPR,
1930
        constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR,
1931
        constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION,
1932
        constants.HV_KVM_SPICE_USE_TLS,
1933
        ])
1934
      for param in spice_additional_params:
1935
        if hvparams[param]:
1936
          raise errors.HypervisorError("spice: %s requires %s to be set" %
1937
                                       (param, constants.HV_KVM_SPICE_BIND))
1938

    
1939
  @classmethod
1940
  def ValidateParameters(cls, hvparams):
1941
    """Check the given parameters for validity.
1942

1943
    @type hvparams:  dict
1944
    @param hvparams: dictionary with parameter names/value
1945
    @raise errors.HypervisorError: when a parameter is not valid
1946

1947
    """
1948
    super(KVMHypervisor, cls).ValidateParameters(hvparams)
1949

    
1950
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1951
    if security_model == constants.HT_SM_USER:
1952
      username = hvparams[constants.HV_SECURITY_DOMAIN]
1953
      try:
1954
        pwd.getpwnam(username)
1955
      except KeyError:
1956
        raise errors.HypervisorError("Unknown security domain user %s"
1957
                                     % username)
1958

    
1959
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1960
    if spice_bind:
1961
      # only one of VNC and SPICE can be used currently.
1962
      if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1963
        raise errors.HypervisorError("both SPICE and VNC are configured, but"
1964
                                     " only one of them can be used at a"
1965
                                     " given time.")
1966

    
1967
      # KVM version should be >= 0.14.0
1968
      _, v_major, v_min, _ = cls._GetKVMVersion()
1969
      if (v_major, v_min) < (0, 14):
1970
        raise errors.HypervisorError("spice is configured, but it is not"
1971
                                     " available in versions of KVM < 0.14")
1972

    
1973
      # if spice_bind is not an IP address, it must be a valid interface
1974
      bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1975
                       or netutils.IP6Address.IsValid(spice_bind))
1976
      if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1977
        raise errors.HypervisorError("spice: the %s parameter must be either"
1978
                                     " a valid IP address or interface name" %
1979
                                     constants.HV_KVM_SPICE_BIND)
1980

    
1981
  @classmethod
1982
  def PowercycleNode(cls):
1983
    """KVM powercycle, just a wrapper over Linux powercycle.
1984

1985
    """
1986
    cls.LinuxPowercycle()