Statistics
| Branch: | Tag: | Revision:

root / lib / hypervisor / hv_kvm.py @ 61643226

History | View | Annotate | Download (68.2 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
try:
40
  import affinity   # pylint: disable=F0401
41
except ImportError:
42
  affinity = None
43

    
44
from ganeti import utils
45
from ganeti import constants
46
from ganeti import errors
47
from ganeti import serializer
48
from ganeti import objects
49
from ganeti import uidpool
50
from ganeti import ssconf
51
from ganeti.hypervisor import hv_base
52
from ganeti import netutils
53
from ganeti.utils import wrapper as utils_wrapper
54

    
55

    
56
_KVM_NETWORK_SCRIPT = constants.SYSCONFDIR + "/ganeti/kvm-vif-bridge"
57
_KVM_START_PAUSED_FLAG = "-S"
58

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

    
69

    
70
def _ProbeTapVnetHdr(fd):
71
  """Check whether to enable the IFF_VNET_HDR flag.
72

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

83
   @type fd: int
84
   @param fd: the file descriptor of /dev/net/tun
85

86
  """
87
  req = struct.pack("I", 0)
88
  try:
89
    res = fcntl.ioctl(fd, TUNGETFEATURES, req)
90
  except EnvironmentError:
91
    logging.warning("TUNGETFEATURES ioctl() not implemented")
92
    return False
93

    
94
  tunflags = struct.unpack("I", res)[0]
95
  if tunflags & IFF_VNET_HDR:
96
    return True
97
  else:
98
    logging.warning("Host does not support IFF_VNET_HDR, not enabling")
99
    return False
100

    
101

    
102
def _OpenTap(vnet_hdr=True):
103
  """Open a new tap device and return its file descriptor.
104

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

108
  @type vnet_hdr: boolean
109
  @param vnet_hdr: Enable the VNET Header
110
  @return: (ifname, tapfd)
111
  @rtype: tuple
112

113
  """
114
  try:
115
    tapfd = os.open("/dev/net/tun", os.O_RDWR)
116
  except EnvironmentError:
117
    raise errors.HypervisorError("Failed to open /dev/net/tun")
118

    
119
  flags = IFF_TAP | IFF_NO_PI
120

    
121
  if vnet_hdr and _ProbeTapVnetHdr(tapfd):
122
    flags |= IFF_VNET_HDR
123

    
124
  # The struct ifreq ioctl request (see netdevice(7))
125
  ifr = struct.pack("16sh", "", flags)
126

    
127
  try:
128
    res = fcntl.ioctl(tapfd, TUNSETIFF, ifr)
129
  except EnvironmentError:
130
    raise errors.HypervisorError("Failed to allocate a new TAP device")
131

    
132
  # Get the interface name from the ioctl
133
  ifname = struct.unpack("16sh", res)[0].strip("\x00")
134
  return (ifname, tapfd)
135

    
136

    
137
class QmpMessage:
138
  """QEMU Messaging Protocol (QMP) message.
139

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

    
161
    if field_name in self.data:
162
      return self.data[field_name]
163

    
164
    return None
165

    
166
  def __setitem__(self, field_name, field_value):
167
    """Set the value of the required field_name to field_value.
168

169
    """
170
    self.data[field_name] = field_value
171

    
172
  @staticmethod
173
  def BuildFromJsonString(json_string):
174
    """Build a QmpMessage from a JSON encoded string.
175

176
    @type json_string: str
177
    @param json_string: JSON string representing the message
178
    @rtype: L{QmpMessage}
179
    @return: a L{QmpMessage} built from json_string
180

181
    """
182
    # Parse the string
183
    data = serializer.LoadJson(json_string)
184
    return QmpMessage(data)
185

    
186
  def __str__(self):
187
    # The protocol expects the JSON object to be sent as a single
188
    # line, hence the need for indent=False.
189
    return serializer.DumpJson(self.data, indent=False)
190

    
191
  def __eq__(self, other):
192
    # When comparing two QmpMessages, we are interested in comparing
193
    # their internal representation of the message data
194
    return self.data == other.data
195

    
196

    
197
class QmpConnection:
198
  """Connection to the QEMU Monitor using the QEMU Monitor Protocol (QMP).
199

200
  """
201
  _FIRST_MESSAGE_KEY = "QMP"
202
  _EVENT_KEY = "event"
203
  _ERROR_KEY = "error"
204
  _ERROR_CLASS_KEY = "class"
205
  _ERROR_DATA_KEY = "data"
206
  _ERROR_DESC_KEY = "desc"
207
  _EXECUTE_KEY = "execute"
208
  _ARGUMENTS_KEY = "arguments"
209
  _CAPABILITIES_COMMAND = "qmp_capabilities"
210
  _MESSAGE_END_TOKEN = "\r\n"
211
  _SOCKET_TIMEOUT = 5
212

    
213
  def __init__(self, monitor_filename):
214
    """Instantiates the QmpConnection object.
215

216
    @type monitor_filename: string
217
    @param monitor_filename: the filename of the UNIX raw socket on which the
218
                             QMP monitor is listening
219

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

    
229
  def _check_connection(self):
230
    """Make sure that the connection is established.
231

232
    """
233
    if not self._connected:
234
      raise errors.ProgrammerError("To use a QmpConnection you need to first"
235
                                   " invoke connect() on it")
236

    
237
  def connect(self):
238
    """Connects to the QMP monitor.
239

240
    Connects to the UNIX socket and makes sure that we can actually send and
241
    receive data to the kvm instance via QMP.
242

243
    @raise errors.HypervisorError: when there are communication errors
244
    @raise errors.ProgrammerError: when there are data serialization errors
245

246
    """
247
    self.sock.connect(self.monitor_filename)
248
    self._connected = True
249

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

    
258
    # Let's put the monitor in command mode using the qmp_capabilities
259
    # command, or else no command will be executable.
260
    # (As per the QEMU Protocol Specification 0.1 - section 4)
261
    self.Execute(self._CAPABILITIES_COMMAND)
262

    
263
  def _ParseMessage(self, buf):
264
    """Extract and parse a QMP message from the given buffer.
265

266
    Seeks for a QMP message in the given buf. If found, it parses it and
267
    returns it together with the rest of the characters in the buf.
268
    If no message is found, returns None and the whole buffer.
269

270
    @raise errors.ProgrammerError: when there are data serialization errors
271

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

    
284
    return (message, buf)
285

    
286
  def _Recv(self):
287
    """Receives a message from QMP and decodes the received JSON object.
288

289
    @rtype: QmpMessage
290
    @return: the received message
291
    @raise errors.HypervisorError: when there are communication errors
292
    @raise errors.ProgrammerError: when there are data serialization errors
293

294
    """
295
    self._check_connection()
296

    
297
    # Check if there is already a message in the buffer
298
    (message, self._buf) = self._ParseMessage(self._buf)
299
    if message:
300
      return message
301

    
302
    recv_buffer = StringIO.StringIO(self._buf)
303
    recv_buffer.seek(len(self._buf))
304
    try:
305
      while True:
306
        data = self.sock.recv(4096)
307
        if not data:
308
          break
309
        recv_buffer.write(data)
310

    
311
        (message, self._buf) = self._ParseMessage(recv_buffer.getvalue())
312
        if message:
313
          return message
314

    
315
    except socket.timeout, err:
316
      raise errors.HypervisorError("Timeout while receiving a QMP message: "
317
                                   "%s" % (err))
318
    except socket.error, err:
319
      raise errors.HypervisorError("Unable to receive data from KVM using the"
320
                                   " QMP protocol: %s" % err)
321

    
322
  def _Send(self, message):
323
    """Encodes and sends a message to KVM using QMP.
324

325
    @type message: QmpMessage
326
    @param message: message to send to KVM
327
    @raise errors.HypervisorError: when there are communication errors
328
    @raise errors.ProgrammerError: when there are data serialization errors
329

330
    """
331
    self._check_connection()
332
    try:
333
      message_str = str(message)
334
    except Exception, err:
335
      raise errors.ProgrammerError("QMP data deserialization error: %s" % err)
336

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

    
346
  def Execute(self, command, arguments=None):
347
    """Executes a QMP command and returns the response of the server.
348

349
    @type command: str
350
    @param command: the command to execute
351
    @type arguments: dict
352
    @param arguments: dictionary of arguments to be passed to the command
353
    @rtype: dict
354
    @return: dictionary representing the received JSON object
355
    @raise errors.HypervisorError: when there are communication errors
356
    @raise errors.ProgrammerError: when there are data serialization errors
357

358
    """
359
    self._check_connection()
360
    message = QmpMessage({self._EXECUTE_KEY: command})
361
    if arguments:
362
      message[self._ARGUMENTS_KEY] = arguments
363
    self._Send(message)
364

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

    
378
      elif not response[self._EVENT_KEY]:
379
        return response
380

    
381

    
382
class KVMHypervisor(hv_base.BaseHypervisor):
383
  """KVM hypervisor interface"""
384
  CAN_MIGRATE = True
385

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

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

    
477
  _MIGRATION_STATUS_RE = re.compile("Migration\s+status:\s+(\w+)",
478
                                    re.M | re.I)
479
  _MIGRATION_PROGRESS_RE = re.compile(
480
      "\s*transferred\s+ram:\s+(?P<transferred>\d+)\s+kbytes\s*\n"
481
      "\s*remaining\s+ram:\s+(?P<remaining>\d+)\s+kbytes\s*\n"
482
      "\s*total\s+ram:\s+(?P<total>\d+)\s+kbytes\s*\n", re.I)
483

    
484
  _MIGRATION_INFO_MAX_BAD_ANSWERS = 5
485
  _MIGRATION_INFO_RETRY_DELAY = 2
486

    
487
  _VERSION_RE = re.compile(r"\b(\d+)\.(\d+)\.(\d+)\b")
488

    
489
  _CPU_INFO_RE = re.compile(r"cpu\s+\#(\d+).*thread_id\s*=\s*(\d+)", re.I)
490
  _CPU_INFO_CMD = "info cpus"
491
  _CONT_CMD = "cont"
492

    
493
  ANCILLARY_FILES = [
494
    _KVM_NETWORK_SCRIPT,
495
    ]
496

    
497
  def __init__(self):
498
    hv_base.BaseHypervisor.__init__(self)
499
    # Let's make sure the directories we need exist, even if the RUN_DIR lives
500
    # in a tmpfs filesystem or has been otherwise wiped out.
501
    dirs = [(dname, constants.RUN_DIRS_MODE) for dname in self._DIRS]
502
    utils.EnsureDirs(dirs)
503

    
504
  @classmethod
505
  def _InstancePidFile(cls, instance_name):
506
    """Returns the instance pidfile.
507

508
    """
509
    return utils.PathJoin(cls._PIDS_DIR, instance_name)
510

    
511
  @classmethod
512
  def _InstanceUidFile(cls, instance_name):
513
    """Returns the instance uidfile.
514

515
    """
516
    return utils.PathJoin(cls._UIDS_DIR, instance_name)
517

    
518
  @classmethod
519
  def _InstancePidInfo(cls, pid):
520
    """Check pid file for instance information.
521

522
    Check that a pid file is associated with an instance, and retrieve
523
    information from its command line.
524

525
    @type pid: string or int
526
    @param pid: process id of the instance to check
527
    @rtype: tuple
528
    @return: (instance_name, memory, vcpus)
529
    @raise errors.HypervisorError: when an instance cannot be found
530

531
    """
532
    alive = utils.IsProcessAlive(pid)
533
    if not alive:
534
      raise errors.HypervisorError("Cannot get info for pid %s" % pid)
535

    
536
    cmdline_file = utils.PathJoin("/proc", str(pid), "cmdline")
537
    try:
538
      cmdline = utils.ReadFile(cmdline_file)
539
    except EnvironmentError, err:
540
      raise errors.HypervisorError("Can't open cmdline file for pid %s: %s" %
541
                                   (pid, err))
542

    
543
    instance = None
544
    memory = 0
545
    vcpus = 0
546

    
547
    arg_list = cmdline.split("\x00")
548
    while arg_list:
549
      arg = arg_list.pop(0)
550
      if arg == "-name":
551
        instance = arg_list.pop(0)
552
      elif arg == "-m":
553
        memory = int(arg_list.pop(0))
554
      elif arg == "-smp":
555
        vcpus = int(arg_list.pop(0))
556

    
557
    if instance is None:
558
      raise errors.HypervisorError("Pid %s doesn't contain a ganeti kvm"
559
                                   " instance" % pid)
560

    
561
    return (instance, memory, vcpus)
562

    
563
  def _InstancePidAlive(self, instance_name):
564
    """Returns the instance pidfile, pid, and liveness.
565

566
    @type instance_name: string
567
    @param instance_name: instance name
568
    @rtype: tuple
569
    @return: (pid file name, pid, liveness)
570

571
    """
572
    pidfile = self._InstancePidFile(instance_name)
573
    pid = utils.ReadPidFile(pidfile)
574

    
575
    alive = False
576
    try:
577
      cmd_instance = self._InstancePidInfo(pid)[0]
578
      alive = (cmd_instance == instance_name)
579
    except errors.HypervisorError:
580
      pass
581

    
582
    return (pidfile, pid, alive)
583

    
584
  def _CheckDown(self, instance_name):
585
    """Raises an error unless the given instance is down.
586

587
    """
588
    alive = self._InstancePidAlive(instance_name)[2]
589
    if alive:
590
      raise errors.HypervisorError("Failed to start instance %s: %s" %
591
                                   (instance_name, "already running"))
592

    
593
  @classmethod
594
  def _InstanceMonitor(cls, instance_name):
595
    """Returns the instance monitor socket name
596

597
    """
598
    return utils.PathJoin(cls._CTRL_DIR, "%s.monitor" % instance_name)
599

    
600
  @classmethod
601
  def _InstanceSerial(cls, instance_name):
602
    """Returns the instance serial socket name
603

604
    """
605
    return utils.PathJoin(cls._CTRL_DIR, "%s.serial" % instance_name)
606

    
607
  @classmethod
608
  def _InstanceQmpMonitor(cls, instance_name):
609
    """Returns the instance serial QMP socket name
610

611
    """
612
    return utils.PathJoin(cls._CTRL_DIR, "%s.qmp" % instance_name)
613

    
614
  @staticmethod
615
  def _SocatUnixConsoleParams():
616
    """Returns the correct parameters for socat
617

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

620
    """
621
    if constants.SOCAT_USE_ESCAPE:
622
      return "raw,echo=0,escape=%s" % constants.SOCAT_ESCAPE_CODE
623
    else:
624
      return "echo=0,icanon=0"
625

    
626
  @classmethod
627
  def _InstanceKVMRuntime(cls, instance_name):
628
    """Returns the instance KVM runtime filename
629

630
    """
631
    return utils.PathJoin(cls._CONF_DIR, "%s.runtime" % instance_name)
632

    
633
  @classmethod
634
  def _InstanceChrootDir(cls, instance_name):
635
    """Returns the name of the KVM chroot dir of the instance
636

637
    """
638
    return utils.PathJoin(cls._CHROOT_DIR, instance_name)
639

    
640
  @classmethod
641
  def _InstanceNICDir(cls, instance_name):
642
    """Returns the name of the directory holding the tap device files for a
643
    given instance.
644

645
    """
646
    return utils.PathJoin(cls._NICS_DIR, instance_name)
647

    
648
  @classmethod
649
  def _InstanceNICFile(cls, instance_name, seq):
650
    """Returns the name of the file containing the tap device for a given NIC
651

652
    """
653
    return utils.PathJoin(cls._InstanceNICDir(instance_name), str(seq))
654

    
655
  @classmethod
656
  def _InstanceKeymapFile(cls, instance_name):
657
    """Returns the name of the file containing the keymap for a given instance
658

659
    """
660
    return utils.PathJoin(cls._KEYMAP_DIR, instance_name)
661

    
662
  @classmethod
663
  def _TryReadUidFile(cls, uid_file):
664
    """Try to read a uid file
665

666
    """
667
    if os.path.exists(uid_file):
668
      try:
669
        uid = int(utils.ReadOneLineFile(uid_file))
670
        return uid
671
      except EnvironmentError:
672
        logging.warning("Can't read uid file", exc_info=True)
673
      except (TypeError, ValueError):
674
        logging.warning("Can't parse uid file contents", exc_info=True)
675
    return None
676

    
677
  @classmethod
678
  def _RemoveInstanceRuntimeFiles(cls, pidfile, instance_name):
679
    """Removes an instance's rutime sockets/files/dirs.
680

681
    """
682
    utils.RemoveFile(pidfile)
683
    utils.RemoveFile(cls._InstanceMonitor(instance_name))
684
    utils.RemoveFile(cls._InstanceSerial(instance_name))
685
    utils.RemoveFile(cls._InstanceQmpMonitor(instance_name))
686
    utils.RemoveFile(cls._InstanceKVMRuntime(instance_name))
687
    utils.RemoveFile(cls._InstanceKeymapFile(instance_name))
688
    uid_file = cls._InstanceUidFile(instance_name)
689
    uid = cls._TryReadUidFile(uid_file)
690
    utils.RemoveFile(uid_file)
691
    if uid is not None:
692
      uidpool.ReleaseUid(uid)
693
    try:
694
      shutil.rmtree(cls._InstanceNICDir(instance_name))
695
    except OSError, err:
696
      if err.errno != errno.ENOENT:
697
        raise
698
    try:
699
      chroot_dir = cls._InstanceChrootDir(instance_name)
700
      utils.RemoveDir(chroot_dir)
701
    except OSError, err:
702
      if err.errno == errno.ENOTEMPTY:
703
        # The chroot directory is expected to be empty, but it isn't.
704
        new_chroot_dir = tempfile.mkdtemp(dir=cls._CHROOT_QUARANTINE_DIR,
705
                                          prefix="%s-%s-" %
706
                                          (instance_name,
707
                                           utils.TimestampForFilename()))
708
        logging.warning("The chroot directory of instance %s can not be"
709
                        " removed as it is not empty. Moving it to the"
710
                        " quarantine instead. Please investigate the"
711
                        " contents (%s) and clean up manually",
712
                        instance_name, new_chroot_dir)
713
        utils.RenameFile(chroot_dir, new_chroot_dir)
714
      else:
715
        raise
716

    
717
  @staticmethod
718
  def _ConfigureNIC(instance, seq, nic, tap):
719
    """Run the network configuration script for a specified NIC
720

721
    @param instance: instance we're acting on
722
    @type instance: instance object
723
    @param seq: nic sequence number
724
    @type seq: int
725
    @param nic: nic we're acting on
726
    @type nic: nic object
727
    @param tap: the host's tap interface this NIC corresponds to
728
    @type tap: str
729

730
    """
731

    
732
    if instance.tags:
733
      tags = " ".join(instance.tags)
734
    else:
735
      tags = ""
736

    
737
    env = {
738
      "PATH": "%s:/sbin:/usr/sbin" % os.environ["PATH"],
739
      "INSTANCE": instance.name,
740
      "MAC": nic.mac,
741
      "MODE": nic.nicparams[constants.NIC_MODE],
742
      "INTERFACE": tap,
743
      "INTERFACE_INDEX": str(seq),
744
      "TAGS": tags,
745
    }
746

    
747
    if nic.ip:
748
      env["IP"] = nic.ip
749

    
750
    if nic.nicparams[constants.NIC_LINK]:
751
      env["LINK"] = nic.nicparams[constants.NIC_LINK]
752

    
753
    if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
754
      env["BRIDGE"] = nic.nicparams[constants.NIC_LINK]
755

    
756
    result = utils.RunCmd([constants.KVM_IFUP, tap], env=env)
757
    if result.failed:
758
      raise errors.HypervisorError("Failed to configure interface %s: %s."
759
                                   " Network configuration script output: %s" %
760
                                   (tap, result.fail_reason, result.output))
761

    
762
  @staticmethod
763
  def _VerifyAffinityPackage():
764
    if affinity is None:
765
      raise errors.HypervisorError("affinity Python package not"
766
        " found; cannot use CPU pinning under KVM")
767

    
768
  @staticmethod
769
  def _BuildAffinityCpuMask(cpu_list):
770
    """Create a CPU mask suitable for sched_setaffinity from a list of
771
    CPUs.
772

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

776
    @type cpu_list: list of int
777
    @param cpu_list: list of physical CPU numbers to map to vCPUs in order
778
    @rtype: int
779
    @return: a bit mask of CPU affinities
780

781
    """
782
    if cpu_list == constants.CPU_PINNING_OFF:
783
      return constants.CPU_PINNING_ALL_KVM
784
    else:
785
      return sum(2 ** cpu for cpu in cpu_list)
786

    
787
  @classmethod
788
  def _AssignCpuAffinity(cls, cpu_mask, process_id, thread_dict):
789
    """Change CPU affinity for running VM according to given CPU mask.
790

791
    @param cpu_mask: CPU mask as given by the user. e.g. "0-2,4:all:1,3"
792
    @type cpu_mask: string
793
    @param process_id: process ID of KVM process. Used to pin entire VM
794
                       to physical CPUs.
795
    @type process_id: int
796
    @param thread_dict: map of virtual CPUs to KVM thread IDs
797
    @type thread_dict: dict int:int
798

799
    """
800

    
801
    # Convert the string CPU mask to a list of list of int's
802
    cpu_list = utils.ParseMultiCpuMask(cpu_mask)
803

    
804
    if len(cpu_list) == 1:
805
      all_cpu_mapping = cpu_list[0]
806
      if all_cpu_mapping == constants.CPU_PINNING_OFF:
807
        # If CPU pinning has 1 entry that's "all", then do nothing
808
        pass
809
      else:
810
        # If CPU pinning has one non-all entry, map the entire VM to
811
        # one set of physical CPUs
812
        cls._VerifyAffinityPackage()
813
        affinity.set_process_affinity_mask(process_id,
814
          cls._BuildAffinityCpuMask(all_cpu_mapping))
815
    else:
816
      # The number of vCPUs mapped should match the number of vCPUs
817
      # reported by KVM. This was already verified earlier, so
818
      # here only as a sanity check.
819
      assert len(thread_dict) == len(cpu_list)
820
      cls._VerifyAffinityPackage()
821

    
822
      # For each vCPU, map it to the proper list of physical CPUs
823
      for vcpu, i in zip(cpu_list, range(len(cpu_list))):
824
        affinity.set_process_affinity_mask(thread_dict[i],
825
          cls._BuildAffinityCpuMask(vcpu))
826

    
827
  def _GetVcpuThreadIds(self, instance_name):
828
    """Get a mapping of vCPU no. to thread IDs for the instance
829

830
    @type instance_name: string
831
    @param instance_name: instance in question
832
    @rtype: dictionary of int:int
833
    @return: a dictionary mapping vCPU numbers to thread IDs
834

835
    """
836
    result = {}
837
    output = self._CallMonitorCommand(instance_name, self._CPU_INFO_CMD)
838
    for line in output.stdout.splitlines():
839
      match = self._CPU_INFO_RE.search(line)
840
      if not match:
841
        continue
842
      grp = map(int, match.groups())
843
      result[grp[0]] = grp[1]
844

    
845
    return result
846

    
847
  def _ExecuteCpuAffinity(self, instance_name, cpu_mask):
848
    """Complete CPU pinning.
849

850
    @type instance_name: string
851
    @param instance_name: name of instance
852
    @type cpu_mask: string
853
    @param cpu_mask: CPU pinning mask as entered by user
854

855
    """
856
    # Get KVM process ID, to be used if need to pin entire VM
857
    _, pid, _ = self._InstancePidAlive(instance_name)
858
    # Get vCPU thread IDs, to be used if need to pin vCPUs separately
859
    thread_dict = self._GetVcpuThreadIds(instance_name)
860
    # Run CPU pinning, based on configured mask
861
    self._AssignCpuAffinity(cpu_mask, pid, thread_dict)
862

    
863
  def ListInstances(self):
864
    """Get the list of running instances.
865

866
    We can do this by listing our live instances directory and
867
    checking whether the associated kvm process is still alive.
868

869
    """
870
    result = []
871
    for name in os.listdir(self._PIDS_DIR):
872
      if self._InstancePidAlive(name)[2]:
873
        result.append(name)
874
    return result
875

    
876
  def GetInstanceInfo(self, instance_name):
877
    """Get instance properties.
878

879
    @type instance_name: string
880
    @param instance_name: the instance name
881
    @rtype: tuple of strings
882
    @return: (name, id, memory, vcpus, stat, times)
883

884
    """
885
    _, pid, alive = self._InstancePidAlive(instance_name)
886
    if not alive:
887
      return None
888

    
889
    _, memory, vcpus = self._InstancePidInfo(pid)
890
    stat = "---b-"
891
    times = "0"
892

    
893
    return (instance_name, pid, memory, vcpus, stat, times)
894

    
895
  def GetAllInstancesInfo(self):
896
    """Get properties of all instances.
897

898
    @return: list of tuples (name, id, memory, vcpus, stat, times)
899

900
    """
901
    data = []
902
    for name in os.listdir(self._PIDS_DIR):
903
      try:
904
        info = self.GetInstanceInfo(name)
905
      except errors.HypervisorError:
906
        continue
907
      if info:
908
        data.append(info)
909
    return data
910

    
911
  def _GenerateKVMRuntime(self, instance, block_devices, startup_paused):
912
    """Generate KVM information to start an instance.
913

914
    """
915
    # pylint: disable=R0914,R0915
916
    _, v_major, v_min, _ = self._GetKVMVersion()
917

    
918
    pidfile = self._InstancePidFile(instance.name)
919
    kvm = constants.KVM_PATH
920
    kvm_cmd = [kvm]
921
    # used just by the vnc server, if enabled
922
    kvm_cmd.extend(["-name", instance.name])
923
    kvm_cmd.extend(["-m", instance.beparams[constants.BE_MEMORY]])
924
    kvm_cmd.extend(["-smp", instance.beparams[constants.BE_VCPUS]])
925
    kvm_cmd.extend(["-pidfile", pidfile])
926
    kvm_cmd.extend(["-daemonize"])
927
    if not instance.hvparams[constants.HV_ACPI]:
928
      kvm_cmd.extend(["-no-acpi"])
929
    if instance.hvparams[constants.HV_REBOOT_BEHAVIOR] == \
930
        constants.INSTANCE_REBOOT_EXIT:
931
      kvm_cmd.extend(["-no-reboot"])
932

    
933
    hvp = instance.hvparams
934
    boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
935
    boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
936
    boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
937
    boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
938

    
939
    self.ValidateParameters(hvp)
940

    
941
    if startup_paused:
942
      kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
943

    
944
    if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
945
      kvm_cmd.extend(["-enable-kvm"])
946
    elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
947
      kvm_cmd.extend(["-disable-kvm"])
948

    
949
    if boot_network:
950
      kvm_cmd.extend(["-boot", "n"])
951

    
952
    disk_type = hvp[constants.HV_DISK_TYPE]
953
    if disk_type == constants.HT_DISK_PARAVIRTUAL:
954
      if_val = ",if=virtio"
955
    else:
956
      if_val = ",if=%s" % disk_type
957
    # Cache mode
958
    disk_cache = hvp[constants.HV_DISK_CACHE]
959
    if instance.disk_template in constants.DTS_EXT_MIRROR:
960
      if disk_cache != "none":
961
        # TODO: make this a hard error, instead of a silent overwrite
962
        logging.warning("KVM: overriding disk_cache setting '%s' with 'none'"
963
                        " to prevent shared storage corruption on migration",
964
                        disk_cache)
965
      cache_val = ",cache=none"
966
    elif disk_cache != constants.HT_CACHE_DEFAULT:
967
      cache_val = ",cache=%s" % disk_cache
968
    else:
969
      cache_val = ""
970
    for cfdev, dev_path in block_devices:
971
      if cfdev.mode != constants.DISK_RDWR:
972
        raise errors.HypervisorError("Instance has read-only disks which"
973
                                     " are not supported by KVM")
974
      # TODO: handle FD_LOOP and FD_BLKTAP (?)
975
      boot_val = ""
976
      if boot_disk:
977
        kvm_cmd.extend(["-boot", "c"])
978
        boot_disk = False
979
        if (v_major, v_min) < (0, 14) and disk_type != constants.HT_DISK_IDE:
980
          boot_val = ",boot=on"
981

    
982
      drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
983
                                                cache_val)
984
      kvm_cmd.extend(["-drive", drive_val])
985

    
986
    #Now we can specify a different device type for CDROM devices.
987
    cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
988
    if not cdrom_disk_type:
989
      cdrom_disk_type = disk_type
990

    
991
    iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
992
    if iso_image:
993
      options = ",format=raw,media=cdrom"
994
      if boot_cdrom:
995
        kvm_cmd.extend(["-boot", "d"])
996
        if cdrom_disk_type != constants.HT_DISK_IDE:
997
          options = "%s,boot=on,if=%s" % (options, constants.HT_DISK_IDE)
998
        else:
999
          options = "%s,boot=on" % options
1000
      else:
1001
        if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1002
          if_val = ",if=virtio"
1003
        else:
1004
          if_val = ",if=%s" % cdrom_disk_type
1005
        options = "%s%s" % (options, if_val)
1006
      drive_val = "file=%s%s" % (iso_image, options)
1007
      kvm_cmd.extend(["-drive", drive_val])
1008

    
1009
    iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
1010
    if iso_image2:
1011
      options = ",format=raw,media=cdrom"
1012
      if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1013
        if_val = ",if=virtio"
1014
      else:
1015
        if_val = ",if=%s" % cdrom_disk_type
1016
      options = "%s%s" % (options, if_val)
1017
      drive_val = "file=%s%s" % (iso_image2, options)
1018
      kvm_cmd.extend(["-drive", drive_val])
1019

    
1020
    floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
1021
    if floppy_image:
1022
      options = ",format=raw,media=disk"
1023
      if boot_floppy:
1024
        kvm_cmd.extend(["-boot", "a"])
1025
        options = "%s,boot=on" % options
1026
      if_val = ",if=floppy"
1027
      options = "%s%s" % (options, if_val)
1028
      drive_val = "file=%s%s" % (floppy_image, options)
1029
      kvm_cmd.extend(["-drive", drive_val])
1030

    
1031
    kernel_path = hvp[constants.HV_KERNEL_PATH]
1032
    if kernel_path:
1033
      kvm_cmd.extend(["-kernel", kernel_path])
1034
      initrd_path = hvp[constants.HV_INITRD_PATH]
1035
      if initrd_path:
1036
        kvm_cmd.extend(["-initrd", initrd_path])
1037
      root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
1038
                     hvp[constants.HV_KERNEL_ARGS]]
1039
      if hvp[constants.HV_SERIAL_CONSOLE]:
1040
        root_append.append("console=ttyS0,38400")
1041
      kvm_cmd.extend(["-append", " ".join(root_append)])
1042

    
1043
    mem_path = hvp[constants.HV_MEM_PATH]
1044
    if mem_path:
1045
      kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
1046

    
1047
    mouse_type = hvp[constants.HV_USB_MOUSE]
1048
    vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
1049

    
1050
    if mouse_type:
1051
      kvm_cmd.extend(["-usb"])
1052
      kvm_cmd.extend(["-usbdevice", mouse_type])
1053
    elif vnc_bind_address:
1054
      kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
1055

    
1056
    keymap = hvp[constants.HV_KEYMAP]
1057
    if keymap:
1058
      keymap_path = self._InstanceKeymapFile(instance.name)
1059
      # If a keymap file is specified, KVM won't use its internal defaults. By
1060
      # first including the "en-us" layout, an error on loading the actual
1061
      # layout (e.g. because it can't be found) won't lead to a non-functional
1062
      # keyboard. A keyboard with incorrect keys is still better than none.
1063
      utils.WriteFile(keymap_path, data="include en-us\ninclude %s\n" % keymap)
1064
      kvm_cmd.extend(["-k", keymap_path])
1065

    
1066
    if vnc_bind_address:
1067
      if netutils.IP4Address.IsValid(vnc_bind_address):
1068
        if instance.network_port > constants.VNC_BASE_PORT:
1069
          display = instance.network_port - constants.VNC_BASE_PORT
1070
          if vnc_bind_address == constants.IP4_ADDRESS_ANY:
1071
            vnc_arg = ":%d" % (display)
1072
          else:
1073
            vnc_arg = "%s:%d" % (vnc_bind_address, display)
1074
        else:
1075
          logging.error("Network port is not a valid VNC display (%d < %d)."
1076
                        " Not starting VNC", instance.network_port,
1077
                        constants.VNC_BASE_PORT)
1078
          vnc_arg = "none"
1079

    
1080
        # Only allow tls and other option when not binding to a file, for now.
1081
        # kvm/qemu gets confused otherwise about the filename to use.
1082
        vnc_append = ""
1083
        if hvp[constants.HV_VNC_TLS]:
1084
          vnc_append = "%s,tls" % vnc_append
1085
          if hvp[constants.HV_VNC_X509_VERIFY]:
1086
            vnc_append = "%s,x509verify=%s" % (vnc_append,
1087
                                               hvp[constants.HV_VNC_X509])
1088
          elif hvp[constants.HV_VNC_X509]:
1089
            vnc_append = "%s,x509=%s" % (vnc_append,
1090
                                         hvp[constants.HV_VNC_X509])
1091
        if hvp[constants.HV_VNC_PASSWORD_FILE]:
1092
          vnc_append = "%s,password" % vnc_append
1093

    
1094
        vnc_arg = "%s%s" % (vnc_arg, vnc_append)
1095

    
1096
      else:
1097
        vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
1098

    
1099
      kvm_cmd.extend(["-vnc", vnc_arg])
1100
    else:
1101
      kvm_cmd.extend(["-nographic"])
1102

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

    
1113
    spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
1114
    spice_ip_version = None
1115
    if spice_bind:
1116
      if netutils.IsValidInterface(spice_bind):
1117
        # The user specified a network interface, we have to figure out the IP
1118
        # address.
1119
        addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1120
        spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1121

    
1122
        # if the user specified an IP version and the interface does not
1123
        # have that kind of IP addresses, throw an exception
1124
        if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1125
          if not addresses[spice_ip_version]:
1126
            raise errors.HypervisorError("spice: unable to get an IPv%s address"
1127
                                         " for %s" % (spice_ip_version,
1128
                                                      spice_bind))
1129

    
1130
        # the user did not specify an IP version, we have to figure it out
1131
        elif (addresses[constants.IP4_VERSION] and
1132
              addresses[constants.IP6_VERSION]):
1133
          # we have both ipv4 and ipv6, let's use the cluster default IP
1134
          # version
1135
          cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1136
          spice_ip_version = netutils.IPAddress.GetVersionFromAddressFamily(
1137
              cluster_family)
1138
        elif addresses[constants.IP4_VERSION]:
1139
          spice_ip_version = constants.IP4_VERSION
1140
        elif addresses[constants.IP6_VERSION]:
1141
          spice_ip_version = constants.IP6_VERSION
1142
        else:
1143
          raise errors.HypervisorError("spice: unable to get an IP address"
1144
                                       " for %s" % (spice_bind))
1145

    
1146
        spice_address = addresses[spice_ip_version][0]
1147

    
1148
      else:
1149
        # spice_bind is known to be a valid IP address, because
1150
        # ValidateParameters checked it.
1151
        spice_address = spice_bind
1152

    
1153
      spice_arg = "addr=%s" % spice_address
1154
      if hvp[constants.HV_KVM_SPICE_USE_TLS]:
1155
        spice_arg = "%s,tls-port=%s,x509-cacert-file=%s" % (spice_arg,
1156
            instance.network_port, constants.SPICE_CACERT_FILE)
1157
        spice_arg = "%s,x509-key-file=%s,x509-cert-file=%s" % (spice_arg,
1158
            constants.SPICE_CERT_FILE, constants.SPICE_CERT_FILE)
1159
        tls_ciphers = hvp[constants.HV_KVM_SPICE_TLS_CIPHERS]
1160
        if tls_ciphers:
1161
          spice_arg = "%s,tls-ciphers=%s" % (spice_arg, tls_ciphers)
1162
      else:
1163
        spice_arg = "%s,port=%s" % (spice_arg, instance.network_port)
1164

    
1165
      if not hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]:
1166
        spice_arg = "%s,disable-ticketing" % spice_arg
1167

    
1168
      if spice_ip_version:
1169
        spice_arg = "%s,ipv%s" % (spice_arg, spice_ip_version)
1170

    
1171
      # Image compression options
1172
      img_lossless = hvp[constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR]
1173
      img_jpeg = hvp[constants.HV_KVM_SPICE_JPEG_IMG_COMPR]
1174
      img_zlib_glz = hvp[constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR]
1175
      if img_lossless:
1176
        spice_arg = "%s,image-compression=%s" % (spice_arg, img_lossless)
1177
      if img_jpeg:
1178
        spice_arg = "%s,jpeg-wan-compression=%s" % (spice_arg, img_jpeg)
1179
      if img_zlib_glz:
1180
        spice_arg = "%s,zlib-glz-wan-compression=%s" % (spice_arg, img_zlib_glz)
1181

    
1182
      # Video stream detection
1183
      video_streaming = hvp[constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION]
1184
      if video_streaming:
1185
        spice_arg = "%s,streaming-video=%s" % (spice_arg, video_streaming)
1186

    
1187
      # Audio compression, by default in qemu-kvm it is on
1188
      if not hvp[constants.HV_KVM_SPICE_AUDIO_COMPR]:
1189
        spice_arg = "%s,playback-compression=off" % spice_arg
1190
      if not hvp[constants.HV_KVM_SPICE_USE_VDAGENT]:
1191
        spice_arg = "%s,agent-mouse=off" % spice_arg
1192

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

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

    
1199
    if hvp[constants.HV_USE_LOCALTIME]:
1200
      kvm_cmd.extend(["-localtime"])
1201

    
1202
    if hvp[constants.HV_KVM_USE_CHROOT]:
1203
      kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1204

    
1205
    # Save the current instance nics, but defer their expansion as parameters,
1206
    # as we'll need to generate executable temp files for them.
1207
    kvm_nics = instance.nics
1208
    hvparams = hvp
1209

    
1210
    return (kvm_cmd, kvm_nics, hvparams)
1211

    
1212
  def _WriteKVMRuntime(self, instance_name, data):
1213
    """Write an instance's KVM runtime
1214

1215
    """
1216
    try:
1217
      utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1218
                      data=data)
1219
    except EnvironmentError, err:
1220
      raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1221

    
1222
  def _ReadKVMRuntime(self, instance_name):
1223
    """Read an instance's KVM runtime
1224

1225
    """
1226
    try:
1227
      file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1228
    except EnvironmentError, err:
1229
      raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1230
    return file_content
1231

    
1232
  def _SaveKVMRuntime(self, instance, kvm_runtime):
1233
    """Save an instance's KVM runtime
1234

1235
    """
1236
    kvm_cmd, kvm_nics, hvparams = kvm_runtime
1237
    serialized_nics = [nic.ToDict() for nic in kvm_nics]
1238
    serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1239
    self._WriteKVMRuntime(instance.name, serialized_form)
1240

    
1241
  def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1242
    """Load an instance's KVM runtime
1243

1244
    """
1245
    if not serialized_runtime:
1246
      serialized_runtime = self._ReadKVMRuntime(instance.name)
1247
    loaded_runtime = serializer.Load(serialized_runtime)
1248
    kvm_cmd, serialized_nics, hvparams = loaded_runtime
1249
    kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1250
    return (kvm_cmd, kvm_nics, hvparams)
1251

    
1252
  def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1253
    """Run the KVM cmd and check for errors
1254

1255
    @type name: string
1256
    @param name: instance name
1257
    @type kvm_cmd: list of strings
1258
    @param kvm_cmd: runcmd input for kvm
1259
    @type tap_fds: list of int
1260
    @param tap_fds: fds of tap devices opened by Ganeti
1261

1262
    """
1263
    try:
1264
      result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1265
    finally:
1266
      for fd in tap_fds:
1267
        utils_wrapper.CloseFdNoError(fd)
1268

    
1269
    if result.failed:
1270
      raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1271
                                   (name, result.fail_reason, result.output))
1272
    if not self._InstancePidAlive(name)[2]:
1273
      raise errors.HypervisorError("Failed to start instance %s" % name)
1274

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

1278
    @type incoming: tuple of strings
1279
    @param incoming: (target_host_ip, port)
1280

1281
    """
1282
    # Small _ExecuteKVMRuntime hv parameters programming howto:
1283
    #  - conf_hvp contains the parameters as configured on ganeti. they might
1284
    #    have changed since the instance started; only use them if the change
1285
    #    won't affect the inside of the instance (which hasn't been rebooted).
1286
    #  - up_hvp contains the parameters as they were when the instance was
1287
    #    started, plus any new parameter which has been added between ganeti
1288
    #    versions: it is paramount that those default to a value which won't
1289
    #    affect the inside of the instance as well.
1290
    conf_hvp = instance.hvparams
1291
    name = instance.name
1292
    self._CheckDown(name)
1293

    
1294
    temp_files = []
1295

    
1296
    kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1297
    up_hvp = objects.FillDict(conf_hvp, up_hvp)
1298

    
1299
    _, v_major, v_min, _ = self._GetKVMVersion()
1300

    
1301
    # We know it's safe to run as a different user upon migration, so we'll use
1302
    # the latest conf, from conf_hvp.
1303
    security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1304
    if security_model == constants.HT_SM_USER:
1305
      kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1306

    
1307
    # We have reasons to believe changing something like the nic driver/type
1308
    # upon migration won't exactly fly with the instance kernel, so for nic
1309
    # related parameters we'll use up_hvp
1310
    tapfds = []
1311
    taps = []
1312
    if not kvm_nics:
1313
      kvm_cmd.extend(["-net", "none"])
1314
    else:
1315
      vnet_hdr = False
1316
      tap_extra = ""
1317
      nic_type = up_hvp[constants.HV_NIC_TYPE]
1318
      if nic_type == constants.HT_NIC_PARAVIRTUAL:
1319
        # From version 0.12.0, kvm uses a new sintax for network configuration.
1320
        if (v_major, v_min) >= (0, 12):
1321
          nic_model = "virtio-net-pci"
1322
          vnet_hdr = True
1323
        else:
1324
          nic_model = "virtio"
1325

    
1326
        if up_hvp[constants.HV_VHOST_NET]:
1327
          # vhost_net is only available from version 0.13.0 or newer
1328
          if (v_major, v_min) >= (0, 13):
1329
            tap_extra = ",vhost=on"
1330
          else:
1331
            raise errors.HypervisorError("vhost_net is configured"
1332
                                        " but it is not available")
1333
      else:
1334
        nic_model = nic_type
1335

    
1336
      for nic_seq, nic in enumerate(kvm_nics):
1337
        tapname, tapfd = _OpenTap(vnet_hdr)
1338
        tapfds.append(tapfd)
1339
        taps.append(tapname)
1340
        if (v_major, v_min) >= (0, 12):
1341
          nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1342
          tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1343
          kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1344
        else:
1345
          nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1346
                                                         nic.mac, nic_model)
1347
          tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1348
          kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1349

    
1350
    if incoming:
1351
      target, port = incoming
1352
      kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1353

    
1354
    # Changing the vnc password doesn't bother the guest that much. At most it
1355
    # will surprise people who connect to it. Whether positively or negatively
1356
    # it's debatable.
1357
    vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1358
    vnc_pwd = None
1359
    if vnc_pwd_file:
1360
      try:
1361
        vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1362
      except EnvironmentError, err:
1363
        raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1364
                                     % (vnc_pwd_file, err))
1365

    
1366
    if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1367
      utils.EnsureDirs([(self._InstanceChrootDir(name),
1368
                         constants.SECURE_DIR_MODE)])
1369

    
1370
    # Automatically enable QMP if version is >= 0.14
1371
    if (v_major, v_min) >= (0, 14):
1372
      logging.debug("Enabling QMP")
1373
      kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1374
                    self._InstanceQmpMonitor(instance.name)])
1375

    
1376
    # Configure the network now for starting instances and bridged interfaces,
1377
    # during FinalizeMigration for incoming instances' routed interfaces
1378
    for nic_seq, nic in enumerate(kvm_nics):
1379
      if (incoming and
1380
          nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1381
        continue
1382
      self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1383

    
1384
    # CPU affinity requires kvm to start paused, so we set this flag if the
1385
    # instance is not already paused and if we are not going to accept a
1386
    # migrating instance. In the latter case, pausing is not needed.
1387
    start_kvm_paused = not (_KVM_START_PAUSED_FLAG in kvm_cmd) and not incoming
1388

    
1389
    # Note: CPU pinning is using up_hvp since changes take effect
1390
    # during instance startup anyway, and to avoid problems when soft
1391
    # rebooting the instance.
1392
    cpu_pinning = False
1393
    if up_hvp.get(constants.HV_CPU_MASK, None):
1394
      cpu_pinning = True
1395
      if start_kvm_paused:
1396
        kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
1397

    
1398
    if security_model == constants.HT_SM_POOL:
1399
      ss = ssconf.SimpleStore()
1400
      uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1401
      all_uids = set(uidpool.ExpandUidPool(uid_pool))
1402
      uid = uidpool.RequestUnusedUid(all_uids)
1403
      try:
1404
        username = pwd.getpwuid(uid.GetUid()).pw_name
1405
        kvm_cmd.extend(["-runas", username])
1406
        self._RunKVMCmd(name, kvm_cmd, tapfds)
1407
      except:
1408
        uidpool.ReleaseUid(uid)
1409
        raise
1410
      else:
1411
        uid.Unlock()
1412
        utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1413
    else:
1414
      self._RunKVMCmd(name, kvm_cmd, tapfds)
1415

    
1416
    utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1417
                     constants.RUN_DIRS_MODE)])
1418
    for nic_seq, tap in enumerate(taps):
1419
      utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1420
                      data=tap)
1421

    
1422
    if vnc_pwd:
1423
      change_cmd = "change vnc password %s" % vnc_pwd
1424
      self._CallMonitorCommand(instance.name, change_cmd)
1425

    
1426
    # Setting SPICE password. We are not vulnerable to malicious passwordless
1427
    # connection attempts because SPICE by default does not allow connections
1428
    # if neither a password nor the "disable_ticketing" options are specified.
1429
    # As soon as we send the password via QMP, that password is a valid ticket
1430
    # for connection.
1431
    spice_password_file = conf_hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]
1432
    if spice_password_file:
1433
      try:
1434
        spice_pwd = utils.ReadOneLineFile(spice_password_file, strict=True)
1435
        qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1436
        qmp.connect()
1437
        arguments = {
1438
            "protocol": "spice",
1439
            "password": spice_pwd,
1440
        }
1441
        qmp.Execute("set_password", arguments)
1442
      except EnvironmentError, err:
1443
        raise errors.HypervisorError("Failed to open SPICE password file %s: %s"
1444
                                     % (spice_password_file, err))
1445

    
1446
    for filename in temp_files:
1447
      utils.RemoveFile(filename)
1448

    
1449
    # If requested, set CPU affinity and resume instance execution
1450
    if cpu_pinning:
1451
      try:
1452
        self._ExecuteCpuAffinity(instance.name, up_hvp[constants.HV_CPU_MASK])
1453
      finally:
1454
        if start_kvm_paused:
1455
          # To control CPU pinning, the VM was started frozen, so we need
1456
          # to resume its execution, but only if freezing was not
1457
          # explicitly requested.
1458
          # Note: this is done even when an exception occurred so the VM
1459
          # is not unintentionally frozen.
1460
          self._CallMonitorCommand(instance.name, self._CONT_CMD)
1461

    
1462
  def StartInstance(self, instance, block_devices, startup_paused):
1463
    """Start an instance.
1464

1465
    """
1466
    self._CheckDown(instance.name)
1467
    kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1468
                                           startup_paused)
1469
    self._SaveKVMRuntime(instance, kvm_runtime)
1470
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1471

    
1472
  def _CallMonitorCommand(self, instance_name, command):
1473
    """Invoke a command on the instance monitor.
1474

1475
    """
1476
    socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1477
             (utils.ShellQuote(command),
1478
              constants.SOCAT_PATH,
1479
              utils.ShellQuote(self._InstanceMonitor(instance_name))))
1480
    result = utils.RunCmd(socat)
1481
    if result.failed:
1482
      msg = ("Failed to send command '%s' to instance %s."
1483
             " output: %s, error: %s, fail_reason: %s" %
1484
             (command, instance_name,
1485
              result.stdout, result.stderr, result.fail_reason))
1486
      raise errors.HypervisorError(msg)
1487

    
1488
    return result
1489

    
1490
  @classmethod
1491
  def _GetKVMVersion(cls):
1492
    """Return the installed KVM version.
1493

1494
    @return: (version, v_maj, v_min, v_rev)
1495
    @raise L{errors.HypervisorError}: when the KVM version cannot be retrieved
1496

1497
    """
1498
    result = utils.RunCmd([constants.KVM_PATH, "--help"])
1499
    if result.failed:
1500
      raise errors.HypervisorError("Unable to get KVM version")
1501
    match = cls._VERSION_RE.search(result.output.splitlines()[0])
1502
    if not match:
1503
      raise errors.HypervisorError("Unable to get KVM version")
1504

    
1505
    return (match.group(0), int(match.group(1)), int(match.group(2)),
1506
            int(match.group(3)))
1507

    
1508
  def StopInstance(self, instance, force=False, retry=False, name=None):
1509
    """Stop an instance.
1510

1511
    """
1512
    if name is not None and not force:
1513
      raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1514
    if name is None:
1515
      name = instance.name
1516
      acpi = instance.hvparams[constants.HV_ACPI]
1517
    else:
1518
      acpi = False
1519
    _, pid, alive = self._InstancePidAlive(name)
1520
    if pid > 0 and alive:
1521
      if force or not acpi:
1522
        utils.KillProcess(pid)
1523
      else:
1524
        self._CallMonitorCommand(name, "system_powerdown")
1525

    
1526
  def CleanupInstance(self, instance_name):
1527
    """Cleanup after a stopped instance
1528

1529
    """
1530
    pidfile, pid, alive = self._InstancePidAlive(instance_name)
1531
    if pid > 0 and alive:
1532
      raise errors.HypervisorError("Cannot cleanup a live instance")
1533
    self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1534

    
1535
  def RebootInstance(self, instance):
1536
    """Reboot an instance.
1537

1538
    """
1539
    # For some reason if we do a 'send-key ctrl-alt-delete' to the control
1540
    # socket the instance will stop, but now power up again. So we'll resort
1541
    # to shutdown and restart.
1542
    _, _, alive = self._InstancePidAlive(instance.name)
1543
    if not alive:
1544
      raise errors.HypervisorError("Failed to reboot instance %s:"
1545
                                   " not running" % instance.name)
1546
    # StopInstance will delete the saved KVM runtime so:
1547
    # ...first load it...
1548
    kvm_runtime = self._LoadKVMRuntime(instance)
1549
    # ...now we can safely call StopInstance...
1550
    if not self.StopInstance(instance):
1551
      self.StopInstance(instance, force=True)
1552
    # ...and finally we can save it again, and execute it...
1553
    self._SaveKVMRuntime(instance, kvm_runtime)
1554
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1555

    
1556
  def MigrationInfo(self, instance):
1557
    """Get instance information to perform a migration.
1558

1559
    @type instance: L{objects.Instance}
1560
    @param instance: instance to be migrated
1561
    @rtype: string
1562
    @return: content of the KVM runtime file
1563

1564
    """
1565
    return self._ReadKVMRuntime(instance.name)
1566

    
1567
  def AcceptInstance(self, instance, info, target):
1568
    """Prepare to accept an instance.
1569

1570
    @type instance: L{objects.Instance}
1571
    @param instance: instance to be accepted
1572
    @type info: string
1573
    @param info: content of the KVM runtime file on the source node
1574
    @type target: string
1575
    @param target: target host (usually ip), on this node
1576

1577
    """
1578
    kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1579
    incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1580
    self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1581

    
1582
  def FinalizeMigrationDst(self, instance, info, success):
1583
    """Finalize the instance migration on the target node.
1584

1585
    Stop the incoming mode KVM.
1586

1587
    @type instance: L{objects.Instance}
1588
    @param instance: instance whose migration is being finalized
1589

1590
    """
1591
    if success:
1592
      kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1593
      kvm_nics = kvm_runtime[1]
1594

    
1595
      for nic_seq, nic in enumerate(kvm_nics):
1596
        if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1597
          # Bridged interfaces have already been configured
1598
          continue
1599
        try:
1600
          tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1601
        except EnvironmentError, err:
1602
          logging.warning("Failed to find host interface for %s NIC #%d: %s",
1603
                          instance.name, nic_seq, str(err))
1604
          continue
1605
        try:
1606
          self._ConfigureNIC(instance, nic_seq, nic, tap)
1607
        except errors.HypervisorError, err:
1608
          logging.warning(str(err))
1609

    
1610
      self._WriteKVMRuntime(instance.name, info)
1611
    else:
1612
      self.StopInstance(instance, force=True)
1613

    
1614
  def MigrateInstance(self, instance, target, live):
1615
    """Migrate an instance to a target node.
1616

1617
    The migration will not be attempted if the instance is not
1618
    currently running.
1619

1620
    @type instance: L{objects.Instance}
1621
    @param instance: the instance to be migrated
1622
    @type target: string
1623
    @param target: ip address of the target node
1624
    @type live: boolean
1625
    @param live: perform a live migration
1626

1627
    """
1628
    instance_name = instance.name
1629
    port = instance.hvparams[constants.HV_MIGRATION_PORT]
1630
    _, _, alive = self._InstancePidAlive(instance_name)
1631
    if not alive:
1632
      raise errors.HypervisorError("Instance not running, cannot migrate")
1633

    
1634
    if not live:
1635
      self._CallMonitorCommand(instance_name, "stop")
1636

    
1637
    migrate_command = ("migrate_set_speed %dm" %
1638
        instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1639
    self._CallMonitorCommand(instance_name, migrate_command)
1640

    
1641
    migrate_command = ("migrate_set_downtime %dms" %
1642
        instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1643
    self._CallMonitorCommand(instance_name, migrate_command)
1644

    
1645
    migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1646
    self._CallMonitorCommand(instance_name, migrate_command)
1647

    
1648
  def FinalizeMigrationSource(self, instance, success, live):
1649
    """Finalize the instance migration on the source node.
1650

1651
    @type instance: L{objects.Instance}
1652
    @param instance: the instance that was migrated
1653
    @type success: bool
1654
    @param success: whether the migration succeeded or not
1655
    @type live: bool
1656
    @param live: whether the user requested a live migration or not
1657

1658
    """
1659
    if success:
1660
      pidfile, pid, _ = self._InstancePidAlive(instance.name)
1661
      utils.KillProcess(pid)
1662
      self._RemoveInstanceRuntimeFiles(pidfile, instance.name)
1663
    elif live:
1664
      self._CallMonitorCommand(instance.name, self._CONT_CMD)
1665

    
1666
  def GetMigrationStatus(self, instance):
1667
    """Get the migration status
1668

1669
    @type instance: L{objects.Instance}
1670
    @param instance: the instance that is being migrated
1671
    @rtype: L{objects.MigrationStatus}
1672
    @return: the status of the current migration (one of
1673
             L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1674
             progress info that can be retrieved from the hypervisor
1675

1676
    """
1677
    info_command = "info migrate"
1678
    for _ in range(self._MIGRATION_INFO_MAX_BAD_ANSWERS):
1679
      result = self._CallMonitorCommand(instance.name, info_command)
1680
      match = self._MIGRATION_STATUS_RE.search(result.stdout)
1681
      if not match:
1682
        if not result.stdout:
1683
          logging.info("KVM: empty 'info migrate' result")
1684
        else:
1685
          logging.warning("KVM: unknown 'info migrate' result: %s",
1686
                          result.stdout)
1687
      else:
1688
        status = match.group(1)
1689
        if status in constants.HV_KVM_MIGRATION_VALID_STATUSES:
1690
          migration_status = objects.MigrationStatus(status=status)
1691
          match = self._MIGRATION_PROGRESS_RE.search(result.stdout)
1692
          if match:
1693
            migration_status.transferred_ram = match.group("transferred")
1694
            migration_status.total_ram = match.group("total")
1695

    
1696
          return migration_status
1697

    
1698
        logging.warning("KVM: unknown migration status '%s'", status)
1699

    
1700
      time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1701

    
1702
    return objects.MigrationStatus(status=constants.HV_MIGRATION_FAILED,
1703
                                  info="Too many 'info migrate' broken answers")
1704

    
1705
  def GetNodeInfo(self):
1706
    """Return information about the node.
1707

1708
    This is just a wrapper over the base GetLinuxNodeInfo method.
1709

1710
    @return: a dict with the following keys (values in MiB):
1711
          - memory_total: the total memory size on the node
1712
          - memory_free: the available memory on the node for instances
1713
          - memory_dom0: the memory used by the node itself, if available
1714

1715
    """
1716
    return self.GetLinuxNodeInfo()
1717

    
1718
  @classmethod
1719
  def GetInstanceConsole(cls, instance, hvparams, beparams):
1720
    """Return a command for connecting to the console of an instance.
1721

1722
    """
1723
    if hvparams[constants.HV_SERIAL_CONSOLE]:
1724
      cmd = [constants.KVM_CONSOLE_WRAPPER,
1725
             constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1726
             utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1727
             "STDIO,%s" % cls._SocatUnixConsoleParams(),
1728
             "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1729
      return objects.InstanceConsole(instance=instance.name,
1730
                                     kind=constants.CONS_SSH,
1731
                                     host=instance.primary_node,
1732
                                     user=constants.GANETI_RUNAS,
1733
                                     command=cmd)
1734

    
1735
    vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1736
    if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1737
      display = instance.network_port - constants.VNC_BASE_PORT
1738
      return objects.InstanceConsole(instance=instance.name,
1739
                                     kind=constants.CONS_VNC,
1740
                                     host=vnc_bind_address,
1741
                                     port=instance.network_port,
1742
                                     display=display)
1743

    
1744
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1745
    if spice_bind:
1746
      return objects.InstanceConsole(instance=instance.name,
1747
                                     kind=constants.CONS_SPICE,
1748
                                     host=spice_bind,
1749
                                     port=instance.network_port)
1750

    
1751
    return objects.InstanceConsole(instance=instance.name,
1752
                                   kind=constants.CONS_MESSAGE,
1753
                                   message=("No serial shell for instance %s" %
1754
                                            instance.name))
1755

    
1756
  def Verify(self):
1757
    """Verify the hypervisor.
1758

1759
    Check that the binary exists.
1760

1761
    """
1762
    if not os.path.exists(constants.KVM_PATH):
1763
      return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1764
    if not os.path.exists(constants.SOCAT_PATH):
1765
      return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1766

    
1767
  @classmethod
1768
  def CheckParameterSyntax(cls, hvparams):
1769
    """Check the given parameters for validity.
1770

1771
    @type hvparams:  dict
1772
    @param hvparams: dictionary with parameter names/value
1773
    @raise errors.HypervisorError: when a parameter is not valid
1774

1775
    """
1776
    super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1777

    
1778
    kernel_path = hvparams[constants.HV_KERNEL_PATH]
1779
    if kernel_path:
1780
      if not hvparams[constants.HV_ROOT_PATH]:
1781
        raise errors.HypervisorError("Need a root partition for the instance,"
1782
                                     " if a kernel is defined")
1783

    
1784
    if (hvparams[constants.HV_VNC_X509_VERIFY] and
1785
        not hvparams[constants.HV_VNC_X509]):
1786
      raise errors.HypervisorError("%s must be defined, if %s is" %
1787
                                   (constants.HV_VNC_X509,
1788
                                    constants.HV_VNC_X509_VERIFY))
1789

    
1790
    boot_order = hvparams[constants.HV_BOOT_ORDER]
1791
    if (boot_order == constants.HT_BO_CDROM and
1792
        not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1793
      raise errors.HypervisorError("Cannot boot from cdrom without an"
1794
                                   " ISO path")
1795

    
1796
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1797
    if security_model == constants.HT_SM_USER:
1798
      if not hvparams[constants.HV_SECURITY_DOMAIN]:
1799
        raise errors.HypervisorError("A security domain (user to run kvm as)"
1800
                                     " must be specified")
1801
    elif (security_model == constants.HT_SM_NONE or
1802
          security_model == constants.HT_SM_POOL):
1803
      if hvparams[constants.HV_SECURITY_DOMAIN]:
1804
        raise errors.HypervisorError("Cannot have a security domain when the"
1805
                                     " security model is 'none' or 'pool'")
1806

    
1807
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1808
    spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1809
    if spice_bind:
1810
      if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1811
        # if an IP version is specified, the spice_bind parameter must be an
1812
        # IP of that family
1813
        if (netutils.IP4Address.IsValid(spice_bind) and
1814
            spice_ip_version != constants.IP4_VERSION):
1815
          raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1816
                                       " the specified IP version is %s" %
1817
                                       (spice_bind, spice_ip_version))
1818

    
1819
        if (netutils.IP6Address.IsValid(spice_bind) and
1820
            spice_ip_version != constants.IP6_VERSION):
1821
          raise errors.HypervisorError("spice: got an IPv6 address (%s), but"
1822
                                       " the specified IP version is %s" %
1823
                                       (spice_bind, spice_ip_version))
1824
    else:
1825
      # All the other SPICE parameters depend on spice_bind being set. Raise an
1826
      # error if any of them is set without it.
1827
      spice_additional_params = frozenset([
1828
        constants.HV_KVM_SPICE_IP_VERSION,
1829
        constants.HV_KVM_SPICE_PASSWORD_FILE,
1830
        constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR,
1831
        constants.HV_KVM_SPICE_JPEG_IMG_COMPR,
1832
        constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR,
1833
        constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION,
1834
        constants.HV_KVM_SPICE_USE_TLS,
1835
        ])
1836
      for param in spice_additional_params:
1837
        if hvparams[param]:
1838
          raise errors.HypervisorError("spice: %s requires %s to be set" %
1839
                                       (param, constants.HV_KVM_SPICE_BIND))
1840

    
1841
  @classmethod
1842
  def ValidateParameters(cls, hvparams):
1843
    """Check the given parameters for validity.
1844

1845
    @type hvparams:  dict
1846
    @param hvparams: dictionary with parameter names/value
1847
    @raise errors.HypervisorError: when a parameter is not valid
1848

1849
    """
1850
    super(KVMHypervisor, cls).ValidateParameters(hvparams)
1851

    
1852
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1853
    if security_model == constants.HT_SM_USER:
1854
      username = hvparams[constants.HV_SECURITY_DOMAIN]
1855
      try:
1856
        pwd.getpwnam(username)
1857
      except KeyError:
1858
        raise errors.HypervisorError("Unknown security domain user %s"
1859
                                     % username)
1860

    
1861
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1862
    if spice_bind:
1863
      # only one of VNC and SPICE can be used currently.
1864
      if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1865
        raise errors.HypervisorError("both SPICE and VNC are configured, but"
1866
                                     " only one of them can be used at a"
1867
                                     " given time.")
1868

    
1869
      # KVM version should be >= 0.14.0
1870
      _, v_major, v_min, _ = cls._GetKVMVersion()
1871
      if (v_major, v_min) < (0, 14):
1872
        raise errors.HypervisorError("spice is configured, but it is not"
1873
                                     " available in versions of KVM < 0.14")
1874

    
1875
      # if spice_bind is not an IP address, it must be a valid interface
1876
      bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1877
                       or netutils.IP6Address.IsValid(spice_bind))
1878
      if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1879
        raise errors.HypervisorError("spice: the %s parameter must be either"
1880
                                     " a valid IP address or interface name" %
1881
                                     constants.HV_KVM_SPICE_BIND)
1882

    
1883
  @classmethod
1884
  def PowercycleNode(cls):
1885
    """KVM powercycle, just a wrapper over Linux powercycle.
1886

1887
    """
1888
    cls.LinuxPowercycle()