Statistics
| Branch: | Tag: | Revision:

root / lib / hypervisor / hv_kvm.py @ 21670917

History | View | Annotate | Download (71.5 kB)

1
#
2
#
3

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

    
21

    
22
"""KVM hypervisor
23

24
"""
25

    
26
import errno
27
import os
28
import os.path
29
import re
30
import tempfile
31
import time
32
import logging
33
import pwd
34
import struct
35
import fcntl
36
import shutil
37
import socket
38
import stat
39
import StringIO
40
try:
41
  import affinity   # pylint: disable=F0401
42
except ImportError:
43
  affinity = None
44

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

    
56

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

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

    
70

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

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

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

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

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

    
102

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

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

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

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

    
120
  flags = IFF_TAP | IFF_NO_PI
121

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

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

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

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

    
137

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

141
  """
142
  def __init__(self, data):
143
    """Creates a new QMP message based on the passed data.
144

145
    """
146
    if not isinstance(data, dict):
147
      raise TypeError("QmpMessage must be initialized with a dict")
148

    
149
    self.data = data
150

    
151
  def __getitem__(self, field_name):
152
    """Get the value of the required field if present, or None.
153

154
    Overrides the [] operator to provide access to the message data,
155
    returning None if the required item is not in the message
156
    @return: the value of the field_name field, or None if field_name
157
             is not contained in the message
158

159
    """
160
    return self.data.get(field_name, None)
161

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

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

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

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

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

    
182
  def __str__(self):
183
    # The protocol expects the JSON object to be sent as a single line.
184
    return serializer.DumpJson(self.data)
185

    
186
  def __eq__(self, other):
187
    # When comparing two QmpMessages, we are interested in comparing
188
    # their internal representation of the message data
189
    return self.data == other.data
190

    
191

    
192
class QmpConnection:
193
  """Connection to the QEMU Monitor using the QEMU Monitor Protocol (QMP).
194

195
  """
196
  _FIRST_MESSAGE_KEY = "QMP"
197
  _EVENT_KEY = "event"
198
  _ERROR_KEY = "error"
199
  _RETURN_KEY = RETURN_KEY = "return"
200
  _ACTUAL_KEY = ACTUAL_KEY = "actual"
201
  _ERROR_CLASS_KEY = "class"
202
  _ERROR_DATA_KEY = "data"
203
  _ERROR_DESC_KEY = "desc"
204
  _EXECUTE_KEY = "execute"
205
  _ARGUMENTS_KEY = "arguments"
206
  _CAPABILITIES_COMMAND = "qmp_capabilities"
207
  _MESSAGE_END_TOKEN = "\r\n"
208
  _SOCKET_TIMEOUT = 5
209

    
210
  def __init__(self, monitor_filename):
211
    """Instantiates the QmpConnection object.
212

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

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

    
226
  def _check_socket(self):
227
    sock_stat = None
228
    try:
229
      sock_stat = os.stat(self.monitor_filename)
230
    except EnvironmentError, err:
231
      if err.errno == errno.ENOENT:
232
        raise errors.HypervisorError("No qmp socket found")
233
      else:
234
        raise errors.HypervisorError("Error checking qmp socket: %s",
235
                                     utils.ErrnoOrStr(err))
236
    if not stat.S_ISSOCK(sock_stat.st_mode):
237
      raise errors.HypervisorError("Qmp socket is not a socket")
238

    
239
  def _check_connection(self):
240
    """Make sure that the connection is established.
241

242
    """
243
    if not self._connected:
244
      raise errors.ProgrammerError("To use a QmpConnection you need to first"
245
                                   " invoke connect() on it")
246

    
247
  def connect(self):
248
    """Connects to the QMP monitor.
249

250
    Connects to the UNIX socket and makes sure that we can actually send and
251
    receive data to the kvm instance via QMP.
252

253
    @raise errors.HypervisorError: when there are communication errors
254
    @raise errors.ProgrammerError: when there are data serialization errors
255

256
    """
257
    if self._connected:
258
      raise errors.ProgrammerError("Cannot connect twice")
259

    
260
    self._check_socket()
261

    
262
    # Check file existance/stuff
263
    try:
264
      self.sock.connect(self.monitor_filename)
265
    except EnvironmentError:
266
      raise errors.HypervisorError("Can't connect to qmp socket")
267
    self._connected = True
268

    
269
    # Check if we receive a correct greeting message from the server
270
    # (As per the QEMU Protocol Specification 0.1 - section 2.2)
271
    greeting = self._Recv()
272
    if not greeting[self._FIRST_MESSAGE_KEY]:
273
      self._connected = False
274
      raise errors.HypervisorError("kvm: qmp communication error (wrong"
275
                                   " server greeting")
276

    
277
    # Let's put the monitor in command mode using the qmp_capabilities
278
    # command, or else no command will be executable.
279
    # (As per the QEMU Protocol Specification 0.1 - section 4)
280
    self.Execute(self._CAPABILITIES_COMMAND)
281

    
282
  def _ParseMessage(self, buf):
283
    """Extract and parse a QMP message from the given buffer.
284

285
    Seeks for a QMP message in the given buf. If found, it parses it and
286
    returns it together with the rest of the characters in the buf.
287
    If no message is found, returns None and the whole buffer.
288

289
    @raise errors.ProgrammerError: when there are data serialization errors
290

291
    """
292
    message = None
293
    # Check if we got the message end token (CRLF, as per the QEMU Protocol
294
    # Specification 0.1 - Section 2.1.1)
295
    pos = buf.find(self._MESSAGE_END_TOKEN)
296
    if pos >= 0:
297
      try:
298
        message = QmpMessage.BuildFromJsonString(buf[:pos + 1])
299
      except Exception, err:
300
        raise errors.ProgrammerError("QMP data serialization error: %s" % err)
301
      buf = buf[pos + 1:]
302

    
303
    return (message, buf)
304

    
305
  def _Recv(self):
306
    """Receives a message from QMP and decodes the received JSON object.
307

308
    @rtype: QmpMessage
309
    @return: the received message
310
    @raise errors.HypervisorError: when there are communication errors
311
    @raise errors.ProgrammerError: when there are data serialization errors
312

313
    """
314
    self._check_connection()
315

    
316
    # Check if there is already a message in the buffer
317
    (message, self._buf) = self._ParseMessage(self._buf)
318
    if message:
319
      return message
320

    
321
    recv_buffer = StringIO.StringIO(self._buf)
322
    recv_buffer.seek(len(self._buf))
323
    try:
324
      while True:
325
        data = self.sock.recv(4096)
326
        if not data:
327
          break
328
        recv_buffer.write(data)
329

    
330
        (message, self._buf) = self._ParseMessage(recv_buffer.getvalue())
331
        if message:
332
          return message
333

    
334
    except socket.timeout, err:
335
      raise errors.HypervisorError("Timeout while receiving a QMP message: "
336
                                   "%s" % (err))
337
    except socket.error, err:
338
      raise errors.HypervisorError("Unable to receive data from KVM using the"
339
                                   " QMP protocol: %s" % err)
340

    
341
  def _Send(self, message):
342
    """Encodes and sends a message to KVM using QMP.
343

344
    @type message: QmpMessage
345
    @param message: message to send to KVM
346
    @raise errors.HypervisorError: when there are communication errors
347
    @raise errors.ProgrammerError: when there are data serialization errors
348

349
    """
350
    self._check_connection()
351
    try:
352
      message_str = str(message)
353
    except Exception, err:
354
      raise errors.ProgrammerError("QMP data deserialization error: %s" % err)
355

    
356
    try:
357
      self.sock.sendall(message_str)
358
    except socket.timeout, err:
359
      raise errors.HypervisorError("Timeout while sending a QMP message: "
360
                                   "%s (%s)" % (err.string, err.errno))
361
    except socket.error, err:
362
      raise errors.HypervisorError("Unable to send data from KVM using the"
363
                                   " QMP protocol: %s" % err)
364

    
365
  def Execute(self, command, arguments=None):
366
    """Executes a QMP command and returns the response of the server.
367

368
    @type command: str
369
    @param command: the command to execute
370
    @type arguments: dict
371
    @param arguments: dictionary of arguments to be passed to the command
372
    @rtype: dict
373
    @return: dictionary representing the received JSON object
374
    @raise errors.HypervisorError: when there are communication errors
375
    @raise errors.ProgrammerError: when there are data serialization errors
376

377
    """
378
    self._check_connection()
379
    message = QmpMessage({self._EXECUTE_KEY: command})
380
    if arguments:
381
      message[self._ARGUMENTS_KEY] = arguments
382
    self._Send(message)
383

    
384
    # Events can occur between the sending of the command and the reception
385
    # of the response, so we need to filter out messages with the event key.
386
    while True:
387
      response = self._Recv()
388
      err = response[self._ERROR_KEY]
389
      if err:
390
        raise errors.HypervisorError("kvm: error executing the %s"
391
                                     " command: %s (%s, %s):" %
392
                                     (command,
393
                                      err[self._ERROR_DESC_KEY],
394
                                      err[self._ERROR_CLASS_KEY],
395
                                      err[self._ERROR_DATA_KEY]))
396

    
397
      elif not response[self._EVENT_KEY]:
398
        return response
399

    
400

    
401
class KVMHypervisor(hv_base.BaseHypervisor):
402
  """KVM hypervisor interface
403

404
  """
405
  CAN_MIGRATE = True
406

    
407
  _ROOT_DIR = constants.RUN_GANETI_DIR + "/kvm-hypervisor"
408
  _PIDS_DIR = _ROOT_DIR + "/pid" # contains live instances pids
409
  _UIDS_DIR = _ROOT_DIR + "/uid" # contains instances reserved uids
410
  _CTRL_DIR = _ROOT_DIR + "/ctrl" # contains instances control sockets
411
  _CONF_DIR = _ROOT_DIR + "/conf" # contains instances startup data
412
  _NICS_DIR = _ROOT_DIR + "/nic" # contains instances nic <-> tap associations
413
  _KEYMAP_DIR = _ROOT_DIR + "/keymap" # contains instances keymaps
414
  # KVM instances with chroot enabled are started in empty chroot directories.
415
  _CHROOT_DIR = _ROOT_DIR + "/chroot" # for empty chroot directories
416
  # After an instance is stopped, its chroot directory is removed.
417
  # If the chroot directory is not empty, it can't be removed.
418
  # A non-empty chroot directory indicates a possible security incident.
419
  # To support forensics, the non-empty chroot directory is quarantined in
420
  # a separate directory, called 'chroot-quarantine'.
421
  _CHROOT_QUARANTINE_DIR = _ROOT_DIR + "/chroot-quarantine"
422
  _DIRS = [_ROOT_DIR, _PIDS_DIR, _UIDS_DIR, _CTRL_DIR, _CONF_DIR, _NICS_DIR,
423
           _CHROOT_DIR, _CHROOT_QUARANTINE_DIR, _KEYMAP_DIR]
424

    
425
  PARAMETERS = {
426
    constants.HV_KERNEL_PATH: hv_base.OPT_FILE_CHECK,
427
    constants.HV_INITRD_PATH: hv_base.OPT_FILE_CHECK,
428
    constants.HV_ROOT_PATH: hv_base.NO_CHECK,
429
    constants.HV_KERNEL_ARGS: hv_base.NO_CHECK,
430
    constants.HV_ACPI: hv_base.NO_CHECK,
431
    constants.HV_SERIAL_CONSOLE: hv_base.NO_CHECK,
432
    constants.HV_VNC_BIND_ADDRESS:
433
      (False, lambda x: (netutils.IP4Address.IsValid(x) or
434
                         utils.IsNormAbsPath(x)),
435
       "the VNC bind address must be either a valid IP address or an absolute"
436
       " pathname", None, None),
437
    constants.HV_VNC_TLS: hv_base.NO_CHECK,
438
    constants.HV_VNC_X509: hv_base.OPT_DIR_CHECK,
439
    constants.HV_VNC_X509_VERIFY: hv_base.NO_CHECK,
440
    constants.HV_VNC_PASSWORD_FILE: hv_base.OPT_FILE_CHECK,
441
    constants.HV_KVM_SPICE_BIND: hv_base.NO_CHECK, # will be checked later
442
    constants.HV_KVM_SPICE_IP_VERSION:
443
      (False, lambda x: (x == constants.IFACE_NO_IP_VERSION_SPECIFIED or
444
                         x in constants.VALID_IP_VERSIONS),
445
       "the SPICE IP version should be 4 or 6",
446
       None, None),
447
    constants.HV_KVM_SPICE_PASSWORD_FILE: hv_base.OPT_FILE_CHECK,
448
    constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR:
449
      hv_base.ParamInSet(False,
450
        constants.HT_KVM_SPICE_VALID_LOSSLESS_IMG_COMPR_OPTIONS),
451
    constants.HV_KVM_SPICE_JPEG_IMG_COMPR:
452
      hv_base.ParamInSet(False,
453
        constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
454
    constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR:
455
      hv_base.ParamInSet(False,
456
        constants.HT_KVM_SPICE_VALID_LOSSY_IMG_COMPR_OPTIONS),
457
    constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION:
458
      hv_base.ParamInSet(False,
459
        constants.HT_KVM_SPICE_VALID_VIDEO_STREAM_DETECTION_OPTIONS),
460
    constants.HV_KVM_SPICE_AUDIO_COMPR: hv_base.NO_CHECK,
461
    constants.HV_KVM_SPICE_USE_TLS: hv_base.NO_CHECK,
462
    constants.HV_KVM_SPICE_TLS_CIPHERS: hv_base.NO_CHECK,
463
    constants.HV_KVM_SPICE_USE_VDAGENT: hv_base.NO_CHECK,
464
    constants.HV_KVM_FLOPPY_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
465
    constants.HV_CDROM_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
466
    constants.HV_KVM_CDROM2_IMAGE_PATH: hv_base.OPT_FILE_CHECK,
467
    constants.HV_BOOT_ORDER:
468
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_BO_TYPES),
469
    constants.HV_NIC_TYPE:
470
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_NIC_TYPES),
471
    constants.HV_DISK_TYPE:
472
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_DISK_TYPES),
473
    constants.HV_KVM_CDROM_DISK_TYPE:
474
      hv_base.ParamInSet(False, constants.HT_KVM_VALID_DISK_TYPES),
475
    constants.HV_USB_MOUSE:
476
      hv_base.ParamInSet(False, constants.HT_KVM_VALID_MOUSE_TYPES),
477
    constants.HV_KEYMAP: hv_base.NO_CHECK,
478
    constants.HV_MIGRATION_PORT: hv_base.REQ_NET_PORT_CHECK,
479
    constants.HV_MIGRATION_BANDWIDTH: hv_base.NO_CHECK,
480
    constants.HV_MIGRATION_DOWNTIME: hv_base.NO_CHECK,
481
    constants.HV_MIGRATION_MODE: hv_base.MIGRATION_MODE_CHECK,
482
    constants.HV_USE_LOCALTIME: hv_base.NO_CHECK,
483
    constants.HV_DISK_CACHE:
484
      hv_base.ParamInSet(True, constants.HT_VALID_CACHE_TYPES),
485
    constants.HV_SECURITY_MODEL:
486
      hv_base.ParamInSet(True, constants.HT_KVM_VALID_SM_TYPES),
487
    constants.HV_SECURITY_DOMAIN: hv_base.NO_CHECK,
488
    constants.HV_KVM_FLAG:
489
      hv_base.ParamInSet(False, constants.HT_KVM_FLAG_VALUES),
490
    constants.HV_VHOST_NET: hv_base.NO_CHECK,
491
    constants.HV_KVM_USE_CHROOT: hv_base.NO_CHECK,
492
    constants.HV_MEM_PATH: hv_base.OPT_DIR_CHECK,
493
    constants.HV_REBOOT_BEHAVIOR:
494
      hv_base.ParamInSet(True, constants.REBOOT_BEHAVIORS),
495
    constants.HV_CPU_MASK: hv_base.OPT_MULTI_CPU_MASK_CHECK,
496
    }
497

    
498
  _MIGRATION_STATUS_RE = re.compile("Migration\s+status:\s+(\w+)",
499
                                    re.M | re.I)
500
  _MIGRATION_PROGRESS_RE = \
501
    re.compile(r"\s*transferred\s+ram:\s+(?P<transferred>\d+)\s+kbytes\s*\n"
502
               r"\s*remaining\s+ram:\s+(?P<remaining>\d+)\s+kbytes\s*\n"
503
               r"\s*total\s+ram:\s+(?P<total>\d+)\s+kbytes\s*\n", re.I)
504

    
505
  _MIGRATION_INFO_MAX_BAD_ANSWERS = 5
506
  _MIGRATION_INFO_RETRY_DELAY = 2
507

    
508
  _VERSION_RE = re.compile(r"\b(\d+)\.(\d+)(\.(\d+))?\b")
509

    
510
  _CPU_INFO_RE = re.compile(r"cpu\s+\#(\d+).*thread_id\s*=\s*(\d+)", re.I)
511
  _CPU_INFO_CMD = "info cpus"
512
  _CONT_CMD = "cont"
513

    
514
  ANCILLARY_FILES = [
515
    _KVM_NETWORK_SCRIPT,
516
    ]
517
  ANCILLARY_FILES_OPT = [
518
    _KVM_NETWORK_SCRIPT,
519
    ]
520

    
521
  def __init__(self):
522
    hv_base.BaseHypervisor.__init__(self)
523
    # Let's make sure the directories we need exist, even if the RUN_DIR lives
524
    # in a tmpfs filesystem or has been otherwise wiped out.
525
    dirs = [(dname, constants.RUN_DIRS_MODE) for dname in self._DIRS]
526
    utils.EnsureDirs(dirs)
527

    
528
  @classmethod
529
  def _InstancePidFile(cls, instance_name):
530
    """Returns the instance pidfile.
531

532
    """
533
    return utils.PathJoin(cls._PIDS_DIR, instance_name)
534

    
535
  @classmethod
536
  def _InstanceUidFile(cls, instance_name):
537
    """Returns the instance uidfile.
538

539
    """
540
    return utils.PathJoin(cls._UIDS_DIR, instance_name)
541

    
542
  @classmethod
543
  def _InstancePidInfo(cls, pid):
544
    """Check pid file for instance information.
545

546
    Check that a pid file is associated with an instance, and retrieve
547
    information from its command line.
548

549
    @type pid: string or int
550
    @param pid: process id of the instance to check
551
    @rtype: tuple
552
    @return: (instance_name, memory, vcpus)
553
    @raise errors.HypervisorError: when an instance cannot be found
554

555
    """
556
    alive = utils.IsProcessAlive(pid)
557
    if not alive:
558
      raise errors.HypervisorError("Cannot get info for pid %s" % pid)
559

    
560
    cmdline_file = utils.PathJoin("/proc", str(pid), "cmdline")
561
    try:
562
      cmdline = utils.ReadFile(cmdline_file)
563
    except EnvironmentError, err:
564
      raise errors.HypervisorError("Can't open cmdline file for pid %s: %s" %
565
                                   (pid, err))
566

    
567
    instance = None
568
    memory = 0
569
    vcpus = 0
570

    
571
    arg_list = cmdline.split("\x00")
572
    while arg_list:
573
      arg = arg_list.pop(0)
574
      if arg == "-name":
575
        instance = arg_list.pop(0)
576
      elif arg == "-m":
577
        memory = int(arg_list.pop(0))
578
      elif arg == "-smp":
579
        vcpus = int(arg_list.pop(0))
580

    
581
    if instance is None:
582
      raise errors.HypervisorError("Pid %s doesn't contain a ganeti kvm"
583
                                   " instance" % pid)
584

    
585
    return (instance, memory, vcpus)
586

    
587
  def _InstancePidAlive(self, instance_name):
588
    """Returns the instance pidfile, pid, and liveness.
589

590
    @type instance_name: string
591
    @param instance_name: instance name
592
    @rtype: tuple
593
    @return: (pid file name, pid, liveness)
594

595
    """
596
    pidfile = self._InstancePidFile(instance_name)
597
    pid = utils.ReadPidFile(pidfile)
598

    
599
    alive = False
600
    try:
601
      cmd_instance = self._InstancePidInfo(pid)[0]
602
      alive = (cmd_instance == instance_name)
603
    except errors.HypervisorError:
604
      pass
605

    
606
    return (pidfile, pid, alive)
607

    
608
  def _CheckDown(self, instance_name):
609
    """Raises an error unless the given instance is down.
610

611
    """
612
    alive = self._InstancePidAlive(instance_name)[2]
613
    if alive:
614
      raise errors.HypervisorError("Failed to start instance %s: %s" %
615
                                   (instance_name, "already running"))
616

    
617
  @classmethod
618
  def _InstanceMonitor(cls, instance_name):
619
    """Returns the instance monitor socket name
620

621
    """
622
    return utils.PathJoin(cls._CTRL_DIR, "%s.monitor" % instance_name)
623

    
624
  @classmethod
625
  def _InstanceSerial(cls, instance_name):
626
    """Returns the instance serial socket name
627

628
    """
629
    return utils.PathJoin(cls._CTRL_DIR, "%s.serial" % instance_name)
630

    
631
  @classmethod
632
  def _InstanceQmpMonitor(cls, instance_name):
633
    """Returns the instance serial QMP socket name
634

635
    """
636
    return utils.PathJoin(cls._CTRL_DIR, "%s.qmp" % instance_name)
637

    
638
  @staticmethod
639
  def _SocatUnixConsoleParams():
640
    """Returns the correct parameters for socat
641

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

644
    """
645
    if constants.SOCAT_USE_ESCAPE:
646
      return "raw,echo=0,escape=%s" % constants.SOCAT_ESCAPE_CODE
647
    else:
648
      return "echo=0,icanon=0"
649

    
650
  @classmethod
651
  def _InstanceKVMRuntime(cls, instance_name):
652
    """Returns the instance KVM runtime filename
653

654
    """
655
    return utils.PathJoin(cls._CONF_DIR, "%s.runtime" % instance_name)
656

    
657
  @classmethod
658
  def _InstanceChrootDir(cls, instance_name):
659
    """Returns the name of the KVM chroot dir of the instance
660

661
    """
662
    return utils.PathJoin(cls._CHROOT_DIR, instance_name)
663

    
664
  @classmethod
665
  def _InstanceNICDir(cls, instance_name):
666
    """Returns the name of the directory holding the tap device files for a
667
    given instance.
668

669
    """
670
    return utils.PathJoin(cls._NICS_DIR, instance_name)
671

    
672
  @classmethod
673
  def _InstanceNICFile(cls, instance_name, seq):
674
    """Returns the name of the file containing the tap device for a given NIC
675

676
    """
677
    return utils.PathJoin(cls._InstanceNICDir(instance_name), str(seq))
678

    
679
  @classmethod
680
  def _InstanceKeymapFile(cls, instance_name):
681
    """Returns the name of the file containing the keymap for a given instance
682

683
    """
684
    return utils.PathJoin(cls._KEYMAP_DIR, instance_name)
685

    
686
  @classmethod
687
  def _TryReadUidFile(cls, uid_file):
688
    """Try to read a uid file
689

690
    """
691
    if os.path.exists(uid_file):
692
      try:
693
        uid = int(utils.ReadOneLineFile(uid_file))
694
        return uid
695
      except EnvironmentError:
696
        logging.warning("Can't read uid file", exc_info=True)
697
      except (TypeError, ValueError):
698
        logging.warning("Can't parse uid file contents", exc_info=True)
699
    return None
700

    
701
  @classmethod
702
  def _RemoveInstanceRuntimeFiles(cls, pidfile, instance_name):
703
    """Removes an instance's rutime sockets/files/dirs.
704

705
    """
706
    utils.RemoveFile(pidfile)
707
    utils.RemoveFile(cls._InstanceMonitor(instance_name))
708
    utils.RemoveFile(cls._InstanceSerial(instance_name))
709
    utils.RemoveFile(cls._InstanceQmpMonitor(instance_name))
710
    utils.RemoveFile(cls._InstanceKVMRuntime(instance_name))
711
    utils.RemoveFile(cls._InstanceKeymapFile(instance_name))
712
    uid_file = cls._InstanceUidFile(instance_name)
713
    uid = cls._TryReadUidFile(uid_file)
714
    utils.RemoveFile(uid_file)
715
    if uid is not None:
716
      uidpool.ReleaseUid(uid)
717
    try:
718
      shutil.rmtree(cls._InstanceNICDir(instance_name))
719
    except OSError, err:
720
      if err.errno != errno.ENOENT:
721
        raise
722
    try:
723
      chroot_dir = cls._InstanceChrootDir(instance_name)
724
      utils.RemoveDir(chroot_dir)
725
    except OSError, err:
726
      if err.errno == errno.ENOTEMPTY:
727
        # The chroot directory is expected to be empty, but it isn't.
728
        new_chroot_dir = tempfile.mkdtemp(dir=cls._CHROOT_QUARANTINE_DIR,
729
                                          prefix="%s-%s-" %
730
                                          (instance_name,
731
                                           utils.TimestampForFilename()))
732
        logging.warning("The chroot directory of instance %s can not be"
733
                        " removed as it is not empty. Moving it to the"
734
                        " quarantine instead. Please investigate the"
735
                        " contents (%s) and clean up manually",
736
                        instance_name, new_chroot_dir)
737
        utils.RenameFile(chroot_dir, new_chroot_dir)
738
      else:
739
        raise
740

    
741
  @staticmethod
742
  def _ConfigureNIC(instance, seq, nic, tap):
743
    """Run the network configuration script for a specified NIC
744

745
    @param instance: instance we're acting on
746
    @type instance: instance object
747
    @param seq: nic sequence number
748
    @type seq: int
749
    @param nic: nic we're acting on
750
    @type nic: nic object
751
    @param tap: the host's tap interface this NIC corresponds to
752
    @type tap: str
753

754
    """
755
    if instance.tags:
756
      tags = " ".join(instance.tags)
757
    else:
758
      tags = ""
759

    
760
    env = {
761
      "PATH": "%s:/sbin:/usr/sbin" % os.environ["PATH"],
762
      "INSTANCE": instance.name,
763
      "MAC": nic.mac,
764
      "MODE": nic.nicparams[constants.NIC_MODE],
765
      "INTERFACE": tap,
766
      "INTERFACE_INDEX": str(seq),
767
      "TAGS": tags,
768
    }
769

    
770
    if nic.ip:
771
      env["IP"] = nic.ip
772

    
773
    if nic.nicparams[constants.NIC_LINK]:
774
      env["LINK"] = nic.nicparams[constants.NIC_LINK]
775

    
776
    if nic.network:
777
      env["NETWORK"] = nic.network
778

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
870
    return result
871

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
978
    hvp = instance.hvparams
979
    boot_disk = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_DISK
980
    boot_cdrom = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_CDROM
981
    boot_floppy = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_FLOPPY
982
    boot_network = hvp[constants.HV_BOOT_ORDER] == constants.HT_BO_NETWORK
983

    
984
    self.ValidateParameters(hvp)
985

    
986
    if startup_paused:
987
      kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
988

    
989
    if hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_ENABLED:
990
      kvm_cmd.extend(["-enable-kvm"])
991
    elif hvp[constants.HV_KVM_FLAG] == constants.HT_KVM_DISABLED:
992
      kvm_cmd.extend(["-disable-kvm"])
993

    
994
    if boot_network:
995
      kvm_cmd.extend(["-boot", "n"])
996

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

    
1027
      drive_val = "file=%s,format=raw%s%s%s" % (dev_path, if_val, boot_val,
1028
                                                cache_val)
1029
      kvm_cmd.extend(["-drive", drive_val])
1030

    
1031
    #Now we can specify a different device type for CDROM devices.
1032
    cdrom_disk_type = hvp[constants.HV_KVM_CDROM_DISK_TYPE]
1033
    if not cdrom_disk_type:
1034
      cdrom_disk_type = disk_type
1035

    
1036
    iso_image = hvp[constants.HV_CDROM_IMAGE_PATH]
1037
    if iso_image:
1038
      options = ",format=raw,media=cdrom"
1039
      if boot_cdrom:
1040
        kvm_cmd.extend(["-boot", "d"])
1041
        if cdrom_disk_type != constants.HT_DISK_IDE:
1042
          options = "%s,boot=on,if=%s" % (options, constants.HT_DISK_IDE)
1043
        else:
1044
          options = "%s,boot=on" % options
1045
      else:
1046
        if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1047
          if_val = ",if=virtio"
1048
        else:
1049
          if_val = ",if=%s" % cdrom_disk_type
1050
        options = "%s%s" % (options, if_val)
1051
      drive_val = "file=%s%s" % (iso_image, options)
1052
      kvm_cmd.extend(["-drive", drive_val])
1053

    
1054
    iso_image2 = hvp[constants.HV_KVM_CDROM2_IMAGE_PATH]
1055
    if iso_image2:
1056
      options = ",format=raw,media=cdrom"
1057
      if cdrom_disk_type == constants.HT_DISK_PARAVIRTUAL:
1058
        if_val = ",if=virtio"
1059
      else:
1060
        if_val = ",if=%s" % cdrom_disk_type
1061
      options = "%s%s" % (options, if_val)
1062
      drive_val = "file=%s%s" % (iso_image2, options)
1063
      kvm_cmd.extend(["-drive", drive_val])
1064

    
1065
    floppy_image = hvp[constants.HV_KVM_FLOPPY_IMAGE_PATH]
1066
    if floppy_image:
1067
      options = ",format=raw,media=disk"
1068
      if boot_floppy:
1069
        kvm_cmd.extend(["-boot", "a"])
1070
        options = "%s,boot=on" % options
1071
      if_val = ",if=floppy"
1072
      options = "%s%s" % (options, if_val)
1073
      drive_val = "file=%s%s" % (floppy_image, options)
1074
      kvm_cmd.extend(["-drive", drive_val])
1075

    
1076
    kernel_path = hvp[constants.HV_KERNEL_PATH]
1077
    if kernel_path:
1078
      kvm_cmd.extend(["-kernel", kernel_path])
1079
      initrd_path = hvp[constants.HV_INITRD_PATH]
1080
      if initrd_path:
1081
        kvm_cmd.extend(["-initrd", initrd_path])
1082
      root_append = ["root=%s" % hvp[constants.HV_ROOT_PATH],
1083
                     hvp[constants.HV_KERNEL_ARGS]]
1084
      if hvp[constants.HV_SERIAL_CONSOLE]:
1085
        root_append.append("console=ttyS0,38400")
1086
      kvm_cmd.extend(["-append", " ".join(root_append)])
1087

    
1088
    mem_path = hvp[constants.HV_MEM_PATH]
1089
    if mem_path:
1090
      kvm_cmd.extend(["-mem-path", mem_path, "-mem-prealloc"])
1091

    
1092
    monitor_dev = ("unix:%s,server,nowait" %
1093
                   self._InstanceMonitor(instance.name))
1094
    kvm_cmd.extend(["-monitor", monitor_dev])
1095
    if hvp[constants.HV_SERIAL_CONSOLE]:
1096
      serial_dev = ("unix:%s,server,nowait" %
1097
                    self._InstanceSerial(instance.name))
1098
      kvm_cmd.extend(["-serial", serial_dev])
1099
    else:
1100
      kvm_cmd.extend(["-serial", "none"])
1101

    
1102
    mouse_type = hvp[constants.HV_USB_MOUSE]
1103
    vnc_bind_address = hvp[constants.HV_VNC_BIND_ADDRESS]
1104
    spice_bind = hvp[constants.HV_KVM_SPICE_BIND]
1105
    spice_ip_version = None
1106

    
1107
    if mouse_type:
1108
      kvm_cmd.extend(["-usb"])
1109
      kvm_cmd.extend(["-usbdevice", mouse_type])
1110
    elif vnc_bind_address:
1111
      kvm_cmd.extend(["-usbdevice", constants.HT_MOUSE_TABLET])
1112

    
1113
    if vnc_bind_address:
1114
      if netutils.IP4Address.IsValid(vnc_bind_address):
1115
        if instance.network_port > constants.VNC_BASE_PORT:
1116
          display = instance.network_port - constants.VNC_BASE_PORT
1117
          if vnc_bind_address == constants.IP4_ADDRESS_ANY:
1118
            vnc_arg = ":%d" % (display)
1119
          else:
1120
            vnc_arg = "%s:%d" % (vnc_bind_address, display)
1121
        else:
1122
          logging.error("Network port is not a valid VNC display (%d < %d)."
1123
                        " Not starting VNC", instance.network_port,
1124
                        constants.VNC_BASE_PORT)
1125
          vnc_arg = "none"
1126

    
1127
        # Only allow tls and other option when not binding to a file, for now.
1128
        # kvm/qemu gets confused otherwise about the filename to use.
1129
        vnc_append = ""
1130
        if hvp[constants.HV_VNC_TLS]:
1131
          vnc_append = "%s,tls" % vnc_append
1132
          if hvp[constants.HV_VNC_X509_VERIFY]:
1133
            vnc_append = "%s,x509verify=%s" % (vnc_append,
1134
                                               hvp[constants.HV_VNC_X509])
1135
          elif hvp[constants.HV_VNC_X509]:
1136
            vnc_append = "%s,x509=%s" % (vnc_append,
1137
                                         hvp[constants.HV_VNC_X509])
1138
        if hvp[constants.HV_VNC_PASSWORD_FILE]:
1139
          vnc_append = "%s,password" % vnc_append
1140

    
1141
        vnc_arg = "%s%s" % (vnc_arg, vnc_append)
1142

    
1143
      else:
1144
        vnc_arg = "unix:%s/%s.vnc" % (vnc_bind_address, instance.name)
1145

    
1146
      kvm_cmd.extend(["-vnc", vnc_arg])
1147
    elif spice_bind:
1148
      # FIXME: this is wrong here; the iface ip address differs
1149
      # between systems, so it should be done in _ExecuteKVMRuntime
1150
      if netutils.IsValidInterface(spice_bind):
1151
        # The user specified a network interface, we have to figure out the IP
1152
        # address.
1153
        addresses = netutils.GetInterfaceIpAddresses(spice_bind)
1154
        spice_ip_version = hvp[constants.HV_KVM_SPICE_IP_VERSION]
1155

    
1156
        # if the user specified an IP version and the interface does not
1157
        # have that kind of IP addresses, throw an exception
1158
        if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1159
          if not addresses[spice_ip_version]:
1160
            raise errors.HypervisorError("spice: unable to get an IPv%s address"
1161
                                         " for %s" % (spice_ip_version,
1162
                                                      spice_bind))
1163

    
1164
        # the user did not specify an IP version, we have to figure it out
1165
        elif (addresses[constants.IP4_VERSION] and
1166
              addresses[constants.IP6_VERSION]):
1167
          # we have both ipv4 and ipv6, let's use the cluster default IP
1168
          # version
1169
          cluster_family = ssconf.SimpleStore().GetPrimaryIPFamily()
1170
          spice_ip_version = \
1171
            netutils.IPAddress.GetVersionFromAddressFamily(cluster_family)
1172
        elif addresses[constants.IP4_VERSION]:
1173
          spice_ip_version = constants.IP4_VERSION
1174
        elif addresses[constants.IP6_VERSION]:
1175
          spice_ip_version = constants.IP6_VERSION
1176
        else:
1177
          raise errors.HypervisorError("spice: unable to get an IP address"
1178
                                       " for %s" % (spice_bind))
1179

    
1180
        spice_address = addresses[spice_ip_version][0]
1181

    
1182
      else:
1183
        # spice_bind is known to be a valid IP address, because
1184
        # ValidateParameters checked it.
1185
        spice_address = spice_bind
1186

    
1187
      spice_arg = "addr=%s" % spice_address
1188
      if hvp[constants.HV_KVM_SPICE_USE_TLS]:
1189
        spice_arg = "%s,tls-port=%s,x509-cacert-file=%s" % (spice_arg,
1190
            instance.network_port, constants.SPICE_CACERT_FILE)
1191
        spice_arg = "%s,x509-key-file=%s,x509-cert-file=%s" % (spice_arg,
1192
            constants.SPICE_CERT_FILE, constants.SPICE_CERT_FILE)
1193
        tls_ciphers = hvp[constants.HV_KVM_SPICE_TLS_CIPHERS]
1194
        if tls_ciphers:
1195
          spice_arg = "%s,tls-ciphers=%s" % (spice_arg, tls_ciphers)
1196
      else:
1197
        spice_arg = "%s,port=%s" % (spice_arg, instance.network_port)
1198

    
1199
      if not hvp[constants.HV_KVM_SPICE_PASSWORD_FILE]:
1200
        spice_arg = "%s,disable-ticketing" % spice_arg
1201

    
1202
      if spice_ip_version:
1203
        spice_arg = "%s,ipv%s" % (spice_arg, spice_ip_version)
1204

    
1205
      # Image compression options
1206
      img_lossless = hvp[constants.HV_KVM_SPICE_LOSSLESS_IMG_COMPR]
1207
      img_jpeg = hvp[constants.HV_KVM_SPICE_JPEG_IMG_COMPR]
1208
      img_zlib_glz = hvp[constants.HV_KVM_SPICE_ZLIB_GLZ_IMG_COMPR]
1209
      if img_lossless:
1210
        spice_arg = "%s,image-compression=%s" % (spice_arg, img_lossless)
1211
      if img_jpeg:
1212
        spice_arg = "%s,jpeg-wan-compression=%s" % (spice_arg, img_jpeg)
1213
      if img_zlib_glz:
1214
        spice_arg = "%s,zlib-glz-wan-compression=%s" % (spice_arg, img_zlib_glz)
1215

    
1216
      # Video stream detection
1217
      video_streaming = hvp[constants.HV_KVM_SPICE_STREAMING_VIDEO_DETECTION]
1218
      if video_streaming:
1219
        spice_arg = "%s,streaming-video=%s" % (spice_arg, video_streaming)
1220

    
1221
      # Audio compression, by default in qemu-kvm it is on
1222
      if not hvp[constants.HV_KVM_SPICE_AUDIO_COMPR]:
1223
        spice_arg = "%s,playback-compression=off" % spice_arg
1224
      if not hvp[constants.HV_KVM_SPICE_USE_VDAGENT]:
1225
        spice_arg = "%s,agent-mouse=off" % spice_arg
1226
      else:
1227
        # Enable the spice agent communication channel between the host and the
1228
        # agent.
1229
        kvm_cmd.extend(["-device", "virtio-serial-pci"])
1230
        kvm_cmd.extend(["-device", "virtserialport,chardev=spicechannel0,"
1231
                                                   "name=com.redhat.spice.0"])
1232
        kvm_cmd.extend(["-chardev", "spicevmc,id=spicechannel0,name=vdagent"])
1233

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

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

    
1240
    else:
1241
      kvm_cmd.extend(["-nographic"])
1242

    
1243
    if hvp[constants.HV_USE_LOCALTIME]:
1244
      kvm_cmd.extend(["-localtime"])
1245

    
1246
    if hvp[constants.HV_KVM_USE_CHROOT]:
1247
      kvm_cmd.extend(["-chroot", self._InstanceChrootDir(instance.name)])
1248

    
1249
    # Save the current instance nics, but defer their expansion as parameters,
1250
    # as we'll need to generate executable temp files for them.
1251
    kvm_nics = instance.nics
1252
    hvparams = hvp
1253

    
1254
    return (kvm_cmd, kvm_nics, hvparams)
1255

    
1256
  def _WriteKVMRuntime(self, instance_name, data):
1257
    """Write an instance's KVM runtime
1258

1259
    """
1260
    try:
1261
      utils.WriteFile(self._InstanceKVMRuntime(instance_name),
1262
                      data=data)
1263
    except EnvironmentError, err:
1264
      raise errors.HypervisorError("Failed to save KVM runtime file: %s" % err)
1265

    
1266
  def _ReadKVMRuntime(self, instance_name):
1267
    """Read an instance's KVM runtime
1268

1269
    """
1270
    try:
1271
      file_content = utils.ReadFile(self._InstanceKVMRuntime(instance_name))
1272
    except EnvironmentError, err:
1273
      raise errors.HypervisorError("Failed to load KVM runtime file: %s" % err)
1274
    return file_content
1275

    
1276
  def _SaveKVMRuntime(self, instance, kvm_runtime):
1277
    """Save an instance's KVM runtime
1278

1279
    """
1280
    kvm_cmd, kvm_nics, hvparams = kvm_runtime
1281
    serialized_nics = [nic.ToDict() for nic in kvm_nics]
1282
    serialized_form = serializer.Dump((kvm_cmd, serialized_nics, hvparams))
1283
    self._WriteKVMRuntime(instance.name, serialized_form)
1284

    
1285
  def _LoadKVMRuntime(self, instance, serialized_runtime=None):
1286
    """Load an instance's KVM runtime
1287

1288
    """
1289
    if not serialized_runtime:
1290
      serialized_runtime = self._ReadKVMRuntime(instance.name)
1291
    loaded_runtime = serializer.Load(serialized_runtime)
1292
    kvm_cmd, serialized_nics, hvparams = loaded_runtime
1293
    kvm_nics = [objects.NIC.FromDict(snic) for snic in serialized_nics]
1294
    return (kvm_cmd, kvm_nics, hvparams)
1295

    
1296
  def _RunKVMCmd(self, name, kvm_cmd, tap_fds=None):
1297
    """Run the KVM cmd and check for errors
1298

1299
    @type name: string
1300
    @param name: instance name
1301
    @type kvm_cmd: list of strings
1302
    @param kvm_cmd: runcmd input for kvm
1303
    @type tap_fds: list of int
1304
    @param tap_fds: fds of tap devices opened by Ganeti
1305

1306
    """
1307
    try:
1308
      result = utils.RunCmd(kvm_cmd, noclose_fds=tap_fds)
1309
    finally:
1310
      for fd in tap_fds:
1311
        utils_wrapper.CloseFdNoError(fd)
1312

    
1313
    if result.failed:
1314
      raise errors.HypervisorError("Failed to start instance %s: %s (%s)" %
1315
                                   (name, result.fail_reason, result.output))
1316
    if not self._InstancePidAlive(name)[2]:
1317
      raise errors.HypervisorError("Failed to start instance %s" % name)
1318

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

1322
    @type incoming: tuple of strings
1323
    @param incoming: (target_host_ip, port)
1324

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

    
1338
    temp_files = []
1339

    
1340
    kvm_cmd, kvm_nics, up_hvp = kvm_runtime
1341
    up_hvp = objects.FillDict(conf_hvp, up_hvp)
1342

    
1343
    _, v_major, v_min, _ = self._GetKVMVersion()
1344

    
1345
    # We know it's safe to run as a different user upon migration, so we'll use
1346
    # the latest conf, from conf_hvp.
1347
    security_model = conf_hvp[constants.HV_SECURITY_MODEL]
1348
    if security_model == constants.HT_SM_USER:
1349
      kvm_cmd.extend(["-runas", conf_hvp[constants.HV_SECURITY_DOMAIN]])
1350

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

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

    
1380
        if up_hvp[constants.HV_VHOST_NET]:
1381
          # vhost_net is only available from version 0.13.0 or newer
1382
          if (v_major, v_min) >= (0, 13):
1383
            tap_extra = ",vhost=on"
1384
          else:
1385
            raise errors.HypervisorError("vhost_net is configured"
1386
                                        " but it is not available")
1387
      else:
1388
        nic_model = nic_type
1389

    
1390
      for nic_seq, nic in enumerate(kvm_nics):
1391
        tapname, tapfd = _OpenTap(vnet_hdr)
1392
        tapfds.append(tapfd)
1393
        taps.append(tapname)
1394
        if (v_major, v_min) >= (0, 12):
1395
          nic_val = "%s,mac=%s,netdev=netdev%s" % (nic_model, nic.mac, nic_seq)
1396
          tap_val = "type=tap,id=netdev%s,fd=%d%s" % (nic_seq, tapfd, tap_extra)
1397
          kvm_cmd.extend(["-netdev", tap_val, "-device", nic_val])
1398
        else:
1399
          nic_val = "nic,vlan=%s,macaddr=%s,model=%s" % (nic_seq,
1400
                                                         nic.mac, nic_model)
1401
          tap_val = "tap,vlan=%s,fd=%d" % (nic_seq, tapfd)
1402
          kvm_cmd.extend(["-net", tap_val, "-net", nic_val])
1403

    
1404
    if incoming:
1405
      target, port = incoming
1406
      kvm_cmd.extend(["-incoming", "tcp:%s:%s" % (target, port)])
1407

    
1408
    # Changing the vnc password doesn't bother the guest that much. At most it
1409
    # will surprise people who connect to it. Whether positively or negatively
1410
    # it's debatable.
1411
    vnc_pwd_file = conf_hvp[constants.HV_VNC_PASSWORD_FILE]
1412
    vnc_pwd = None
1413
    if vnc_pwd_file:
1414
      try:
1415
        vnc_pwd = utils.ReadOneLineFile(vnc_pwd_file, strict=True)
1416
      except EnvironmentError, err:
1417
        raise errors.HypervisorError("Failed to open VNC password file %s: %s"
1418
                                     % (vnc_pwd_file, err))
1419

    
1420
    if conf_hvp[constants.HV_KVM_USE_CHROOT]:
1421
      utils.EnsureDirs([(self._InstanceChrootDir(name),
1422
                         constants.SECURE_DIR_MODE)])
1423

    
1424
    # Automatically enable QMP if version is >= 0.14
1425
    if (v_major, v_min) >= (0, 14):
1426
      logging.debug("Enabling QMP")
1427
      kvm_cmd.extend(["-qmp", "unix:%s,server,nowait" %
1428
                    self._InstanceQmpMonitor(instance.name)])
1429

    
1430
    # Configure the network now for starting instances and bridged interfaces,
1431
    # during FinalizeMigration for incoming instances' routed interfaces
1432
    for nic_seq, nic in enumerate(kvm_nics):
1433
      if (incoming and
1434
          nic.nicparams[constants.NIC_MODE] != constants.NIC_MODE_BRIDGED):
1435
        continue
1436
      self._ConfigureNIC(instance, nic_seq, nic, taps[nic_seq])
1437

    
1438
    # CPU affinity requires kvm to start paused, so we set this flag if the
1439
    # instance is not already paused and if we are not going to accept a
1440
    # migrating instance. In the latter case, pausing is not needed.
1441
    start_kvm_paused = not (_KVM_START_PAUSED_FLAG in kvm_cmd) and not incoming
1442
    if start_kvm_paused:
1443
      kvm_cmd.extend([_KVM_START_PAUSED_FLAG])
1444

    
1445
    # Note: CPU pinning is using up_hvp since changes take effect
1446
    # during instance startup anyway, and to avoid problems when soft
1447
    # rebooting the instance.
1448
    cpu_pinning = False
1449
    if up_hvp.get(constants.HV_CPU_MASK, None):
1450
      cpu_pinning = True
1451

    
1452
    if security_model == constants.HT_SM_POOL:
1453
      ss = ssconf.SimpleStore()
1454
      uid_pool = uidpool.ParseUidPool(ss.GetUidPool(), separator="\n")
1455
      all_uids = set(uidpool.ExpandUidPool(uid_pool))
1456
      uid = uidpool.RequestUnusedUid(all_uids)
1457
      try:
1458
        username = pwd.getpwuid(uid.GetUid()).pw_name
1459
        kvm_cmd.extend(["-runas", username])
1460
        self._RunKVMCmd(name, kvm_cmd, tapfds)
1461
      except:
1462
        uidpool.ReleaseUid(uid)
1463
        raise
1464
      else:
1465
        uid.Unlock()
1466
        utils.WriteFile(self._InstanceUidFile(name), data=uid.AsStr())
1467
    else:
1468
      self._RunKVMCmd(name, kvm_cmd, tapfds)
1469

    
1470
    utils.EnsureDirs([(self._InstanceNICDir(instance.name),
1471
                     constants.RUN_DIRS_MODE)])
1472
    for nic_seq, tap in enumerate(taps):
1473
      utils.WriteFile(self._InstanceNICFile(instance.name, nic_seq),
1474
                      data=tap)
1475

    
1476
    if vnc_pwd:
1477
      change_cmd = "change vnc password %s" % vnc_pwd
1478
      self._CallMonitorCommand(instance.name, change_cmd)
1479

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

    
1494
      qmp = QmpConnection(self._InstanceQmpMonitor(instance.name))
1495
      qmp.connect()
1496
      arguments = {
1497
          "protocol": "spice",
1498
          "password": spice_pwd,
1499
      }
1500
      qmp.Execute("set_password", arguments)
1501

    
1502
    for filename in temp_files:
1503
      utils.RemoveFile(filename)
1504

    
1505
    # If requested, set CPU affinity and resume instance execution
1506
    if cpu_pinning:
1507
      self._ExecuteCpuAffinity(instance.name, up_hvp[constants.HV_CPU_MASK])
1508

    
1509
    start_memory = self._InstanceStartupMemory(instance)
1510
    if start_memory < instance.beparams[constants.BE_MAXMEM]:
1511
      self.BalloonInstanceMemory(instance, start_memory)
1512

    
1513
    if start_kvm_paused:
1514
      # To control CPU pinning, ballooning, and vnc/spice passwords the VM was
1515
      # started in a frozen state. If freezing was not explicitely requested
1516
      # resume the vm status.
1517
      self._CallMonitorCommand(instance.name, self._CONT_CMD)
1518

    
1519
  def StartInstance(self, instance, block_devices, startup_paused):
1520
    """Start an instance.
1521

1522
    """
1523
    self._CheckDown(instance.name)
1524
    kvm_runtime = self._GenerateKVMRuntime(instance, block_devices,
1525
                                           startup_paused)
1526
    self._SaveKVMRuntime(instance, kvm_runtime)
1527
    self._ExecuteKVMRuntime(instance, kvm_runtime)
1528

    
1529
  def _CallMonitorCommand(self, instance_name, command):
1530
    """Invoke a command on the instance monitor.
1531

1532
    """
1533
    socat = ("echo %s | %s STDIO UNIX-CONNECT:%s" %
1534
             (utils.ShellQuote(command),
1535
              constants.SOCAT_PATH,
1536
              utils.ShellQuote(self._InstanceMonitor(instance_name))))
1537
    result = utils.RunCmd(socat)
1538
    if result.failed:
1539
      msg = ("Failed to send command '%s' to instance %s."
1540
             " output: %s, error: %s, fail_reason: %s" %
1541
             (command, instance_name,
1542
              result.stdout, result.stderr, result.fail_reason))
1543
      raise errors.HypervisorError(msg)
1544

    
1545
    return result
1546

    
1547
  @classmethod
1548
  def _ParseKVMVersion(cls, text):
1549
    """Parse the KVM version from the --help output.
1550

1551
    @type text: string
1552
    @param text: output of kvm --help
1553
    @return: (version, v_maj, v_min, v_rev)
1554
    @raise errors.HypervisorError: when the KVM version cannot be retrieved
1555

1556
    """
1557
    match = cls._VERSION_RE.search(text.splitlines()[0])
1558
    if not match:
1559
      raise errors.HypervisorError("Unable to get KVM version")
1560

    
1561
    v_all = match.group(0)
1562
    v_maj = int(match.group(1))
1563
    v_min = int(match.group(2))
1564
    if match.group(4):
1565
      v_rev = int(match.group(4))
1566
    else:
1567
      v_rev = 0
1568
    return (v_all, v_maj, v_min, v_rev)
1569

    
1570
  @classmethod
1571
  def _GetKVMVersion(cls):
1572
    """Return the installed KVM version.
1573

1574
    @return: (version, v_maj, v_min, v_rev)
1575
    @raise errors.HypervisorError: when the KVM version cannot be retrieved
1576

1577
    """
1578
    result = utils.RunCmd([constants.KVM_PATH, "--help"])
1579
    if result.failed:
1580
      raise errors.HypervisorError("Unable to get KVM version")
1581
    return cls._ParseKVMVersion(result.output)
1582

    
1583
  def StopInstance(self, instance, force=False, retry=False, name=None):
1584
    """Stop an instance.
1585

1586
    """
1587
    if name is not None and not force:
1588
      raise errors.HypervisorError("Cannot shutdown cleanly by name only")
1589
    if name is None:
1590
      name = instance.name
1591
      acpi = instance.hvparams[constants.HV_ACPI]
1592
    else:
1593
      acpi = False
1594
    _, pid, alive = self._InstancePidAlive(name)
1595
    if pid > 0 and alive:
1596
      if force or not acpi:
1597
        utils.KillProcess(pid)
1598
      else:
1599
        self._CallMonitorCommand(name, "system_powerdown")
1600

    
1601
  def CleanupInstance(self, instance_name):
1602
    """Cleanup after a stopped instance
1603

1604
    """
1605
    pidfile, pid, alive = self._InstancePidAlive(instance_name)
1606
    if pid > 0 and alive:
1607
      raise errors.HypervisorError("Cannot cleanup a live instance")
1608
    self._RemoveInstanceRuntimeFiles(pidfile, instance_name)
1609

    
1610
  def RebootInstance(self, instance):
1611
    """Reboot an instance.
1612

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

    
1631
  def MigrationInfo(self, instance):
1632
    """Get instance information to perform a migration.
1633

1634
    @type instance: L{objects.Instance}
1635
    @param instance: instance to be migrated
1636
    @rtype: string
1637
    @return: content of the KVM runtime file
1638

1639
    """
1640
    return self._ReadKVMRuntime(instance.name)
1641

    
1642
  def AcceptInstance(self, instance, info, target):
1643
    """Prepare to accept an instance.
1644

1645
    @type instance: L{objects.Instance}
1646
    @param instance: instance to be accepted
1647
    @type info: string
1648
    @param info: content of the KVM runtime file on the source node
1649
    @type target: string
1650
    @param target: target host (usually ip), on this node
1651

1652
    """
1653
    kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1654
    incoming_address = (target, instance.hvparams[constants.HV_MIGRATION_PORT])
1655
    self._ExecuteKVMRuntime(instance, kvm_runtime, incoming=incoming_address)
1656

    
1657
  def FinalizeMigrationDst(self, instance, info, success):
1658
    """Finalize the instance migration on the target node.
1659

1660
    Stop the incoming mode KVM.
1661

1662
    @type instance: L{objects.Instance}
1663
    @param instance: instance whose migration is being finalized
1664

1665
    """
1666
    if success:
1667
      kvm_runtime = self._LoadKVMRuntime(instance, serialized_runtime=info)
1668
      kvm_nics = kvm_runtime[1]
1669

    
1670
      for nic_seq, nic in enumerate(kvm_nics):
1671
        if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
1672
          # Bridged interfaces have already been configured
1673
          continue
1674
        try:
1675
          tap = utils.ReadFile(self._InstanceNICFile(instance.name, nic_seq))
1676
        except EnvironmentError, err:
1677
          logging.warning("Failed to find host interface for %s NIC #%d: %s",
1678
                          instance.name, nic_seq, str(err))
1679
          continue
1680
        try:
1681
          self._ConfigureNIC(instance, nic_seq, nic, tap)
1682
        except errors.HypervisorError, err:
1683
          logging.warning(str(err))
1684

    
1685
      self._WriteKVMRuntime(instance.name, info)
1686
    else:
1687
      self.StopInstance(instance, force=True)
1688

    
1689
  def MigrateInstance(self, instance, target, live):
1690
    """Migrate an instance to a target node.
1691

1692
    The migration will not be attempted if the instance is not
1693
    currently running.
1694

1695
    @type instance: L{objects.Instance}
1696
    @param instance: the instance to be migrated
1697
    @type target: string
1698
    @param target: ip address of the target node
1699
    @type live: boolean
1700
    @param live: perform a live migration
1701

1702
    """
1703
    instance_name = instance.name
1704
    port = instance.hvparams[constants.HV_MIGRATION_PORT]
1705
    _, _, alive = self._InstancePidAlive(instance_name)
1706
    if not alive:
1707
      raise errors.HypervisorError("Instance not running, cannot migrate")
1708

    
1709
    if not live:
1710
      self._CallMonitorCommand(instance_name, "stop")
1711

    
1712
    migrate_command = ("migrate_set_speed %dm" %
1713
        instance.hvparams[constants.HV_MIGRATION_BANDWIDTH])
1714
    self._CallMonitorCommand(instance_name, migrate_command)
1715

    
1716
    migrate_command = ("migrate_set_downtime %dms" %
1717
        instance.hvparams[constants.HV_MIGRATION_DOWNTIME])
1718
    self._CallMonitorCommand(instance_name, migrate_command)
1719

    
1720
    migrate_command = "migrate -d tcp:%s:%s" % (target, port)
1721
    self._CallMonitorCommand(instance_name, migrate_command)
1722

    
1723
  def FinalizeMigrationSource(self, instance, success, live):
1724
    """Finalize the instance migration on the source node.
1725

1726
    @type instance: L{objects.Instance}
1727
    @param instance: the instance that was migrated
1728
    @type success: bool
1729
    @param success: whether the migration succeeded or not
1730
    @type live: bool
1731
    @param live: whether the user requested a live migration or not
1732

1733
    """
1734
    if success:
1735
      pidfile, pid, _ = self._InstancePidAlive(instance.name)
1736
      utils.KillProcess(pid)
1737
      self._RemoveInstanceRuntimeFiles(pidfile, instance.name)
1738
    elif live:
1739
      self._CallMonitorCommand(instance.name, self._CONT_CMD)
1740

    
1741
  def GetMigrationStatus(self, instance):
1742
    """Get the migration status
1743

1744
    @type instance: L{objects.Instance}
1745
    @param instance: the instance that is being migrated
1746
    @rtype: L{objects.MigrationStatus}
1747
    @return: the status of the current migration (one of
1748
             L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1749
             progress info that can be retrieved from the hypervisor
1750

1751
    """
1752
    info_command = "info migrate"
1753
    for _ in range(self._MIGRATION_INFO_MAX_BAD_ANSWERS):
1754
      result = self._CallMonitorCommand(instance.name, info_command)
1755
      match = self._MIGRATION_STATUS_RE.search(result.stdout)
1756
      if not match:
1757
        if not result.stdout:
1758
          logging.info("KVM: empty 'info migrate' result")
1759
        else:
1760
          logging.warning("KVM: unknown 'info migrate' result: %s",
1761
                          result.stdout)
1762
      else:
1763
        status = match.group(1)
1764
        if status in constants.HV_KVM_MIGRATION_VALID_STATUSES:
1765
          migration_status = objects.MigrationStatus(status=status)
1766
          match = self._MIGRATION_PROGRESS_RE.search(result.stdout)
1767
          if match:
1768
            migration_status.transferred_ram = match.group("transferred")
1769
            migration_status.total_ram = match.group("total")
1770

    
1771
          return migration_status
1772

    
1773
        logging.warning("KVM: unknown migration status '%s'", status)
1774

    
1775
      time.sleep(self._MIGRATION_INFO_RETRY_DELAY)
1776

    
1777
    return objects.MigrationStatus(status=constants.HV_MIGRATION_FAILED,
1778
                                  info="Too many 'info migrate' broken answers")
1779

    
1780
  def BalloonInstanceMemory(self, instance, mem):
1781
    """Balloon an instance memory to a certain value.
1782

1783
    @type instance: L{objects.Instance}
1784
    @param instance: instance to be accepted
1785
    @type mem: int
1786
    @param mem: actual memory size to use for instance runtime
1787

1788
    """
1789
    self._CallMonitorCommand(instance.name, "balloon %d" % mem)
1790

    
1791
  def GetNodeInfo(self):
1792
    """Return information about the node.
1793

1794
    @return: a dict with the following keys (values in MiB):
1795
          - memory_total: the total memory size on the node
1796
          - memory_free: the available memory on the node for instances
1797
          - memory_dom0: the memory used by the node itself, if available
1798
          - hv_version: the hypervisor version in the form (major, minor,
1799
                        revision)
1800

1801
    """
1802
    result = self.GetLinuxNodeInfo()
1803
    _, v_major, v_min, v_rev = self._GetKVMVersion()
1804
    result[constants.HV_NODEINFO_KEY_VERSION] = (v_major, v_min, v_rev)
1805
    return result
1806

    
1807
  @classmethod
1808
  def GetInstanceConsole(cls, instance, hvparams, beparams):
1809
    """Return a command for connecting to the console of an instance.
1810

1811
    """
1812
    if hvparams[constants.HV_SERIAL_CONSOLE]:
1813
      cmd = [constants.KVM_CONSOLE_WRAPPER,
1814
             constants.SOCAT_PATH, utils.ShellQuote(instance.name),
1815
             utils.ShellQuote(cls._InstanceMonitor(instance.name)),
1816
             "STDIO,%s" % cls._SocatUnixConsoleParams(),
1817
             "UNIX-CONNECT:%s" % cls._InstanceSerial(instance.name)]
1818
      return objects.InstanceConsole(instance=instance.name,
1819
                                     kind=constants.CONS_SSH,
1820
                                     host=instance.primary_node,
1821
                                     user=constants.GANETI_RUNAS,
1822
                                     command=cmd)
1823

    
1824
    vnc_bind_address = hvparams[constants.HV_VNC_BIND_ADDRESS]
1825
    if vnc_bind_address and instance.network_port > constants.VNC_BASE_PORT:
1826
      display = instance.network_port - constants.VNC_BASE_PORT
1827
      return objects.InstanceConsole(instance=instance.name,
1828
                                     kind=constants.CONS_VNC,
1829
                                     host=vnc_bind_address,
1830
                                     port=instance.network_port,
1831
                                     display=display)
1832

    
1833
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1834
    if spice_bind:
1835
      return objects.InstanceConsole(instance=instance.name,
1836
                                     kind=constants.CONS_SPICE,
1837
                                     host=spice_bind,
1838
                                     port=instance.network_port)
1839

    
1840
    return objects.InstanceConsole(instance=instance.name,
1841
                                   kind=constants.CONS_MESSAGE,
1842
                                   message=("No serial shell for instance %s" %
1843
                                            instance.name))
1844

    
1845
  def Verify(self):
1846
    """Verify the hypervisor.
1847

1848
    Check that the binary exists.
1849

1850
    """
1851
    if not os.path.exists(constants.KVM_PATH):
1852
      return "The kvm binary ('%s') does not exist." % constants.KVM_PATH
1853
    if not os.path.exists(constants.SOCAT_PATH):
1854
      return "The socat binary ('%s') does not exist." % constants.SOCAT_PATH
1855

    
1856
  @classmethod
1857
  def CheckParameterSyntax(cls, hvparams):
1858
    """Check the given parameters for validity.
1859

1860
    @type hvparams:  dict
1861
    @param hvparams: dictionary with parameter names/value
1862
    @raise errors.HypervisorError: when a parameter is not valid
1863

1864
    """
1865
    super(KVMHypervisor, cls).CheckParameterSyntax(hvparams)
1866

    
1867
    kernel_path = hvparams[constants.HV_KERNEL_PATH]
1868
    if kernel_path:
1869
      if not hvparams[constants.HV_ROOT_PATH]:
1870
        raise errors.HypervisorError("Need a root partition for the instance,"
1871
                                     " if a kernel is defined")
1872

    
1873
    if (hvparams[constants.HV_VNC_X509_VERIFY] and
1874
        not hvparams[constants.HV_VNC_X509]):
1875
      raise errors.HypervisorError("%s must be defined, if %s is" %
1876
                                   (constants.HV_VNC_X509,
1877
                                    constants.HV_VNC_X509_VERIFY))
1878

    
1879
    boot_order = hvparams[constants.HV_BOOT_ORDER]
1880
    if (boot_order == constants.HT_BO_CDROM and
1881
        not hvparams[constants.HV_CDROM_IMAGE_PATH]):
1882
      raise errors.HypervisorError("Cannot boot from cdrom without an"
1883
                                   " ISO path")
1884

    
1885
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1886
    if security_model == constants.HT_SM_USER:
1887
      if not hvparams[constants.HV_SECURITY_DOMAIN]:
1888
        raise errors.HypervisorError("A security domain (user to run kvm as)"
1889
                                     " must be specified")
1890
    elif (security_model == constants.HT_SM_NONE or
1891
          security_model == constants.HT_SM_POOL):
1892
      if hvparams[constants.HV_SECURITY_DOMAIN]:
1893
        raise errors.HypervisorError("Cannot have a security domain when the"
1894
                                     " security model is 'none' or 'pool'")
1895

    
1896
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1897
    spice_ip_version = hvparams[constants.HV_KVM_SPICE_IP_VERSION]
1898
    if spice_bind:
1899
      if spice_ip_version != constants.IFACE_NO_IP_VERSION_SPECIFIED:
1900
        # if an IP version is specified, the spice_bind parameter must be an
1901
        # IP of that family
1902
        if (netutils.IP4Address.IsValid(spice_bind) and
1903
            spice_ip_version != constants.IP4_VERSION):
1904
          raise errors.HypervisorError("spice: got an IPv4 address (%s), but"
1905
                                       " the specified IP version is %s" %
1906
                                       (spice_bind, spice_ip_version))
1907

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

    
1930
  @classmethod
1931
  def ValidateParameters(cls, hvparams):
1932
    """Check the given parameters for validity.
1933

1934
    @type hvparams:  dict
1935
    @param hvparams: dictionary with parameter names/value
1936
    @raise errors.HypervisorError: when a parameter is not valid
1937

1938
    """
1939
    super(KVMHypervisor, cls).ValidateParameters(hvparams)
1940

    
1941
    security_model = hvparams[constants.HV_SECURITY_MODEL]
1942
    if security_model == constants.HT_SM_USER:
1943
      username = hvparams[constants.HV_SECURITY_DOMAIN]
1944
      try:
1945
        pwd.getpwnam(username)
1946
      except KeyError:
1947
        raise errors.HypervisorError("Unknown security domain user %s"
1948
                                     % username)
1949

    
1950
    spice_bind = hvparams[constants.HV_KVM_SPICE_BIND]
1951
    if spice_bind:
1952
      # only one of VNC and SPICE can be used currently.
1953
      if hvparams[constants.HV_VNC_BIND_ADDRESS]:
1954
        raise errors.HypervisorError("both SPICE and VNC are configured, but"
1955
                                     " only one of them can be used at a"
1956
                                     " given time.")
1957

    
1958
      # KVM version should be >= 0.14.0
1959
      _, v_major, v_min, _ = cls._GetKVMVersion()
1960
      if (v_major, v_min) < (0, 14):
1961
        raise errors.HypervisorError("spice is configured, but it is not"
1962
                                     " available in versions of KVM < 0.14")
1963

    
1964
      # if spice_bind is not an IP address, it must be a valid interface
1965
      bound_to_addr = (netutils.IP4Address.IsValid(spice_bind)
1966
                       or netutils.IP6Address.IsValid(spice_bind))
1967
      if not bound_to_addr and not netutils.IsValidInterface(spice_bind):
1968
        raise errors.HypervisorError("spice: the %s parameter must be either"
1969
                                     " a valid IP address or interface name" %
1970
                                     constants.HV_KVM_SPICE_BIND)
1971

    
1972
  @classmethod
1973
  def PowercycleNode(cls):
1974
    """KVM powercycle, just a wrapper over Linux powercycle.
1975

1976
    """
1977
    cls.LinuxPowercycle()