backend.py 102 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

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


22
23
24
25
"""Functions used by the node daemon

@var _ALLOWED_UPLOAD_FILES: denotes which files are accepted in
     the L{UploadFile} function
26
27
@var _ALLOWED_CLEAN_DIRS: denotes which directories are accepted
     in the L{_CleanDirectory} function
28
29

"""
Iustin Pop's avatar
Iustin Pop committed
30

Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35
36
# pylint: disable-msg=E1103

# E1103: %s %r has no %r member (but some types could not be
# inferred), because the _TryOSFromDisk returns either (True, os_obj)
# or (False, "string") which confuses pylint

Iustin Pop's avatar
Iustin Pop committed
37
38
39
40
41
42
43
44

import os
import os.path
import shutil
import time
import stat
import errno
import re
45
import random
46
import logging
47
import tempfile
48
49
import zlib
import base64
50
import signal
Iustin Pop's avatar
Iustin Pop committed
51
52
53
54
55
56
57
58

from ganeti import errors
from ganeti import utils
from ganeti import ssh
from ganeti import hypervisor
from ganeti import constants
from ganeti import bdev
from ganeti import objects
59
from ganeti import ssconf
60
from ganeti import serializer
61
from ganeti import netutils
62
from ganeti import runtime
Iustin Pop's avatar
Iustin Pop committed
63
64


65
_BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"
66
67
68
69
_ALLOWED_CLEAN_DIRS = frozenset([
  constants.DATA_DIR,
  constants.JOB_QUEUE_ARCHIVE_DIR,
  constants.QUEUE_DIR,
70
  constants.CRYPTO_KEYS_DIR,
71
  ])
72
73
74
_MAX_SSL_CERT_VALIDITY = 7 * 24 * 60 * 60
_X509_KEY_FILE = "key"
_X509_CERT_FILE = "cert"
75
76
77
_IES_STATUS_FILE = "status"
_IES_PID_FILE = "pid"
_IES_CA_FILE = "ca"
78

79
#: Valid LVS output line regex
80
_LVSLINE_REGEX = re.compile("^ *([^|]+)\|([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
81

82

83
84
85
86
87
88
89
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

90

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
def _Fail(msg, *args, **kwargs):
  """Log an error and the raise an RPCFail exception.

  This exception is then handled specially in the ganeti daemon and
  turned into a 'failed' return type. As such, this function is a
  useful shortcut for logging the error and returning it to the master
  daemon.

  @type msg: string
  @param msg: the text of the exception
  @raise RPCFail

  """
  if args:
    msg = msg % args
106
107
108
109
110
  if "log" not in kwargs or kwargs["log"]: # if we should log this error
    if "exc" in kwargs and kwargs["exc"]:
      logging.exception(msg)
    else:
      logging.error(msg)
111
112
113
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
114
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
115
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
116

Iustin Pop's avatar
Iustin Pop committed
117
118
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
119
120

  """
Iustin Pop's avatar
Iustin Pop committed
121
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
122
123


124
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
125
126
127
128
129
130
131
132
133
  """Simple wrapper to return an SshRunner.

  @type cluster_name: str
  @param cluster_name: the cluster name, which is needed
      by the SshRunner constructor
  @rtype: L{ssh.SshRunner}
  @return: an SshRunner instance

  """
134
  return ssh.SshRunner(cluster_name)
135
136


137
138
139
140
141
142
143
144
145
def _Decompress(data):
  """Unpacks data compressed by the RPC client.

  @type data: list or tuple
  @param data: Data sent by RPC client
  @rtype: str
  @return: Decompressed data

  """
146
  assert isinstance(data, (list, tuple))
147
148
149
150
151
152
153
154
155
156
  assert len(data) == 2
  (encoding, content) = data
  if encoding == constants.RPC_ENCODING_NONE:
    return content
  elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
    return zlib.decompress(base64.b64decode(content))
  else:
    raise AssertionError("Unknown data encoding")


157
def _CleanDirectory(path, exclude=None):
158
159
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
160
161
  @type path: str
  @param path: the directory to clean
162
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
163
164
  @param exclude: list of files to be excluded, defaults
      to the empty list
165
166

  """
167
168
169
170
  if path not in _ALLOWED_CLEAN_DIRS:
    _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'",
          path)

171
172
  if not os.path.isdir(path):
    return
173
174
175
176
177
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
178

179
  for rel_name in utils.ListVisibleFiles(path):
180
    full_name = utils.PathJoin(path, rel_name)
181
182
    if full_name in exclude:
      continue
183
184
185
186
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


187
188
189
190
191
192
def _BuildUploadFileList():
  """Build the list of allowed upload files.

  This is abstracted so that it's built only once at module import time.

  """
193
194
195
196
197
198
199
  allowed_files = set([
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
    constants.VNC_PASSWORD_FILE,
    constants.RAPI_CERT_FILE,
    constants.RAPI_USERS_FILE,
200
    constants.CONFD_HMAC_KEY,
201
    constants.CLUSTER_DOMAIN_SECRET_FILE,
202
203
204
    ])

  for hv_name in constants.HYPER_TYPES:
205
    hv_class = hypervisor.GetHypervisorClass(hv_name)
206
207
208
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
209
210
211
212
213


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


214
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
215
216
  """Removes job queue files and archived jobs.

217
218
  @rtype: tuple
  @return: True, None
219
220

  """
221
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
222
223
224
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


225
226
227
228
229
230
231
def GetMasterInfo():
  """Returns master information.

  This is an utility function to compute master information, either
  for consumption here or from the node daemon.

  @rtype: tuple
232
  @return: master_netdev, master_ip, master_name, primary_ip_family
233
  @raise RPCFail: in case of errors
234
235
236

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
237
238
239
240
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
241
    primary_ip_family = cfg.GetPrimaryIPFamily()
242
  except errors.ConfigurationError, err:
Iustin Pop's avatar
Iustin Pop committed
243
    _Fail("Cluster configuration incomplete: %s", err, exc=True)
244
  return (master_netdev, master_ip, master_node, primary_ip_family)
245
246


247
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
248
249
  """Activate local node as master node.

250
251
252
  The function will either try activate the IP address of the master
  (unless someone else has it) or also start the master daemons, based
  on the start_daemons parameter.
Iustin Pop's avatar
Iustin Pop committed
253
254

  @type start_daemons: boolean
255
256
257
  @param start_daemons: whether to start the master daemons
      (ganeti-masterd and ganeti-rapi), or (if false) activate the
      master ip
258
259
260
  @type no_voting: boolean
  @param no_voting: whether to start ganeti-masterd without a node vote
      (if start_daemons is True), but still non-interactively
Iustin Pop's avatar
Iustin Pop committed
261
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
262
263

  """
264
  # GetMasterInfo will raise an exception if not able to return data
265
  master_netdev, master_ip, _, family = GetMasterInfo()
Iustin Pop's avatar
Iustin Pop committed
266

267
  err_msgs = []
268
  # either start the master and rapi daemons
269
  if start_daemons:
270
    if no_voting:
271
272
273
274
275
276
277
278
279
280
281
282
283
      masterd_args = "--no-voting --yes-do-it"
    else:
      masterd_args = ""

    env = {
      "EXTRA_MASTERD_ARGS": masterd_args,
      }

    result = utils.RunCmd([constants.DAEMON_UTIL, "start-master"], env=env)
    if result.failed:
      msg = "Can't start Ganeti master: %s" % result.output
      logging.error(msg)
      err_msgs.append(msg)
284
285
286
  # or activate the IP
  else:
    if netutils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
287
      if netutils.IPAddress.Own(master_ip):
288
289
290
291
292
293
294
        # we already have the ip:
        logging.debug("Master IP already configured, doing nothing")
      else:
        msg = "Someone else has the master ip, not activating"
        logging.error(msg)
        err_msgs.append(msg)
    else:
295
296
297
      ipcls = netutils.IP4Address
      if family == netutils.IP6Address.family:
        ipcls = netutils.IP6Address
298
299

      result = utils.RunCmd(["ip", "address", "add",
300
                             "%s/%d" % (master_ip, ipcls.iplen),
301
302
303
304
305
306
307
                             "dev", master_netdev, "label",
                             "%s:0" % master_netdev])
      if result.failed:
        msg = "Can't activate master IP: %s" % result.output
        logging.error(msg)
        err_msgs.append(msg)

308
      # we ignore the exit code of the following cmds
309
      if ipcls == netutils.IP4Address:
310
311
        utils.RunCmd(["arping", "-q", "-U", "-c 3", "-I", master_netdev, "-s",
                      master_ip, master_ip])
312
      elif ipcls == netutils.IP6Address:
313
314
315
316
317
        try:
          utils.RunCmd(["ndisc6", "-q", "-r 3", master_ip, master_netdev])
        except errors.OpExecError:
          # TODO: Better error reporting
          logging.warning("Can't execute ndisc6, please install if missing")
318

319
320
  if err_msgs:
    _Fail("; ".join(err_msgs))
321

Iustin Pop's avatar
Iustin Pop committed
322

323
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
324
325
  """Deactivate this node as master.

326
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
327
328
329
330
331
332
333
  master. It will also stop the master daemons depending on the
  stop_daemons parameter.

  @type stop_daemons: boolean
  @param stop_daemons: whether to also stop the master daemons
      (ganeti-masterd and ganeti-rapi)
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
334
335

  """
336
337
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
338
339

  # GetMasterInfo will raise an exception if not able to return data
340
  master_netdev, master_ip, _, family = GetMasterInfo()
Iustin Pop's avatar
Iustin Pop committed
341

342
343
344
  ipcls = netutils.IP4Address
  if family == netutils.IP6Address.family:
    ipcls = netutils.IP6Address
345
346

  result = utils.RunCmd(["ip", "address", "del",
347
                         "%s/%d" % (master_ip, ipcls.iplen),
348
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
349
  if result.failed:
350
    logging.error("Can't remove the master IP, error: %s", result.output)
351
352
353
    # but otherwise ignore the failure

  if stop_daemons:
354
355
356
357
358
    result = utils.RunCmd([constants.DAEMON_UTIL, "stop-master"])
    if result.failed:
      logging.error("Could not stop Ganeti master, command %s had exitcode %s"
                    " and error %s",
                    result.cmd, result.exit_code, result.output)
Iustin Pop's avatar
Iustin Pop committed
359
360


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
def EtcHostsModify(mode, host, ip):
  """Modify a host entry in /etc/hosts.

  @param mode: The mode to operate. Either add or remove entry
  @param host: The host to operate on
  @param ip: The ip associated with the entry

  """
  if mode == constants.ETC_HOSTS_ADD:
    if not ip:
      RPCFail("Mode 'add' needs 'ip' parameter, but parameter not"
              " present")
    utils.AddHostToEtcHosts(host, ip)
  elif mode == constants.ETC_HOSTS_REMOVE:
    if ip:
      RPCFail("Mode 'remove' does not allow 'ip' parameter, but"
              " parameter is present")
    utils.RemoveHostFromEtcHosts(host)
  else:
    RPCFail("Mode not supported")


383
def LeaveCluster(modify_ssh_setup):
Iustin Pop's avatar
Iustin Pop committed
384
385
386
387
388
389
  """Cleans up and remove the current node.

  This function cleans up and prepares the current node to be removed
  from the cluster.

  If processing is successful, then it raises an
Iustin Pop's avatar
Iustin Pop committed
390
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
391
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
392

393
394
  @param modify_ssh_setup: boolean

Iustin Pop's avatar
Iustin Pop committed
395
  """
396
  _CleanDirectory(constants.DATA_DIR)
397
  _CleanDirectory(constants.CRYPTO_KEYS_DIR)
398
  JobQueuePurge()
399

400
401
402
  if modify_ssh_setup:
    try:
      priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
403

404
      utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
Iustin Pop's avatar
Iustin Pop committed
405

406
407
408
409
      utils.RemoveFile(priv_key)
      utils.RemoveFile(pub_key)
    except errors.OpExecError:
      logging.exception("Error while processing ssh files")
Iustin Pop's avatar
Iustin Pop committed
410

411
  try:
412
    utils.RemoveFile(constants.CONFD_HMAC_KEY)
413
    utils.RemoveFile(constants.RAPI_CERT_FILE)
414
    utils.RemoveFile(constants.NODED_CERT_FILE)
Iustin Pop's avatar
Iustin Pop committed
415
  except: # pylint: disable-msg=W0702
416
417
    logging.exception("Error while removing cluster secrets")

418
419
420
421
  result = utils.RunCmd([constants.DAEMON_UTIL, "stop", constants.CONFD])
  if result.failed:
    logging.error("Command %s failed with exitcode %s and error %s",
                  result.cmd, result.exit_code, result.output)
422

423
424
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
425

Iustin Pop's avatar
Iustin Pop committed
426

427
def GetNodeInfo(vgname, hypervisor_type):
Michael Hanselmann's avatar
Michael Hanselmann committed
428
  """Gives back a hash with different information about the node.
Iustin Pop's avatar
Iustin Pop committed
429

430
431
432
433
434
435
436
437
438
439
440
441
  @type vgname: C{string}
  @param vgname: the name of the volume group to ask for disk space information
  @type hypervisor_type: C{str}
  @param hypervisor_type: the name of the hypervisor to ask for
      memory information
  @rtype: C{dict}
  @return: dictionary with the following keys:
      - vg_size is the size of the configured volume group in MiB
      - vg_free is the free size of the volume group in MiB
      - memory_dom0 is the memory allocated for domain0 in MiB
      - memory_free is the currently available (free) ram in MiB
      - memory_total is the total number of ram in MiB
Iustin Pop's avatar
Iustin Pop committed
442

443
  """
Iustin Pop's avatar
Iustin Pop committed
444
  outputarray = {}
445

446
447
448
449
450
451
452
453
454
455
456
457
458
459
  if vgname is not None:
    vginfo = bdev.LogicalVolume.GetVGInfo([vgname])
    vg_free = vg_size = None
    if vginfo:
      vg_free = int(round(vginfo[0][0], 0))
      vg_size = int(round(vginfo[0][1], 0))
    outputarray['vg_size'] = vg_size
    outputarray['vg_free'] = vg_free

  if hypervisor_type is not None:
    hyper = hypervisor.GetHypervisor(hypervisor_type)
    hyp_info = hyper.GetNodeInfo()
    if hyp_info is not None:
      outputarray.update(hyp_info)
Iustin Pop's avatar
Iustin Pop committed
460

461
  outputarray["bootid"] = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
462

463
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
464
465


466
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
467
468
  """Verify the status of the local node.

469
470
471
472
473
474
475
476
477
  Based on the input L{what} parameter, various checks are done on the
  local node.

  If the I{filelist} key is present, this list of
  files is checksummed and the file/checksum pairs are returned.

  If the I{nodelist} key is present, we check that we have
  connectivity via ssh with the target nodes (and check the hostname
  report).
Iustin Pop's avatar
Iustin Pop committed
478

479
480
481
482
483
484
485
486
487
488
489
  If the I{node-net-test} key is present, we check that we have
  connectivity to the given nodes via both primary IP and, if
  applicable, secondary IPs.

  @type what: C{dict}
  @param what: a dictionary of things to check:
      - filelist: list of files for which to compute checksums
      - nodelist: list of nodes we should check ssh communication with
      - node-net-test: list of nodes we should check node daemon port
        connectivity with
      - hypervisor: list with hypervisors to run the verify for
Iustin Pop's avatar
Iustin Pop committed
490
491
492
  @rtype: dict
  @return: a dictionary with the same keys as the input dict, and
      values representing the result of the checks
Iustin Pop's avatar
Iustin Pop committed
493
494
495

  """
  result = {}
496
  my_name = netutils.Hostname.GetSysName()
497
  port = netutils.GetDaemonPort(constants.NODED)
498
  vm_capable = my_name not in what.get(constants.NV_VMNODES, [])
Iustin Pop's avatar
Iustin Pop committed
499

500
  if constants.NV_HYPERVISOR in what and vm_capable:
501
502
    result[constants.NV_HYPERVISOR] = tmp = {}
    for hv_name in what[constants.NV_HYPERVISOR]:
503
504
505
506
507
      try:
        val = hypervisor.GetHypervisor(hv_name).Verify()
      except errors.HypervisorError, err:
        val = "Error while checking hypervisor: %s" % str(err)
      tmp[hv_name] = val
508
509
510
511
512
513
514
515
516

  if constants.NV_FILELIST in what:
    result[constants.NV_FILELIST] = utils.FingerprintFiles(
      what[constants.NV_FILELIST])

  if constants.NV_NODELIST in what:
    result[constants.NV_NODELIST] = tmp = {}
    random.shuffle(what[constants.NV_NODELIST])
    for node in what[constants.NV_NODELIST]:
517
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
518
      if not success:
519
520
521
522
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
523
    my_pip = my_sip = None
524
    for name, pip, sip in what[constants.NV_NODENETTEST]:
525
526
527
528
529
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
530
531
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
532
    else:
533
      for name, pip, sip in what[constants.NV_NODENETTEST]:
534
        fail = []
535
        if not netutils.TcpPing(pip, port, source=my_pip):
536
537
          fail.append("primary")
        if sip != pip:
538
          if not netutils.TcpPing(sip, port, source=my_sip):
539
540
            fail.append("secondary")
        if fail:
541
542
543
          tmp[name] = ("failure using the %s interface(s)" %
                       " and ".join(fail))

544
545
546
547
548
  if constants.NV_MASTERIP in what:
    # FIXME: add checks on incoming data structures (here and in the
    # rest of the function)
    master_name, master_ip = what[constants.NV_MASTERIP]
    if master_name == my_name:
549
      source = constants.IP4_ADDRESS_LOCALHOST
550
551
    else:
      source = None
552
    result[constants.NV_MASTERIP] = netutils.TcpPing(master_ip, port,
553
554
                                                  source=source)

555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
  if constants.NV_OOB_PATHS in what:
    result[constants.NV_OOB_PATHS] = tmp = []
    for path in what[constants.NV_OOB_PATHS]:
      try:
        st = os.stat(path)
      except OSError, err:
        tmp.append("error stating out of band helper: %s" % err)
      else:
        if stat.S_ISREG(st.st_mode):
          if stat.S_IMODE(st.st_mode) & stat.S_IXUSR:
            tmp.append(None)
          else:
            tmp.append("out of band helper %s is not executable" % path)
        else:
          tmp.append("out of band helper %s is not a file" % path)

571
  if constants.NV_LVLIST in what and vm_capable:
572
    try:
573
      val = GetVolumeList(utils.ListVolumeGroups().keys())
574
575
576
    except RPCFail, err:
      val = str(err)
    result[constants.NV_LVLIST] = val
577

578
  if constants.NV_INSTANCELIST in what and vm_capable:
579
580
581
582
583
584
    # GetInstanceList can fail
    try:
      val = GetInstanceList(what[constants.NV_INSTANCELIST])
    except RPCFail, err:
      val = str(err)
    result[constants.NV_INSTANCELIST] = val
585

586
  if constants.NV_VGLIST in what and vm_capable:
587
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
588

589
  if constants.NV_PVLIST in what and vm_capable:
590
591
592
593
    result[constants.NV_PVLIST] = \
      bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
                                   filter_allocatable=False)

594
  if constants.NV_VERSION in what:
595
596
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
597

598
  if constants.NV_HVINFO in what and vm_capable:
599
600
    hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
    result[constants.NV_HVINFO] = hyper.GetNodeInfo()
601

602
  if constants.NV_DRBDLIST in what and vm_capable:
603
604
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
605
    except errors.BlockDeviceError, err:
606
      logging.warning("Can't get used minors list", exc_info=True)
607
      used_minors = str(err)
608
609
    result[constants.NV_DRBDLIST] = used_minors

610
  if constants.NV_DRBDHELPER in what and vm_capable:
611
612
613
614
615
616
617
618
619
    status = True
    try:
      payload = bdev.BaseDRBD.GetUsermodeHelper()
    except errors.BlockDeviceError, err:
      logging.error("Can't get DRBD usermode helper: %s", str(err))
      status = False
      payload = str(err)
    result[constants.NV_DRBDHELPER] = (status, payload)

620
621
622
623
624
625
626
627
628
629
630
  if constants.NV_NODESETUP in what:
    result[constants.NV_NODESETUP] = tmpr = []
    if not os.path.isdir("/sys/block") or not os.path.isdir("/sys/class/net"):
      tmpr.append("The sysfs filesytem doesn't seem to be mounted"
                  " under /sys, missing required directories /sys/block"
                  " and /sys/class/net")
    if (not os.path.isdir("/proc/sys") or
        not os.path.isfile("/proc/sysrq-trigger")):
      tmpr.append("The procfs filesystem doesn't seem to be mounted"
                  " under /proc, missing required directory /proc/sys and"
                  " the file /proc/sysrq-trigger")
631
632
633
634

  if constants.NV_TIME in what:
    result[constants.NV_TIME] = utils.SplitTime(time.time())

635
  if constants.NV_OSLIST in what and vm_capable:
636
637
    result[constants.NV_OSLIST] = DiagnoseOS()

638
  return result
Iustin Pop's avatar
Iustin Pop committed
639
640


641
def GetVolumeList(vg_names):
Iustin Pop's avatar
Iustin Pop committed
642
643
  """Compute list of logical volumes and their size.

644
645
  @type vg_names: list
  @param vg_names: the volume groups whose LVs we should list
Iustin Pop's avatar
Iustin Pop committed
646
647
648
649
650
  @rtype: dict
  @return:
      dictionary of all partions (key) with value being a tuple of
      their size (in MiB), inactive and online status::

651
        {'xenvg/test1': ('20.06', True, True)}
Iustin Pop's avatar
Iustin Pop committed
652
653
654

      in case of errors, a string is returned with the error
      details.
Iustin Pop's avatar
Iustin Pop committed
655
656

  """
657
658
659
660
  lvs = {}
  sep = '|'
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=%s" % sep,
661
                         "-ovg_name,lv_name,lv_size,lv_attr"] + vg_names)
Iustin Pop's avatar
Iustin Pop committed
662
  if result.failed:
663
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
664
665

  for line in result.stdout.splitlines():
666
    line = line.strip()
667
    match = _LVSLINE_REGEX.match(line)
668
    if not match:
669
      logging.error("Invalid line returned from lvs output: '%s'", line)
670
      continue
671
    vg_name, name, size, attr = match.groups()
672
673
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
Iustin Pop's avatar
Iustin Pop committed
674
675
676
677
678
    virtual = attr[0] == 'v'
    if virtual:
      # we don't want to report such volumes as existing, since they
      # don't really hold data
      continue
679
    lvs[vg_name+"/"+name] = (size, inactive, online)
680
681

  return lvs
Iustin Pop's avatar
Iustin Pop committed
682
683
684


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
685
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
686

Iustin Pop's avatar
Iustin Pop committed
687
688
689
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
690
691

  """
692
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
693
694


695
696
697
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
  @rtype: list
  @return:
    A list of dictionaries, each having four keys:
      - name: the logical volume name,
      - size: the size of the logical volume
      - dev: the physical device on which the LV lives
      - vg: the volume group to which it belongs

    In case of errors, we return an empty list and log the
    error.

    Note that since a logical volume can live on multiple physical
    volumes, the resulting list might include a logical volume
    multiple times.

713
714
715
716
717
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
718
719
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
720
721

  def parse_dev(dev):
722
723
724
725
    return dev.split('(')[0]

  def handle_dev(dev):
    return [parse_dev(x) for x in dev.split(",")]
726
727

  def map_line(line):
728
729
730
731
732
733
734
735
736
737
738
    line = [v.strip() for v in line]
    return [{'name': line[0], 'size': line[1],
             'dev': dev, 'vg': line[3]} for dev in handle_dev(line[2])]

  all_devs = []
  for line in result.stdout.splitlines():
    if line.count('|') >= 3:
      all_devs.extend(map_line(line.split('|')))
    else:
      logging.warning("Strange line in the output from lvs: '%s'", line)
  return all_devs
739
740


Iustin Pop's avatar
Iustin Pop committed
741
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
742
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
743

Iustin Pop's avatar
Iustin Pop committed
744
745
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
746
747

  """
748
  missing = []
Iustin Pop's avatar
Iustin Pop committed
749
750
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
751
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
752

753
  if missing:
754
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
755

Iustin Pop's avatar
Iustin Pop committed
756

757
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
758
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
759

760
761
762
763
764
  @type hypervisor_list: list
  @param hypervisor_list: the list of hypervisors to query information

  @rtype: list
  @return: a list of all running instances on the current node
Iustin Pop's avatar
Iustin Pop committed
765
766
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
767

768
  """
769
770
771
772
773
774
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
775
776
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
777

778
  return results
Iustin Pop's avatar
Iustin Pop committed
779
780


781
def GetInstanceInfo(instance, hname):
Michael Hanselmann's avatar
Michael Hanselmann committed
782
  """Gives back the information about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
783

784
785
786
787
  @type instance: string
  @param instance: the instance name
  @type hname: string
  @param hname: the hypervisor type of the instance
Iustin Pop's avatar
Iustin Pop committed
788

789
790
791
792
793
  @rtype: dict
  @return: dictionary with the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
794

795
  """
Iustin Pop's avatar
Iustin Pop committed
796
797
  output = {}

798
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
799
800
801
802
803
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

804
  return output
Iustin Pop's avatar
Iustin Pop committed
805
806


807
808
809
810
811
812
813
814
815
816
817
818
819
def GetInstanceMigratable(instance):
  """Gives whether an instance can be migrated.

  @type instance: L{objects.Instance}
  @param instance: object representing the instance to be checked.

  @rtype: tuple
  @return: tuple of (result, description) where:
      - result: whether the instance can be migrated or not
      - description: a description of the issue, if relevant

  """
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
820
821
822
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
823
824

  for idx in range(len(instance.disks)):
825
    link_name = _GetBlockDevSymlinkPath(iname, idx)
826
    if not os.path.islink(link_name):
827
828
      logging.warning("Instance %s is missing symlink %s for disk %d",
                      iname, link_name, idx)
829
830


831
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
832
833
  """Gather data about all instances.

Iustin Pop's avatar
Iustin Pop committed
834
  This is the equivalent of L{GetInstanceInfo}, except that it
Iustin Pop's avatar
Iustin Pop committed
835
836
837
  computes data for all instances at once, thus being faster if one
  needs data about more than one instance.

838
839
840
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

841
  @rtype: dict
842
843
844
845
  @return: dictionary of instance: data, with data having the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
846
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
847

848
  """
Iustin Pop's avatar
Iustin Pop committed
849
850
  output = {}

851
852
853
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
854
      for name, _, memory, vcpus, state, times in iinfo:
855
        value = {
856
857
858
859
860
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
861
862
863
864
865
866
        if name in output:
          # we only check static parameters, like memory and vcpus,
          # and not state and time which can change between the
          # invocations of the different hypervisors
          for key in 'memory', 'vcpus':
            if value[key] != output[name][key]:
867
868
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
869
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
870

871
  return output
Iustin Pop's avatar
Iustin Pop committed
872
873


Iustin Pop's avatar
Iustin Pop committed
874
875
876
877
878
879
880
881
882
883
884
885
886
887
def _InstanceLogName(kind, os_name, instance):
  """Compute the OS log filename for a given instance and operation.

  The instance name and os name are passed in as strings since not all
  operations have these as part of an instance object.

  @type kind: string
  @param kind: the operation type (e.g. add, import, etc.)
  @type os_name: string
  @param os_name: the os name
  @type instance: string
  @param instance: the name of the instance being imported/added/etc.

  """
888
  # TODO: Use tempfile.mkstemp to create unique filename
889
890
  base = ("%s-%s-%s-%s.log" %
          (kind, os_name, instance, utils.TimestampForFilename()))
Iustin Pop's avatar
Iustin Pop committed
891
892
893
  return utils.PathJoin(constants.LOG_OS_DIR, base)


894
def InstanceOsAdd(instance, reinstall, debug):
Alexander Schreiber's avatar
Alexander Schreiber committed
895
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
896

897
898
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
899
900
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
901
902
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
903
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
904
905

  """
906
907
  inst_os = OSFromDisk(instance.os)

908
  create_env = OSEnvironment(instance, inst_os, debug)
909
910
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
911

Iustin Pop's avatar
Iustin Pop committed
912
  logfile = _InstanceLogName("add", instance.os, instance.name)
913

914
915
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
916
  if result.failed:
917
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
918
                  " output: %s", result.cmd, result.fail_reason, logfile,
919
                  result.output)
920
    lines = [utils.SafeEncode(val)
921
             for val in utils.TailFile(logfile, lines=20)]
922
923
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
924
925


926
def RunRenameInstance(instance, old_name, debug):
927
928
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
929
  @type instance: L{objects.Instance}
930
931
932
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
933
934
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
Iustin Pop's avatar
Iustin Pop committed
935
936
  @rtype: boolean
  @return: the success of the operation
937
938
939
940

  """
  inst_os = OSFromDisk(instance.os)

941
  rename_env = OSEnvironment(instance, inst_os, debug)
942
  rename_env['OLD_INSTANCE_NAME'] = old_name
943

Iustin Pop's avatar
Iustin Pop committed
944
945
  logfile = _InstanceLogName("rename", instance.os,
                             "%s-%s" % (old_name, instance.name))
Iustin Pop's avatar
Iustin Pop committed
946

947
948
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
949
950

  if result.failed:
951
    logging.error("os create command '%s' returned error: %s output: %s",
952
                  result.cmd, result.fail_reason, result.output)
953
    lines = [utils.SafeEncode(val)
954
             for val in utils.TailFile(logfile, lines=20)]
955
956
    _Fail("OS rename script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
Iustin Pop's avatar
Iustin Pop committed
957
958


959
def _GetBlockDevSymlinkPath(instance_name, idx):
960
961
  return utils.PathJoin(constants.DISK_LINKS_DIR, "%s%s%d" %
                        (instance_name, constants.DISK_SEPARATOR, idx))
962
963
964


def _SymlinkBlockDev(instance_name, device_path, idx):
965
966
967
968
969
970
  """Set up symlinks to a instance's block device.

  This is an auxiliary function run when an instance is start (on the primary
  node) or when an instance is migrated (on the target node).


971
972
973
974
  @param instance_name: the name of the target instance
  @param device_path: path of the physical block device, on the node
  @param idx: the disk index
  @return: absolute path to the disk's symlink
975
976

  """
977
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
978
979
  try:
    os.symlink(device_path, link_name)
980
981
  except OSError, err:
    if err.errno == errno.EEXIST:
982
983
984
985
986
987
988
989
990
991
      if (not os.path.islink(link_name) or
          os.readlink(link_name) != device_path):
        os.remove(link_name)
        os.symlink(device_path, link_name)
    else:
      raise

  return link_name


992
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
993
994
995
  """Remove the block device symlinks belonging to the given instance.

  """
Iustin Pop's avatar
Iustin Pop committed
996
  for idx, _ in enumerate(disks):
997
998
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
999
      try:
1000
1001
1002
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
1003
1004


1005
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
1006
1007
1008
1009
1010
  """Set up an instance's block device(s).

  This is run on the primary node at instance startup. The block
  devices must be already assembled.

Iustin Pop's avatar
Iustin Pop committed
1011
1012
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
1013
1014
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
1015

Iustin Pop's avatar
Iustin Pop committed
1016
1017
  """
  block_devices = []
1018
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
1019
1020
1021
1022
1023
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
1024
    try:
1025
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
1026
1027
1028
1029
1030
1031
    except OSError, e:
      raise errors.BlockDeviceError("Cannot create block device symlink: %s" %
                                    e.strerror)

    block_devices.append((disk, link_name))

Iustin Pop's avatar
Iustin Pop committed
1032
1033
1034
  return block_devices


1035
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
1036
1037
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
1038
  @type instance: L{objects.Instance}
1039
  @param instance: the instance object
1040
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1041

1042
  """