Statistics
| Branch: | Tag: | Revision:

root / lib / hypervisor / hv_kvm.py @ 69ab2e12

History | View | Annotate | Download (61.7 kB)

1
#
2
#
3

    
4
# Copyright (C) 2008, 2009, 2010, 2011 Google Inc.
5
#
6
# This program is free software; you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation; either version 2 of the License, or
9
# (at your option) any later version.
10
#
11
# This program is distributed in the hope that it will be useful, but
12
# WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
# General Public License for more details.
15
#
16
# You should have received a copy of the GNU General Public License
17
# along with this program; if not, write to the Free Software
18
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19
# 02110-1301, USA.
20

    
21

    
22
"""KVM hypervisor
23

24
"""
25

    
26
import errno
27
import os
28
import os.path
29
import re
30
import tempfile
31
import time
32
import logging
33
import pwd
34
import struct
35
import fcntl
36
import shutil
37
import socket
38
import StringIO
39

    
40
from ganeti import utils
41
from ganeti import constants
42
from ganeti import errors
43
from ganeti import serializer
44
from ganeti import objects
45
from ganeti import uidpool
46
from ganeti import ssconf
47
from ganeti.hypervisor import hv_base
48
from ganeti import netutils
49
from ganeti.utils import wrapper as utils_wrapper
50

    
51

    
52
_KVM_NETWORK_SCRIPT = constants.SYSCONFDIR + "/ganeti/kvm-vif-bridge"
53

    
54
# TUN/TAP driver constants, taken from <linux/if_tun.h>
55
# They are architecture-independent and already hardcoded in qemu-kvm source,
56
# so we can safely include them here.
57
TUNSETIFF = 0x400454ca
58
TUNGETIFF = 0x800454d2
59
TUNGETFEATURES = 0x800454cf
60
IFF_TAP = 0x0002
61
IFF_NO_PI = 0x1000
62
IFF_VNET_HDR = 0x4000
63

    
64

    
65
def _ProbeTapVnetHdr(fd):
66
  """Check whether to enable the IFF_VNET_HDR flag.
67

68
  To do this, _all_ of the following conditions must be met:
69
   1. TUNGETFEATURES ioctl() *must* be implemented
70
   2. TUNGETFEATURES ioctl() result *must* contain the IFF_VNET_HDR flag
71
   3. TUNGETIFF ioctl() *must* be implemented; reading the kernel code in
72
      drivers/net/tun.c there is no way to test this until after the tap device
73
      has been created using TUNSETIFF, and there is no way to change the
74
      IFF_VNET_HDR flag after creating the interface, catch-22! However both
75
      TUNGETIFF and TUNGETFEATURES were introduced in kernel version 2.6.27,
76
      thus we can expect TUNGETIFF to be present if TUNGETFEATURES is.
77

78
   @type fd: int
79
   @param fd: the file descriptor of /dev/net/tun
80

81
  """
82
  req = struct.pack("I", 0)
83
  try:
84
    res = fcntl.ioctl(fd, TUNGETFEATURES, req)
85
  except EnvironmentError:
86
    logging.warning("TUNGETFEATURES ioctl() not implemented")
87
    return False
88

    
89
  tunflags = struct.unpack("I", res)[0]
90
  if tunflags & IFF_VNET_HDR:
91
    return True
92
  else:
93
    logging.warning("Host does not support IFF_VNET_HDR, not enabling")
94
    return False
95

    
96

    
97
def _OpenTap(vnet_hdr=True):
98
  """Open a new tap device and return its file descriptor.
99

100
  This is intended to be used by a qemu-type hypervisor together with the -net
101
  tap,fd=<fd> command line parameter.
102

103
  @type vnet_hdr: boolean
104
  @param vnet_hdr: Enable the VNET Header
105
  @return: (ifname, tapfd)
106
  @rtype: tuple
107

108
  """
109
  try:
110
    tapfd = os.open("/dev/net/tun", os.O_RDWR)
111
  except EnvironmentError:
112
    raise errors.HypervisorError("Failed to open /dev/net/tun")
113

    
114
  flags = IFF_TAP | IFF_NO_PI
115

    
116
  if vnet_hdr and _ProbeTapVnetHdr(tapfd):
117
    flags |= IFF_VNET_HDR
118

    
119
  # The struct ifreq ioctl request (see netdevice(7))
120
  ifr = struct.pack("16sh", "", flags)
121

    
122
  try:
123
    res = fcntl.ioctl(tapfd, TUNSETIFF, ifr)
124
  except EnvironmentError:
125
    raise errors.HypervisorError("Failed to allocate a new TAP device")
126

    
127
  # Get the interface name from the ioctl
128
  ifname = struct.unpack("16sh", res)[0].strip("\x00")
129
  return (ifname, tapfd)
130

    
131

    
132
class QmpMessage:
133
  """QEMU Messaging Protocol (QMP) message.
134

135
  """
136

    
137
  def __init__(self, data):
138
    """Creates a new QMP message based on the passed data.
139

140
    """
141
    if not isinstance(data, dict):
142
      raise TypeError("QmpMessage must be initialized with a dict")
143

    
144
    self.data = data
145

    
146
  def __getitem__(self, field_name):
147
    """Get the value of the required field if present, or None.
148

149
    Overrides the [] operator to provide access to the message data,
150
    returning None if the required item is not in the message
151
    @return: the value of the field_name field, or None if field_name
152
             is not contained in the message
153

154
    """
155

    
156
    if field_name in self.data:
157
      return self.data[field_name]
158

    
159
    return None
160

    
161
  def __setitem__(self, field_name, field_value):
162
    """Set the value of the required field_name to field_value.
163

164
    """
165
    self.data[field_name] = field_value
166

    
167
  @staticmethod
168
  def BuildFromJsonString(json_string):
169
    """Build a QmpMessage from a JSON encoded string.
170

171
    @type json_string: str
172
    @param json_string: JSON string representing the message
173
    @rtype: L{QmpMessage}
174
    @return: a L{QmpMessage} built from json_string
175

176
    """
177
    # Parse the string
178
    data = serializer.LoadJson(json_string)
179
    return QmpMessage(data)
180

    
181
  def __str__(self):
182
    # The protocol expects the JSON object to be sent as a single
183
    # line, hence the need for indent=False.
184
    return serializer.DumpJson(self.data, indent=False)
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
  _ERROR_CLASS_KEY = "class"
200
  _ERROR_DATA_KEY = "data"
201
  _ERROR_DESC_KEY = "desc"
202
  _EXECUTE_KEY = "execute"
203
  _ARGUMENTS_KEY = "arguments"
204
  _CAPABILITIES_COMMAND = "qmp_capabilities"
205
  _MESSAGE_END_TOKEN = "\r\n"
206
  _SOCKET_TIMEOUT = 5
207

    
208
  def __init__(self, monitor_filename):
209
    """Instantiates the QmpConnection object.
210

211
    @type monitor_filename: string
212
    @param monitor_filename: the filename of the UNIX raw socket on which the
213
                             QMP monitor is listening
214

215
    """
216
    self.monitor_filename = monitor_filename
217
    self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
218
    # We want to fail if the server doesn't send a complete message
219
    # in a reasonable amount of time
220
    self.sock.settimeout(self._SOCKET_TIMEOUT)
221
    self._connected = False
222
    self._buf = ""
223

    
224
  def _check_connection(self):
225
    """Make sure that the connection is established.
226

227
    """
228
    if not self._connected:
229
      raise errors.ProgrammerError("To use a QmpConnection you need to first"
230
                                   " invoke connect() on it")
231

    
232
  def connect(self):
233
    """Connects to the QMP monitor.
234

235
    Connects to the UNIX socket and makes sure that we can actually send and
236
    receive data to the kvm instance via QMP.
237

238
    @raise errors.HypervisorError: when there are communication errors
239
    @raise errors.ProgrammerError: when there are data serialization errors
240

241
    """
242
    self.sock.connect(self.monitor_filename)
243
    self._connected = True
244

    
245
    # Check if we receive a correct greeting message from the server
246
    # (As per the QEMU Protocol Specification 0.1 - section 2.2)
247
    greeting = self._Recv()
248
    if not greeting[self._FIRST_MESSAGE_KEY]:
249
      self._connected = False
250
      raise errors.HypervisorError("kvm: qmp communication error (wrong"
251
                                   " server greeting")
252

    
253
    # Let's put the monitor in command mode using the qmp_capabilities
254
    # command, or else no command will be executable.
255
    # (As per the QEMU Protocol Specification 0.1 - section 4)
256
    self.Execute(self._CAPABILITIES_COMMAND)
257

    
258
  def _ParseMessage(self, buf):
259
    """Extract and parse a QMP message from the given buffer.
260

261
    Seeks for a QMP message in the given buf. If found, it parses it and
262
    returns it together with the rest of the characters in the buf.
263
    If no message is found, returns None and the whole buffer.
264

265
    @raise errors.ProgrammerError: when there are data serialization errors
266

267
    """
268
    message = None
269
    # Check if we got the message end token (CRLF, as per the QEMU Protocol
270
    # Specification 0.1 - Section 2.1.1)
271
    pos = buf.find(self._MESSAGE_END_TOKEN)
272
    if pos >= 0:
273
      try:
274
        message = QmpMessage.BuildFromJsonString(buf[:pos + 1])
275
      except Exception, err:
276
        raise errors.ProgrammerError("QMP data serialization error: %s" % err)
277
      buf = buf[pos + 1:]
278

    
279
    return (message, buf)
280

    
281
  def _Recv(self):
282
    """Receives a message from QMP and decodes the received JSON object.
283

284
    @rtype: QmpMessage
285
    @return: the received message
286
    @raise errors.HypervisorError: when there are communication errors
287
    @raise errors.ProgrammerError: when there are data serialization errors
288

289
    """
290
    self._check_connection()
291

    
292
    # Check if there is already a message in the buffer
293
    (message, self._buf) = self._ParseMessage(self._buf)
294
    if message:
295
      return message
296

    
297
    recv_buffer = StringIO.StringIO(self._buf)
298
    recv_buffer.seek(len(self._buf))
299
    try:
300
      while True:
301
        data = self.sock.recv(4096)
302
        if not data:
303
          break
304
        recv_buffer.write(data)
305

    
306
        (message, self._buf) = self._ParseMessage(recv_buffer.getvalue())
307
        if message:
308
          return message
309

    
310
    except socket.timeout, err:
311
      raise errors.HypervisorError("Timeout while receiving a QMP message: "
312
                                   "%s" % (err))
313
    except socket.error, err:
314
      raise errors.HypervisorError("Unable to receive data from KVM using the"
315
                                   " QMP protocol: %s" % err)
316

    
317
  def _Send(self, message):
318
    """Encodes and sends a message to KVM using QMP.
319

320
    @type message: QmpMessage
321
    @param message: message to send to KVM
322
    @raise errors.HypervisorError: when there are communication errors
323
    @raise errors.ProgrammerError: when there are data serialization errors
324

325
    """
326
    self._check_connection()
327
    try:
328
      message_str = str(message)
329
    except Exception, err:
330
      raise errors.ProgrammerError("QMP data deserialization error: %s" % err)
331

    
332
    try:
333
      self.sock.sendall(message_str)
334
    except socket.timeout, err:
335
      raise errors.HypervisorError("Timeout while sending a QMP message: "
336
                                   "%s (%s)" % (err.string, err.errno))
337
    except socket.error, err:
338
      raise errors.HypervisorError("Unable to send data from KVM using the"
339
                                   " QMP protocol: %s" % err)
340

    
341
  def Execute(self, command, arguments=None):
342
    """Executes a QMP command and returns the response of the server.
343

344
    @type command: str
345
    @param command: the command to execute
346
    @type arguments: dict
347
    @param arguments: dictionary of arguments to be passed to the command
348
    @rtype: dict
349
    @return: dictionary representing the received JSON object
350
    @raise errors.HypervisorError: when there are communication errors
351
    @raise errors.ProgrammerError: when there are data serialization errors
352

353
    """
354
    self._check_connection()
355
    message = QmpMessage({self._EXECUTE_KEY: command})
356
    if arguments:
357
      message[self._ARGUMENTS_KEY] = arguments
358
    self._Send(message)
359

    
360
    # Events can occur between the sending of the command and the reception
361
    # of the response, so we need to filter out messages with the event key.
362
    while True:
363
      response = self._Recv()
364
      err = response[self._ERROR_KEY]
365
      if err:
366
        raise errors.HypervisorError("kvm: error executing the %s"
367
                                     " command: %s (%s, %s):" %
368
                                     (command,
369
                                      err[self._ERROR_DESC_KEY],
370
                                      err[self._ERROR_CLASS_KEY],
371
                                      err[self._ERROR_DATA_KEY]))
372

    
373
      elif not response[self._EVENT_KEY]:
374
        return response
375

    
376

    
377
class KVMHypervisor(hv_base.BaseHypervisor):
378
  """KVM hypervisor interface"""
379
  CAN_MIGRATE = True
380

    
381
  _ROOT_DIR = constants.RUN_GANETI_DIR + "/kvm-hypervisor"
382
  _PIDS_DIR = _ROOT_DIR + "/pid" # contains live instances pids
383
  _UIDS_DIR = _ROOT_DIR + "/uid" # contains instances reserved uids
384
  _CTRL_DIR = _ROOT_DIR + "/ctrl" # contains instances control sockets
385
  _CONF_DIR = _ROOT_DIR + "/conf" # contains instances startup data
386
  _NICS_DIR = _ROOT_DIR + "/nic" # contains instances nic <-> tap associations
387
  _KEYMAP_DIR = _ROOT_DIR + "/keymap" # contains instances keymaps
388
  # KVM instances with chroot enabled are started in empty chroot directories.
389
  _CHROOT_DIR = _ROOT_DIR + "/chroot" # for empty chroot directories
390
  # After an instance is stopped, its chroot directory is removed.
391
  # If the chroot directory is not empty, it can't be removed.
392
  # A non-empty chroot directory indicates a possible security incident.
393
  # To support forensics, the non-empty chroot directory is quarantined in
394
  # a separate directory, called 'chroot-quarantine'.
395
  _CHROOT_QUARANTINE_DIR = _ROOT_DIR + "/chroot-quarantine"
396
  _DIRS = [_ROOT_DIR, _PIDS_DIR, _UIDS_DIR, _CTRL_DIR, _CONF_DIR, _NICS_DIR,
397
           _CHROOT_DIR, _CHROOT_QUARANTINE_DIR]
398

    
399
  PARAMETERS = {
400
    constants.HV_KERNEL_PATH: hv_base.OPT_FILE_CHECK,
401
    constants.HV_INITRD_PATH: hv_base.OPT_FILE_CHECK,
402
    constants.HV_ROOT_PATH: hv_base.NO_CHECK,
403
    constants.HV_KERNEL_ARGS: hv_base.NO_CHECK,
404
    constants.HV_ACPI: hv_base.NO_CHECK,
405
    constants.HV_SERIAL_CONSOLE: hv_base.NO_CHECK,
406
    constants.HV_VNC_BIND_ADDRESS:
407
      (False, lambda x: (netutils.IP4Address.IsValid(x) or
408
                         utils.IsNormAbsPath(x)),
409
       "the VNC bind address must be either a valid IP address or an absolute"
410
       " pathname", None, None),
411
    constants.HV_VNC_TLS: hv_base.NO_CHECK,
412
    constants.HV_VNC_X509: hv_base.OPT_DIR_CHECK,
413
    constants.HV_VNC_X509_VERIFY: hv_base.NO_CHECK,
414
    constants.HV_VNC_PASSWORD_FILE: hv_base.OPT_FILE_CHECK,
415
    constants.HV_KVM_SPICE_BIND: hv_base.NO_CHECK, # will be checked later
416
    constants.HV_KVM_SPICE_IP_VERSION:
417
      (False, lambda x: (x == constants.IFACE_NO_IP_VERSION_SPECIFIED or
418
                         x in constants.VALID_IP_VERSIONS),
419
       "the SPICE IP version should be 4 or 6",
420
       None, None),
421
    constants.HV_KVM_SPICE_PASSWORD_FILE: hv_base.OPT_FILE_CHECK,
422
    constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR:
423
      hv_base.ParamInSet(False,
424
        constants.HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS),
425
    constants.HV_KVM_SPICE_JPEG_IMG_COMPR:
426
      hv_base.ParamInSet(False,
427
        constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
428
    constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR:
429
      hv_base.ParamInSet(False,
430
        constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
431
    constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION:
432
      hv_base.ParamInSet(False,
433
        constants.HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS),
434
    constants.HV_KVM_SPICE_AUDIO_COMPR: hv_base.NO_CHECK,
435
    constants.HV_KVM_FLOPPY_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
436
    constants.HV_CDROM_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
437
    constants.HV_KVM_CDROM2_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
438
    constants.HV_BOOT_ORDER:
439
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_BO_TYPES),
440
    constants.HV_NIC_TYPE:
441
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_NIC_TYPES),
442
    constants.HV_DISK_TYPE:
443
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_DISK_TYPES),
444
    constants.HV_KVM_CDROM_DISK_TYPE:
445
      hv_base.ParamInSet(False, constants.HT_KVM_VALID_DISK_TYPES),
446
    constants.HV_USB_MOUSE:
447
      hv_base.ParamInSet(False, constants.HT_KVM_VALID_MOUSE_TYPES),
448
    constants.HV_KEYMAP: hv_base.NO_CHECK,
449
    constants.HV_MIGRATION_PORT: hv_base.REQ_NET_PORT_CHECK,
450
    constants.HV_MIGRATION_BANDWIDTH: hv_base.NO_CHECK,
451
    constants.HV_MIGRATION_DOWNTIME: hv_base.NO_CHECK,
452
    constants.HV_MIGRATION_MODE: hv_base.MIGRATION_MODE_CHECK,
453
    constants.HV_USE_LOCALTIME: hv_base.NO_CHECK,
454
    constants.HV_DISK_CACHE:
455
      hv_base.ParamInSet(True, constants.HT_VALID_CACHE_TYPES),
456
    constants.HV_SECURITY_MODEL:
457
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_SM_TYPES),
458
    constants.HV_SECURITY_DOMAIN: hv_base.NO_CHECK,
459
    constants.HV_KVM_FLAG:
460
      hv_base.ParamInSet(False, constants.HT_KVM_FLAG_VALUES),
461
    constants.HV_VHOST_NET: hv_base.NO_CHECK,
462
    constants.HV_KVM_USE_CHROOT: hv_base.NO_CHECK,
463
    constants.HV_MEM_PATH: hv_base.OPT_DIR_CHECK,
464
    constants.HV_REBOOT_BEHAVIOR:
465
      hv_base.ParamInSet(True, constants.REBOOT_BEHAVIORS)
466
    }
467

    
468
  _MIGRATION_STATUS_RE = re.compile("Migration\s+status:\s+(\w+)",
469
                                    re.M | re.I)
470
  _MIGRATION_INFO_MAX_BAD_ANSWERS = 5
471
  _MIGRATION_INFO_RETRY_DELAY = 2
472

    
473
  _VERSION_RE = re.compile(r"\b(\d+)\.(\d+)\.(\d+)\b")
474

    
475
  ANCILLARY_FILES = [
476
    _KVM_NETWORK_SCRIPT,
477
    ]
478
  ANCILLARY_FILES_OPT = [
479
    _KVM_NETWORK_SCRIPT,
480
    ]
481

    
482
  def __init__(self):
483
    hv_base.BaseHypervisor.__init__(self)
484
    # Let's make sure the directories we need exist, even if the RUN_DIR lives
485
    # in a tmpfs filesystem or has been otherwise wiped out.
486
    dirs = [(dname, constants.RUN_DIRS_MODE) for dname in self._DIRS]
487
    utils.EnsureDirs(dirs)
488

    
489
  @classmethod
490
  def _InstancePidFile(cls, instance_name):
491
    """Returns the instance pidfile.
492

493
    """
494
    return utils.PathJoin(cls._PIDS_DIR, instance_name)
495

    
496
  @classmethod
497
  def _InstanceUidFile(cls, instance_name):
498
    """Returns the instance uidfile.
499

500
    """
501
    return utils.PathJoin(cls._UIDS_DIR, instance_name)
502

    
503
  @classmethod
504
  def _InstancePidInfo(cls, pid):
505
    """Check pid file for instance information.
506

507
    Check that a pid file is associated with an instance, and retrieve
508
    information from its command line.
509

510
    @type pid: string or int
511
    @param pid: process id of the instance to check
512
    @rtype: tuple
513
    @return: (instance_name, memory, vcpus)
514
    @raise errors.HypervisorError: when an instance cannot be found
515

516
    """
517
    alive = utils.IsProcessAlive(pid)
518
    if not alive:
519
      raise errors.HypervisorError("Cannot get info for pid %s" % pid)
520

    
521
    cmdline_file = utils.PathJoin("/proc", str(pid), "cmdline")
522
    try:
523
      cmdline = utils.ReadFile(cmdline_file)
524
    except EnvironmentError, err:
525
      raise errors.HypervisorError("Can't open cmdline file for pid %s: %s" %
526
                                   (pid, err))
527

    
528
    instance = None
529
    memory = 0
530
    vcpus = 0
531

    
532
    arg_list = cmdline.split("\x00")
533
    while arg_list:
534
      arg = arg_list.pop(0)
535
      if arg == "-name":
536
        instance = arg_list.pop(0)
537
      elif arg == "-m":
538
        memory = int(arg_list.pop(0))
539
      elif arg == "-smp":
540
        vcpus = int(arg_list.pop(0))
541

    
542
    if instance is None:
543
      raise errors.HypervisorError("Pid %s doesn't contain a ganeti kvm"
544
                                   " instance" % pid)
545

    
546
    return (instance, memory, vcpus)
547

    
548
  def _InstancePidAlive(self, instance_name):
549
    """Returns the instance pidfile, pid, and liveness.
550

551
    @type instance_name: string
552
    @param instance_name: instance name
553
    @rtype: tuple
554
    @return: (pid file name, pid, liveness)
555

556
    """
557
    pidfile = self._InstancePidFile(instance_name)
558
    pid = utils.ReadPidFile(pidfile)
559

    
560
    alive = False
561
    try:
562
      cmd_instance = self._InstancePidInfo(pid)[0]
563
      alive = (cmd_instance == instance_name)
564
    except errors.HypervisorError:
565
      pass
566

    
567
    return (pidfile, pid, alive)
568

    
569
  def _CheckDown(self, instance_name):
570
    """Raises an error unless the given instance is down.
571

572
    """
573
    alive = self._InstancePidAlive(instance_name)[2]
574
    if alive:
575
      raise errors.HypervisorError("Failed to start instance %s: %s" %
576
                                   (instance_name, "already running"))
577

    
578
  @classmethod
579
  def _InstanceMonitor(cls, instance_name):
580
    """Returns the instance monitor socket name
581

582
    """
583
    return utils.PathJoin(cls._CTRL_DIR, "%s.monitor" % instance_name)
584

    
585
  @classmethod
586
  def _InstanceSerial(cls, instance_name):
587
    """Returns the instance serial socket name
588

589
    """
590
    return utils.PathJoin(cls._CTRL_DIR, "%s.serial" % instance_name)
591

    
592
  @classmethod
593
  def _InstanceQmpMonitor(cls, instance_name):
594
    """Returns the instance serial QMP socket name
595

596
    """
597
    return utils.PathJoin(cls._CTRL_DIR, "%s.qmp" % instance_name)
598

    
599
  @staticmethod
600
  def _SocatUnixConsoleParams():
601
    """Returns the correct parameters for socat
602

603
    If we have a new-enough socat we can use raw mode with an escape character.
604

605
    """
606
    if constants.SOCAT_USE_ESCAPE:
607
      return "raw,echo=0,escape=%s" % constants.SOCAT_ESCAPE_CODE
608
    else:
609
      return "echo=0,icanon=0"
610

    
611
  @classmethod
612
  def _InstanceKVMRuntime(cls, instance_name):
613
    """Returns the instance KVM runtime filename
614

615
    """
616
    return utils.PathJoin(cls._CONF_DIR, "%s.runtime" % instance_name)
617

    
618
  @classmethod
619
  def _InstanceChrootDir(cls, instance_name):
620
    """Returns the name of the KVM chroot dir of the instance
621

622
    """
623
    return utils.PathJoin(cls._CHROOT_DIR, instance_name)
624

    
625
  @classmethod
626
  def _InstanceNICDir(cls, instance_name):
627
    """Returns the name of the directory holding the tap device files for a
628
    given instance.
629

630
    """
631
    return utils.PathJoin(cls._NICS_DIR, instance_name)
632

    
633
  @classmethod
634
  def _InstanceNICFile(cls, instance_name, seq):
635
    """Returns the name of the file containing the tap device for a given NIC
636

637
    """
638
    return utils.PathJoin(cls._InstanceNICDir(instance_name), str(seq))
639

    
640
  @classmethod
641
  def _InstanceKeymapFile(cls, instance_name):
642
    """Returns the name of the file containing the keymap for a given instance
643

644
    """
645
    return utils.PathJoin(cls._KEYMAP_DIR, instance_name)
646

    
647
  @classmethod
648
  def _TryReadUidFile(cls, uid_file):
649
    """Try to read a uid file
650

651
    """
652
    if os.path.exists(uid_file):
653
      try:
654
        uid = int(utils.ReadOneLineFile(uid_file))
655
        return uid
656
      except EnvironmentError:
657
        logging.warning("Can't read uid file", exc_info=True)
658
      except (TypeError, ValueError):
659
        logging.warning("Can't parse uid file contents", exc_info=True)
660
    return None
661

    
662
  @classmethod
663
  def _RemoveInstanceRuntimeFiles(cls, pidfile, instance_name):
664
    """Removes an instance's rutime sockets/files/dirs.
665

666
    """
667
    utils.RemoveFile(pidfile)
668
    utils.RemoveFile(cls._InstanceMonitor(instance_name))
669
    utils.RemoveFile(cls._InstanceSerial(instance_name))
670
    utils.RemoveFile(cls._InstanceQmpMonitor(instance_name))
671
    utils.RemoveFile(cls._InstanceKVMRuntime(instance_name))
672
    utils.RemoveFile(cls._InstanceKeymapFile(instance_name))
673
    uid_file = cls._InstanceUidFile(instance_name)
674
    uid = cls._TryReadUidFile(uid_file)
675
    utils.RemoveFile(uid_file)
676
    if uid is not None:
677
      uidpool.ReleaseUid(uid)
678
    try:
679
      shutil.rmtree(cls._InstanceNICDir(instance_name))
680
    except OSError, err:
681
      if err.errno != errno.ENOENT:
682
        raise
683
    try:
684
      chroot_dir = cls._InstanceChrootDir(instance_name)
685
      utils.RemoveDir(chroot_dir)
686
    except OSError, err:
687
      if err.errno == errno.ENOTEMPTY:
688
        # The chroot directory is expected to be empty, but it isn't.
689
        new_chroot_dir = tempfile.mkdtemp(dir=cls._CHROOT_QUARANTINE_DIR,
690
                                          prefix="%s-%s-" %
691
                                          (instance_name,
692
                                           utils.TimestampForFilename()))
693
        logging.warning("The chroot directory of instance %s can not be"
694
                        " removed as it is not empty. Moving it to the"
695
                        " quarantine instead. Please investigate the"
696
                        " contents (%s) and clean up manually",
697
                        instance_name, new_chroot_dir)
698
        utils.RenameFile(chroot_dir, new_chroot_dir)
699
      else:
700
        raise
701

    
702
  @staticmethod
703
  def _ConfigureNIC(instance, seq, nic, tap):
704
    """Run the network configuration script for a specified NIC
705

706
    @param instance: instance we're acting on
707
    @type instance: instance object
708
    @param seq: nic sequence number
709
    @type seq: int
710
    @param nic: nic we're acting on
711
    @type nic: nic object
712
    @param tap: the host's tap interface this NIC corresponds to
713
    @type tap: str
714

715
    """
716

    
717
    if instance.tags:
718
      tags = " ".join(instance.tags)
719
    else:
720
      tags = ""
721

    
722
    env = {
723
      "PATH": "%s:/sbin:/usr/sbin" % os.environ["PATH"],
724
      "INSTANCE": instance.name,
725
      "MAC": nic.mac,
726
      "MODE": nic.nicparams[constants.NIC_MODE],
727
      "INTERFACE": tap,
728
      "INTERFACE_INDEX": str(seq),
729
      "TAGS": tags,
730
    }
731

    
732
    if nic.ip:
733
      env["IP"] = nic.ip
734

    
735
    if nic.nicparams[constants.NIC_LINK]:
736
      env["LINK"] = nic.nicparams[constants.NIC_LINK]
737

    
738
    if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
739
      env["BRIDGE"] = nic.nicparams[constants.NIC_LINK]
740

    
741
    result = utils.RunCmd([constants.KVM_IFUP, tap], env=env)
742
    if result.failed:
743
      raise errors.HypervisorError("Failed to configure interface %s: %s."
744
                                   " Network configuration script output: %s" %
745
                                   (tap, result.fail_reason, result.output))
746

    
747
  def ListInstances(self):
748
    """Get the list of running instances.
749

750
    We can do this by listing our live instances directory and
751
    checking whether the associated kvm process is still alive.
752

753
    """
754
    result = []
755
    for name in os.listdir(self._PIDS_DIR):
756
      if self._InstancePidAlive(name)[2]:
757
        result.append(name)
758
    return result
759

    
760
  def GetInstanceInfo(self, instance_name):
761
    """Get instance properties.
762

763
    @type instance_name: string
764
    @param instance_name: the instance name
765
    @rtype: tuple of strings
766
    @return: (name, id, memory, vcpus, stat, times)
767

768
    """
769
    _, pid, alive = self._InstancePidAlive(instance_name)
770
    if not alive:
771
      return None
772

    
773
    _, memory, vcpus = self._InstancePidInfo(pid)
774
    stat = "---b-"
775
    times = "0"
776

    
777
    return (instance_name, pid, memory, vcpus, stat, times)
778

    
779
  def GetAllInstancesInfo(self):
780
    """Get properties of all instances.
781

782
    @return: list of tuples (name, id, memory, vcpus, stat, times)
783

784
    """
785
    data = []
786
    for name in os.listdir(self._PIDS_DIR):
787
      try:
788
        info = self.GetInstanceInfo(name)
789
      except errors.HypervisorError:
790
        continue
791
      if info:
792
        data.append(info)
793
    return data
794

    
795
  def _GenerateKVMRuntime(self, instance, block_devices, startup_paused):
796
    """Generate KVM information to start an instance.
797

798
    """
799
    # pylint: disable=R0914
800
    _, v_major, v_min, _ = self._GetKVMVersion()
801

    
802
    pidfile = self._InstancePidFile(instance.name)
803
    kvm = constants.KVM_PATH
804
    kvm_cmd = [kvm]
805
    # used just by the vnc server, if enabled
806
    kvm_cmd.extend(["-name", instance.name])
807
    kvm_cmd.extend(["-m", instance.beparams[constants.BE_MEMORY]])
808
    kvm_cmd.extend(["-smp", instance.beparams[constants.BE_VCPUS]])
809
    kvm_cmd.extend(["-pidfile", pidfile])
810
    kvm_cmd.extend(["-daemonize"])
811
    if not instance.hvparams[constants.HV_ACPI]:
812
      kvm_cmd.extend(["-no-acpi"])
813
    if startup_paused:
814
      kvm_cmd.extend(["-S"])
815
    if instance.hvparams[constants.HV_REBOOT_BEHAVIOR] == \
816
        constants.INSTANCE_REBOOT_EXIT:
817
      kvm_cmd.extend(["-no-reboot"])
818

    
819
    hvp = instance.hvparams
820
    boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
821
    boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
822
    boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
823
    boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
824

    
825
    self.ValidateParameters(hvp)
826

    
827
    if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
828
      kvm_cmd.extend(["-enable-kvm"])
829
    elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
830
      kvm_cmd.extend(["-disable-kvm"])
831

    
832
    if boot_network:
833
      kvm_cmd.extend(["-boot", "n"])
834

    
835
    disk_type = hvp[constants.HV_DISK_TYPE]
836
    if disk_type == constants.HT_DISK_PARAVIRTUAL:
837
      if_val = ",if=virtio"
838
    else:
839
      if_val = ",if=%s" % disk_type
840
    # Cache mode
841
    disk_cache = hvp[constants.HV_DISK_CACHE]
842
    if instance.disk_template in constants.DTS_EXT_MIRROR:
843
      if disk_cache != "none":
844
        # TODO: make this a hard error, instead of a silent overwrite
845
        logging.warning("KVM: overriding disk_cache setting '%s' with 'none'"
846
                        " to prevent shared storage corruption on migration",
847
                        disk_cache)
848
      cache_val = ",cache=none"
849
    elif disk_cache != constants.HT_CACHE_DEFAULT:
850
      cache_val = ",cache=%s" % disk_cache
851
    else:
852
      cache_val = ""
853
    for cfdev, dev_path in block_devices:
854
      if cfdev.mode != constants.DISK_RDWR:
855
        raise errors.HypervisorError("Instance has read-only disks which"
856
                                     " are not supported by KVM")
857
      # TODO: handle FD_LOOP and FD_BLKTAP (?)
858
      boot_val = ""
859
      if boot_disk:
860
        kvm_cmd.extend(["-boot", "c"])
861
        boot_disk = False
862
        if (v_major, v_min) < (0, 14) and disk_type != constants.HT_DISK_IDE:
863
          boot_val = ",boot=on"
864

    
865
      drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
866
                                                cache_val)
867
      kvm_cmd.extend(["-drive", drive_val])
868

    
869
    #Now we can specify a different device type for CDROM devices.
870
    cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
871
    if not cdrom_disk_type:
872
      cdrom_disk_type = disk_type
873

    
874
    iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
875
    if iso_image:
876
      options = ",format=raw,media=cdrom"
877
      if boot_cdrom:
878
        kvm_cmd.extend(["-boot", "d"])
879
        if cdrom_disk_type != constants.HT_DISK_IDE:
880
          options = "%s,boot=on,if=%s" % (options, constants.HT_DISK_IDE)
881
        else:
882
          options = "%s,boot=on" % options
883
      else:
884
        if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
885
          if_val = ",if=virtio"
886
        else:
887
          if_val = ",if=%s" % cdrom_disk_type
888
        options = "%s%s" % (options, if_val)
889
      drive_val = "file=%s%s" % (iso_image, options)
890
      kvm_cmd.extend(["-drive", drive_val])
891

    
892
    iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
893
    if iso_image2:
894
      options = ",format=raw,media=cdrom"
895
      if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
896
        if_val = ",if=virtio"
897
      else:
898
        if_val = ",if=%s" % cdrom_disk_type
899
      options = "%s%s" % (options, if_val)
900
      drive_val = "file=%s%s" % (iso_image2, options)
901
      kvm_cmd.extend(["-drive", drive_val])
902

    
903
    floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
904
    if floppy_image:
905
      options = ",format=raw,media=disk"
906
      if boot_floppy:
907
        kvm_cmd.extend(["-boot", "a"])
908
        options = "%s,boot=on" % options
909
      if_val = ",if=floppy"
910
      options = "%s%s" % (options, if_val)
911
      drive_val = "file=%s%s" % (floppy_image, options)
912
      kvm_cmd.extend(["-drive", drive_val])
913

    
914
    kernel_path = hvp[constants.HV_KERNEL_PATH]
915
    if kernel_path:
916
      kvm_cmd.extend(["-kernel", kernel_path])
917
      initrd_path = hvp[constants.HV_INITRD_PATH]
918
      if initrd_path:
919
        kvm_cmd.extend(["-initrd", initrd_path])
920
      root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
921
                     hvp[constants.HV_KERNEL_ARGS]]
922
      if hvp[constants.HV_SERIAL_CONSOLE]:
923
        root_append.append("console=ttyS0,38400")
924
      kvm_cmd.extend(["-append", " ".join(root_append)])
925

    
926
    mem_path = hvp[constants.HV_MEM_PATH]
927
    if mem_path:
928
      kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
929

    
930
    mouse_type = hvp[constants.HV_USB_MOUSE]
931
    vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
932

    
933
    if mouse_type:
934
      kvm_cmd.extend(["-usb"])
935
      kvm_cmd.extend(["-usbdevice", mouse_type])
936
    elif vnc_bind_address:
937
      kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
938

    
939
    keymap = hvp[constants.HV_KEYMAP]
940
    if keymap:
941
      keymap_path = self._InstanceKeymapFile(instance.name)
942
      # If a keymap file is specified, KVM won't use its internal defaults. By
943
      # first including the "en-us" layout, an error on loading the actual
944
      # layout (e.g. because it can't be found) won't lead to a non-functional
945
      # keyboard. A keyboard with incorrect keys is still better than none.
946
      utils.WriteFile(keymap_path, data="include en-us\ninclude %s\n" % keymap)
947
      kvm_cmd.extend(["-k", keymap_path])
948

    
949
    if vnc_bind_address:
950
      if netutils.IP4Address.IsValid(vnc_bind_address):
951
        if instance.network_port > constants.VNC_BASE_PORT:
952
          display = instance.network_port - constants.VNC_BASE_PORT
953
          if vnc_bind_address == constants.IP4_ADDRESS_ANY:
954
            vnc_arg = ":%d" % (display)
955
          else:
956
            vnc_arg = "%s:%d" % (vnc_bind_address, display)
957
        else:
958
          logging.error("Network port is not a valid VNC display (%d < %d)."
959
                        " Not starting VNC", instance.network_port,
960
                        constants.VNC_BASE_PORT)
961
          vnc_arg = "none"
962

    
963
        # Only allow tls and other option when not binding to a file, for now.
964
        # kvm/qemu gets confused otherwise about the filename to use.
965
        vnc_append = ""
966
        if hvp[constants.HV_VNC_TLS]:
967
          vnc_append = "%s,tls" % vnc_append
968
          if hvp[constants.HV_VNC_X509_VERIFY]:
969
            vnc_append = "%s,x509verify=%s" % (vnc_append,
970
                                               hvp[constants.HV_VNC_X509])
971
          elif hvp[constants.HV_VNC_X509]:
972
            vnc_append = "%s,x509=%s" % (vnc_append,
973
                                         hvp[constants.HV_VNC_X509])
974
        if hvp[constants.HV_VNC_PASSWORD_FILE]:
975
          vnc_append = "%s,password" % vnc_append
976

    
977
        vnc_arg = "%s%s" % (vnc_arg, vnc_append)
978

    
979
      else:
980
        vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
981

    
982
      kvm_cmd.extend(["-vnc", vnc_arg])
983
    else:
984
      kvm_cmd.extend(["-nographic"])
985

    
986
    monitor_dev = ("unix:%s,server,nowait" %
987
                   self._InstanceMonitor(instance.name))
988
    kvm_cmd.extend(["-monitor", monitor_dev])
989
    if hvp[constants.HV_SERIAL_CONSOLE]:
990
      serial_dev = ("unix:%s,server,nowait" %
991
                    self._InstanceSerial(instance.name))
992
      kvm_cmd.extend(["-serial", serial_dev])
993
    else:
994
      kvm_cmd.extend(["-serial", "none"])
995

    
996
    spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
997
    spice_ip_version = None
998
    if spice_bind:
999
      if netutils.IsValidInterface(spice_bind):
1000
        # The user specified a network interface, we have to figure out the IP
1001
        # address.
1002
        addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1003
        spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1004

    
1005
        # if the user specified an IP version and the interface does not
1006
        # have that kind of IP addresses, throw an exception
1007
        if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1008
          if not addresses[spice_ip_version]:
1009
            raise errors.HypervisorError("spice: unable to get an IPv%s address"
1010
                                         " for %s" % (spice_ip_version,
1011
                                                      spice_bind))
1012

    
1013
        # the user did not specify an IP version, we have to figure it out
1014
        elif (addresses[constants.IP4_VERSION] and
1015
              addresses[constants.IP6_VERSION]):
1016
          # we have both ipv4 and ipv6, let's use the cluster default IP
1017
          # version
1018
          cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1019
          spice_ip_version = netutils.IPAddress.GetVersionFromAddressFamily(
1020
              cluster_family)
1021
        elif addresses[constants.IP4_VERSION]:
1022
          spice_ip_version = constants.IP4_VERSION
1023
        elif addresses[constants.IP6_VERSION]:
1024
          spice_ip_version = constants.IP6_VERSION
1025
        else:
1026
          raise errors.HypervisorError("spice: unable to get an IP address"
1027
                                       " for %s" % (spice_bind))
1028

    
1029
        spice_address = addresses[spice_ip_version][0]
1030

    
1031
      else:
1032
        # spice_bind is known to be a valid IP address, because
1033
        # ValidateParameters checked it.
1034
        spice_address = spice_bind
1035

    
1036
      spice_arg = "addr=%s,port=%s" % (spice_address, instance.network_port)
1037
      if not hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]:
1038
        spice_arg = "%s,disable-ticketing" % spice_arg
1039

    
1040
      if spice_ip_version:
1041
        spice_arg = "%s,ipv%s" % (spice_arg, spice_ip_version)
1042

    
1043
      # Image compression options
1044
      img_lossless = hvp[constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR]
1045
      img_jpeg = hvp[constants.HV_KVM_SPICE_JPEG_IMG_COMPR]
1046
      img_zlib_glz = hvp[constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR]
1047
      if img_lossless:
1048
        spice_arg = "%s,image-compression=%s" % (spice_arg, img_lossless)
1049
      if img_jpeg:
1050
        spice_arg = "%s,jpeg-wan-compression=%s" % (spice_arg, img_jpeg)
1051
      if img_zlib_glz:
1052
        spice_arg = "%s,zlib-glz-wan-compression=%s" % (spice_arg, img_zlib_glz)
1053

    
1054
      # Video stream detection
1055
      video_streaming = hvp[constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION]
1056
      if video_streaming:
1057
        spice_arg = "%s,streaming-video=%s" % (spice_arg, video_streaming)
1058

    
1059
      # Audio compression, by default in qemu-kvm it is on
1060
      if not hvp[constants.HV_KVM_SPICE_AUDIO_COMPR]:
1061
        spice_arg = "%s,playback-compression=off" % spice_arg
1062

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

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

    
1069
    if hvp[constants.HV_USE_LOCALTIME]:
1070
      kvm_cmd.extend(["-localtime"])
1071

    
1072
    if hvp[constants.HV_KVM_USE_CHROOT]:
1073
      kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1074

    
1075
    # Save the current instance nics, but defer their expansion as parameters,
1076
    # as we'll need to generate executable temp files for them.
1077
    kvm_nics = instance.nics
1078
    hvparams = hvp
1079

    
1080
    return (kvm_cmd, kvm_nics, hvparams)
1081

    
1082
  def _WriteKVMRuntime(self, instance_name, data):
1083
    """Write an instance's KVM runtime
1084

1085
    """
1086
    try:
1087
      utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1088
                      data=data)
1089
    except EnvironmentError, err:
1090
      raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1091

    
1092
  def _ReadKVMRuntime(self, instance_name):
1093
    """Read an instance's KVM runtime
1094

1095
    """
1096
    try:
1097
      file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1098
    except EnvironmentError, err:
1099
      raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1100
    return file_content
1101

    
1102
  def _SaveKVMRuntime(self, instance, kvm_runtime):
1103
    """Save an instance's KVM runtime
1104

1105
    """
1106
    kvm_cmd, kvm_nics, hvparams = kvm_runtime
1107
    serialized_nics = [nic.ToDict() for nic in kvm_nics]
1108
    serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1109
    self._WriteKVMRuntime(instance.name, serialized_form)
1110

    
1111
  def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1112
    """Load an instance's KVM runtime
1113

1114
    """
1115
    if not serialized_runtime:
1116
      serialized_runtime = self._ReadKVMRuntime(instance.name)
1117
    loaded_runtime = serializer.Load(serialized_runtime)
1118
    kvm_cmd, serialized_nics, hvparams = loaded_runtime
1119
    kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1120
    return (kvm_cmd, kvm_nics, hvparams)
1121

    
1122
  def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1123
    """Run the KVM cmd and check for errors
1124

1125
    @type name: string
1126
    @param name: instance name
1127
    @type kvm_cmd: list of strings
1128
    @param kvm_cmd: runcmd input for kvm
1129
    @type tap_fds: list of int
1130
    @param tap_fds: fds of tap devices opened by Ganeti
1131

1132
    """
1133
    try:
1134
      result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1135
    finally:
1136
      for fd in tap_fds:
1137
        utils_wrapper.CloseFdNoError(fd)
1138

    
1139
    if result.failed:
1140
      raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1141
                                   (name, result.fail_reason, result.output))
1142
    if not self._InstancePidAlive(name)[2]:
1143
      raise errors.HypervisorError("Failed to start instance %s" % name)
1144

    
1145
  def _ExecuteKVMRuntime(self, instance, kvm_runtime, incoming=None):
1146
    """Execute a KVM cmd, after completing it with some last minute data
1147

1148
    @type incoming: tuple of strings
1149
    @param incoming: (target_host_ip, port)
1150

1151
    """
1152
    # Small _ExecuteKVMRuntime hv parameters programming howto:
1153
    #  - conf_hvp contains the parameters as configured on ganeti. they might
1154
    #    have changed since the instance started; only use them if the change
1155
    #    won't affect the inside of the instance (which hasn't been rebooted).
1156
    #  - up_hvp contains the parameters as they were when the instance was
1157
    #    started, plus any new parameter which has been added between ganeti
1158
    #    versions: it is paramount that those default to a value which won't
1159
    #    affect the inside of the instance as well.
1160
    conf_hvp = instance.hvparams
1161
    name = instance.name
1162
    self._CheckDown(name)
1163

    
1164
    temp_files = []
1165

    
1166
    kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1167
    up_hvp = objects.FillDict(conf_hvp, up_hvp)
1168

    
1169
    _, v_major, v_min, _ = self._GetKVMVersion()
1170

    
1171
    # We know it's safe to run as a different user upon migration, so we'll use
1172
    # the latest conf, from conf_hvp.
1173
    security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1174
    if security_model == constants.HT_SM_USER:
1175
      kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1176

    
1177
    # We have reasons to believe changing something like the nic driver/type
1178
    # upon migration won't exactly fly with the instance kernel, so for nic
1179
    # related parameters we'll use up_hvp
1180
    tapfds = []
1181
    taps = []
1182
    if not kvm_nics:
1183
      kvm_cmd.extend(["-net", "none"])
1184
    else:
1185
      vnet_hdr = False
1186
      tap_extra = ""
1187
      nic_type = up_hvp[constants.HV_NIC_TYPE]
1188
      if nic_type == constants.HT_NIC_PARAVIRTUAL:
1189
        # From version 0.12.0, kvm uses a new sintax for network configuration.
1190
        if (v_major, v_min) >= (0, 12):
1191
          nic_model = "virtio-net-pci"
1192
          vnet_hdr = True
1193
        else:
1194
          nic_model = "virtio"
1195

    
1196
        if up_hvp[constants.HV_VHOST_NET]:
1197
          # vhost_net is only available from version 0.13.0 or newer
1198
          if (v_major, v_min) >= (0, 13):
1199
            tap_extra = ",vhost=on"
1200
          else:
1201
            raise errors.HypervisorError("vhost_net is configured"
1202
                                        " but it is not available")
1203
      else:
1204
        nic_model = nic_type
1205

    
1206
      for nic_seq, nic in enumerate(kvm_nics):
1207
        tapname, tapfd = _OpenTap(vnet_hdr)
1208
        tapfds.append(tapfd)
1209
        taps.append(tapname)
1210
        if (v_major, v_min) >= (0, 12):
1211
          nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1212
          tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1213
          kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1214
        else:
1215
          nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1216
                                                         nic.mac, nic_model)
1217
          tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1218
          kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1219

    
1220
    if incoming:
1221
      target, port = incoming
1222
      kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1223

    
1224
    # Changing the vnc password doesn't bother the guest that much. At most it
1225
    # will surprise people who connect to it. Whether positively or negatively
1226
    # it's debatable.
1227
    vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1228
    vnc_pwd = None
1229
    if vnc_pwd_file:
1230
      try:
1231
        vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1232
      except EnvironmentError, err:
1233
        raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1234
                                     % (vnc_pwd_file, err))
1235

    
1236
    if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1237
      utils.EnsureDirs([(self._InstanceChrootDir(name),
1238
                         constants.SECURE_DIR_MODE)])
1239

    
1240
    # Automatically enable QMP if version is >= 0.14
1241
    if (v_major, v_min) >= (0, 14):
1242
      logging.debug("Enabling QMP")
1243
      kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1244
                    self._InstanceQmpMonitor(instance.name)])
1245

    
1246
    # Configure the network now for starting instances and bridged interfaces,
1247
    # during FinalizeMigration for incoming instances' routed interfaces
1248
    for nic_seq, nic in enumerate(kvm_nics):
1249
      if (incoming and
1250
          nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1251
        continue
1252
      self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1253

    
1254
    if security_model == constants.HT_SM_POOL:
1255
      ss = ssconf.SimpleStore()
1256
      uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1257
      all_uids = set(uidpool.ExpandUidPool(uid_pool))
1258
      uid = uidpool.RequestUnusedUid(all_uids)
1259
      try:
1260
        username = pwd.getpwuid(uid.GetUid()).pw_name
1261
        kvm_cmd.extend(["-runas", username])
1262
        self._RunKVMCmd(name, kvm_cmd, tapfds)
1263
      except:
1264
        uidpool.ReleaseUid(uid)
1265
        raise
1266
      else:
1267
        uid.Unlock()
1268
        utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1269
    else:
1270
      self._RunKVMCmd(name, kvm_cmd, tapfds)
1271

    
1272
    utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1273
                     constants.RUN_DIRS_MODE)])
1274
    for nic_seq, tap in enumerate(taps):
1275
      utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1276
                      data=tap)
1277

    
1278
    if vnc_pwd:
1279
      change_cmd = "change vnc password %s" % vnc_pwd
1280
      self._CallMonitorCommand(instance.name, change_cmd)
1281

    
1282
    # Setting SPICE password. We are not vulnerable to malicious passwordless
1283
    # connection attempts because SPICE by default does not allow connections
1284
    # if neither a password nor the "disable_ticketing" options are specified.
1285
    # As soon as we send the password via QMP, that password is a valid ticket
1286
    # for connection.
1287
    spice_password_file = conf_hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]
1288
    if spice_password_file:
1289
      try:
1290
        spice_pwd = utils.ReadOneLineFile(spice_password_file, strict=True)
1291
        qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1292
        qmp.connect()
1293
        arguments = {
1294
            "protocol": "spice",
1295
            "password": spice_pwd,
1296
        }
1297
        qmp.Execute("set_password", arguments)
1298
      except EnvironmentError, err:
1299
        raise errors.HypervisorError("Failed to open SPICE password file %s: %s"
1300
                                     % (spice_password_file, err))
1301

    
1302
    for filename in temp_files:
1303
      utils.RemoveFile(filename)
1304

    
1305
  def StartInstance(self, instance, block_devices, startup_paused):
1306
    """Start an instance.
1307

1308
    """
1309
    self._CheckDown(instance.name)
1310
    kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1311
                                           startup_paused)
1312
    self._SaveKVMRuntime(instance, kvm_runtime)
1313
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1314

    
1315
  def _CallMonitorCommand(self, instance_name, command):
1316
    """Invoke a command on the instance monitor.
1317

1318
    """
1319
    socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1320
             (utils.ShellQuote(command),
1321
              constants.SOCAT_PATH,
1322
              utils.ShellQuote(self._InstanceMonitor(instance_name))))
1323
    result = utils.RunCmd(socat)
1324
    if result.failed:
1325
      msg = ("Failed to send command '%s' to instance %s."
1326
             " output: %s, error: %s, fail_reason: %s" %
1327
             (command, instance_name,
1328
              result.stdout, result.stderr, result.fail_reason))
1329
      raise errors.HypervisorError(msg)
1330

    
1331
    return result
1332

    
1333
  @classmethod
1334
  def _GetKVMVersion(cls):
1335
    """Return the installed KVM version.
1336

1337
    @return: (version, v_maj, v_min, v_rev)
1338
    @raise L{errors.HypervisorError}: when the KVM version cannot be retrieved
1339

1340
    """
1341
    result = utils.RunCmd([constants.KVM_PATH, "--help"])
1342
    if result.failed:
1343
      raise errors.HypervisorError("Unable to get KVM version")
1344
    match = cls._VERSION_RE.search(result.output.splitlines()[0])
1345
    if not match:
1346
      raise errors.HypervisorError("Unable to get KVM version")
1347

    
1348
    return (match.group(0), int(match.group(1)), int(match.group(2)),
1349
            int(match.group(3)))
1350

    
1351
  def StopInstance(self, instance, force=False, retry=False, name=None):
1352
    """Stop an instance.
1353

1354
    """
1355
    if name is not None and not force:
1356
      raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1357
    if name is None:
1358
      name = instance.name
1359
      acpi = instance.hvparams[constants.HV_ACPI]
1360
    else:
1361
      acpi = False
1362
    _, pid, alive = self._InstancePidAlive(name)
1363
    if pid > 0 and alive:
1364
      if force or not acpi:
1365
        utils.KillProcess(pid)
1366
      else:
1367
        self._CallMonitorCommand(name, "system_powerdown")
1368

    
1369
  def CleanupInstance(self, instance_name):
1370
    """Cleanup after a stopped instance
1371

1372
    """
1373
    pidfile, pid, alive = self._InstancePidAlive(instance_name)
1374
    if pid > 0 and alive:
1375
      raise errors.HypervisorError("Cannot cleanup a live instance")
1376
    self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1377

    
1378
  def RebootInstance(self, instance):
1379
    """Reboot an instance.
1380

1381
    """
1382
    # For some reason if we do a 'send-key ctrl-alt-delete' to the control
1383
    # socket the instance will stop, but now power up again. So we'll resort
1384
    # to shutdown and restart.
1385
    _, _, alive = self._InstancePidAlive(instance.name)
1386
    if not alive:
1387
      raise errors.HypervisorError("Failed to reboot instance %s:"
1388
                                   " not running" % instance.name)
1389
    # StopInstance will delete the saved KVM runtime so:
1390
    # ...first load it...
1391
    kvm_runtime = self._LoadKVMRuntime(instance)
1392
    # ...now we can safely call StopInstance...
1393
    if not self.StopInstance(instance):
1394
      self.StopInstance(instance, force=True)
1395
    # ...and finally we can save it again, and execute it...
1396
    self._SaveKVMRuntime(instance, kvm_runtime)
1397
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1398

    
1399
  def MigrationInfo(self, instance):
1400
    """Get instance information to perform a migration.
1401

1402
    @type instance: L{objects.Instance}
1403
    @param instance: instance to be migrated
1404
    @rtype: string
1405
    @return: content of the KVM runtime file
1406

1407
    """
1408
    return self._ReadKVMRuntime(instance.name)
1409

    
1410
  def AcceptInstance(self, instance, info, target):
1411
    """Prepare to accept an instance.
1412

1413
    @type instance: L{objects.Instance}
1414
    @param instance: instance to be accepted
1415
    @type info: string
1416
    @param info: content of the KVM runtime file on the source node
1417
    @type target: string
1418
    @param target: target host (usually ip), on this node
1419

1420
    """
1421
    kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1422
    incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1423
    self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1424

    
1425
  def FinalizeMigration(self, instance, info, success):
1426
    """Finalize an instance migration.
1427

1428
    Stop the incoming mode KVM.
1429

1430
    @type instance: L{objects.Instance}
1431
    @param instance: instance whose migration is being finalized
1432

1433
    """
1434
    if success:
1435
      kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1436
      kvm_nics = kvm_runtime[1]
1437

    
1438
      for nic_seq, nic in enumerate(kvm_nics):
1439
        if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1440
          # Bridged interfaces have already been configured
1441
          continue
1442
        try:
1443
          tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1444
        except EnvironmentError, err:
1445
          logging.warning("Failed to find host interface for %s NIC #%d: %s",
1446
                          instance.name, nic_seq, str(err))
1447
          continue
1448
        try:
1449
          self._ConfigureNIC(instance, nic_seq, nic, tap)
1450
        except errors.HypervisorError, err:
1451
          logging.warning(str(err))
1452

    
1453
      self._WriteKVMRuntime(instance.name, info)
1454
    else:
1455
      self.StopInstance(instance, force=True)
1456

    
1457
  def MigrateInstance(self, instance, target, live):
1458
    """Migrate an instance to a target node.
1459

1460
    The migration will not be attempted if the instance is not
1461
    currently running.
1462

1463
    @type instance: L{objects.Instance}
1464
    @param instance: the instance to be migrated
1465
    @type target: string
1466
    @param target: ip address of the target node
1467
    @type live: boolean
1468
    @param live: perform a live migration
1469

1470
    """
1471
    instance_name = instance.name
1472
    port = instance.hvparams[constants.HV_MIGRATION_PORT]
1473
    pidfile, pid, alive = self._InstancePidAlive(instance_name)
1474
    if not alive:
1475
      raise errors.HypervisorError("Instance not running, cannot migrate")
1476

    
1477
    if not live:
1478
      self._CallMonitorCommand(instance_name, "stop")
1479

    
1480
    migrate_command = ("migrate_set_speed %dm" %
1481
        instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1482
    self._CallMonitorCommand(instance_name, migrate_command)
1483

    
1484
    migrate_command = ("migrate_set_downtime %dms" %
1485
        instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1486
    self._CallMonitorCommand(instance_name, migrate_command)
1487

    
1488
    migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1489
    self._CallMonitorCommand(instance_name, migrate_command)
1490

    
1491
    info_command = "info migrate"
1492
    done = False
1493
    broken_answers = 0
1494
    while not done:
1495
      result = self._CallMonitorCommand(instance_name, info_command)
1496
      match = self._MIGRATION_STATUS_RE.search(result.stdout)
1497
      if not match:
1498
        broken_answers += 1
1499
        if not result.stdout:
1500
          logging.info("KVM: empty 'info migrate' result")
1501
        else:
1502
          logging.warning("KVM: unknown 'info migrate' result: %s",
1503
                          result.stdout)
1504
        time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1505
      else:
1506
        status = match.group(1)
1507
        if status == "completed":
1508
          done = True
1509
        elif status == "active":
1510
          # reset the broken answers count
1511
          broken_answers = 0
1512
          time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1513
        elif status == "failed" or status == "cancelled":
1514
          if not live:
1515
            self._CallMonitorCommand(instance_name, 'cont')
1516
          raise errors.HypervisorError("Migration %s at the kvm level" %
1517
                                       status)
1518
        else:
1519
          logging.warning("KVM: unknown migration status '%s'", status)
1520
          broken_answers += 1
1521
          time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1522
      if broken_answers >= self._MIGRATION_INFO_MAX_BAD_ANSWERS:
1523
        raise errors.HypervisorError("Too many 'info migrate' broken answers")
1524

    
1525
    utils.KillProcess(pid)
1526
    self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1527

    
1528
  def GetNodeInfo(self):
1529
    """Return information about the node.
1530

1531
    @return: a dict with the following keys (values in MiB):
1532
          - memory_total: the total memory size on the node
1533
          - memory_free: the available memory on the node for instances
1534
          - memory_dom0: the memory used by the node itself, if available
1535
          - hv_version: the hypervisor version in the form (major, minor,
1536
                        revision)
1537

1538
    """
1539
    result = self.GetLinuxNodeInfo()
1540
    _, v_major, v_min, v_rev = self._GetKVMVersion()
1541
    result[constants.HV_NODEINFO_KEY_VERSION] = (v_major, v_min, v_rev)
1542
    return result
1543

    
1544
  @classmethod
1545
  def GetInstanceConsole(cls, instance, hvparams, beparams):
1546
    """Return a command for connecting to the console of an instance.
1547

1548
    """
1549
    if hvparams[constants.HV_SERIAL_CONSOLE]:
1550
      cmd = [constants.KVM_CONSOLE_WRAPPER,
1551
             constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1552
             utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1553
             "STDIO,%s" % cls._SocatUnixConsoleParams(),
1554
             "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1555
      return objects.InstanceConsole(instance=instance.name,
1556
                                     kind=constants.CONS_SSH,
1557
                                     host=instance.primary_node,
1558
                                     user=constants.GANETI_RUNAS,
1559
                                     command=cmd)
1560

    
1561
    vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1562
    if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1563
      display = instance.network_port - constants.VNC_BASE_PORT
1564
      return objects.InstanceConsole(instance=instance.name,
1565
                                     kind=constants.CONS_VNC,
1566
                                     host=vnc_bind_address,
1567
                                     port=instance.network_port,
1568
                                     display=display)
1569

    
1570
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1571
    if spice_bind:
1572
      return objects.InstanceConsole(instance=instance.name,
1573
                                     kind=constants.CONS_SPICE,
1574
                                     host=spice_bind,
1575
                                     port=instance.network_port)
1576

    
1577
    return objects.InstanceConsole(instance=instance.name,
1578
                                   kind=constants.CONS_MESSAGE,
1579
                                   message=("No serial shell for instance %s" %
1580
                                            instance.name))
1581

    
1582
  def Verify(self):
1583
    """Verify the hypervisor.
1584

1585
    Check that the binary exists.
1586

1587
    """
1588
    if not os.path.exists(constants.KVM_PATH):
1589
      return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1590
    if not os.path.exists(constants.SOCAT_PATH):
1591
      return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1592

    
1593
  @classmethod
1594
  def CheckParameterSyntax(cls, hvparams):
1595
    """Check the given parameters for validity.
1596

1597
    @type hvparams:  dict
1598
    @param hvparams: dictionary with parameter names/value
1599
    @raise errors.HypervisorError: when a parameter is not valid
1600

1601
    """
1602
    super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1603

    
1604
    kernel_path = hvparams[constants.HV_KERNEL_PATH]
1605
    if kernel_path:
1606
      if not hvparams[constants.HV_ROOT_PATH]:
1607
        raise errors.HypervisorError("Need a root partition for the instance,"
1608
                                     " if a kernel is defined")
1609

    
1610
    if (hvparams[constants.HV_VNC_X509_VERIFY] and
1611
        not hvparams[constants.HV_VNC_X509]):
1612
      raise errors.HypervisorError("%s must be defined, if %s is" %
1613
                                   (constants.HV_VNC_X509,
1614
                                    constants.HV_VNC_X509_VERIFY))
1615

    
1616
    boot_order = hvparams[constants.HV_BOOT_ORDER]
1617
    if (boot_order == constants.HT_BO_CDROM and
1618
        not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1619
      raise errors.HypervisorError("Cannot boot from cdrom without an"
1620
                                   " ISO path")
1621

    
1622
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1623
    if security_model == constants.HT_SM_USER:
1624
      if not hvparams[constants.HV_SECURITY_DOMAIN]:
1625
        raise errors.HypervisorError("A security domain (user to run kvm as)"
1626
                                     " must be specified")
1627
    elif (security_model == constants.HT_SM_NONE or
1628
          security_model == constants.HT_SM_POOL):
1629
      if hvparams[constants.HV_SECURITY_DOMAIN]:
1630
        raise errors.HypervisorError("Cannot have a security domain when the"
1631
                                     " security model is 'none' or 'pool'")
1632

    
1633
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1634
    spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1635
    if spice_bind:
1636
      if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1637
        # if an IP version is specified, the spice_bind parameter must be an
1638
        # IP of that family
1639
        if (netutils.IP4Address.IsValid(spice_bind) and
1640
            spice_ip_version != constants.IP4_VERSION):
1641
          raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1642
                                       " the specified IP version is %s" %
1643
                                       (spice_bind, spice_ip_version))
1644

    
1645
        if (netutils.IP6Address.IsValid(spice_bind) and
1646
            spice_ip_version != constants.IP6_VERSION):
1647
          raise errors.HypervisorError("spice: got an IPv6 address (%s), but"
1648
                                       " the specified IP version is %s" %
1649
                                       (spice_bind, spice_ip_version))
1650
    else:
1651
      # All the other SPICE parameters depend on spice_bind being set. Raise an
1652
      # error if any of them is set without it.
1653
      spice_additional_params = frozenset([
1654
        constants.HV_KVM_SPICE_IP_VERSION,
1655
        constants.HV_KVM_SPICE_PASSWORD_FILE,
1656
        constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR,
1657
        constants.HV_KVM_SPICE_JPEG_IMG_COMPR,
1658
        constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR,
1659
        constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION,
1660
        ])
1661
      for param in spice_additional_params:
1662
        if hvparams[param]:
1663
          raise errors.HypervisorError("spice: %s requires %s to be set" %
1664
                                       (param, constants.HV_KVM_SPICE_BIND))
1665

    
1666
  @classmethod
1667
  def ValidateParameters(cls, hvparams):
1668
    """Check the given parameters for validity.
1669

1670
    @type hvparams:  dict
1671
    @param hvparams: dictionary with parameter names/value
1672
    @raise errors.HypervisorError: when a parameter is not valid
1673

1674
    """
1675
    super(KVMHypervisor, cls).ValidateParameters(hvparams)
1676

    
1677
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1678
    if security_model == constants.HT_SM_USER:
1679
      username = hvparams[constants.HV_SECURITY_DOMAIN]
1680
      try:
1681
        pwd.getpwnam(username)
1682
      except KeyError:
1683
        raise errors.HypervisorError("Unknown security domain user %s"
1684
                                     % username)
1685

    
1686
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1687
    if spice_bind:
1688
      # only one of VNC and SPICE can be used currently.
1689
      if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1690
        raise errors.HypervisorError("both SPICE and VNC are configured, but"
1691
                                     " only one of them can be used at a"
1692
                                     " given time.")
1693

    
1694
      # KVM version should be >= 0.14.0
1695
      _, v_major, v_min, _ = cls._GetKVMVersion()
1696
      if (v_major, v_min) < (0, 14):
1697
        raise errors.HypervisorError("spice is configured, but it is not"
1698
                                     " available in versions of KVM < 0.14")
1699

    
1700
      # if spice_bind is not an IP address, it must be a valid interface
1701
      bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1702
                       or netutils.IP6Address.IsValid(spice_bind))
1703
      if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1704
        raise errors.HypervisorError("spice: the %s parameter must be either"
1705
                                     " a valid IP address or interface name" %
1706
                                     constants.HV_KVM_SPICE_BIND)
1707

    
1708
  @classmethod
1709
  def PowercycleNode(cls):
1710
    """KVM powercycle, just a wrapper over Linux powercycle.
1711

1712
    """
1713
    cls.LinuxPowercycle()