backend.py 98.5 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


80
81
82
83
84
85
86
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

87

88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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
103
104
105
106
107
  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)
108
109
110
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
111
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
112
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
113

Iustin Pop's avatar
Iustin Pop committed
114
115
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
116
117

  """
Iustin Pop's avatar
Iustin Pop committed
118
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
119
120


121
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
122
123
124
125
126
127
128
129
130
  """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

  """
131
  return ssh.SshRunner(cluster_name)
132
133


134
135
136
137
138
139
140
141
142
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

  """
143
  assert isinstance(data, (list, tuple))
144
145
146
147
148
149
150
151
152
153
  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")


154
def _CleanDirectory(path, exclude=None):
155
156
  """Removes all regular files in a directory.

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

  """
164
165
166
167
  if path not in _ALLOWED_CLEAN_DIRS:
    _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'",
          path)

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

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


184
185
186
187
188
189
def _BuildUploadFileList():
  """Build the list of allowed upload files.

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

  """
190
191
192
193
194
195
196
  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,
197
    constants.CONFD_HMAC_KEY,
198
    constants.CLUSTER_DOMAIN_SECRET_FILE,
199
200
201
    ])

  for hv_name in constants.HYPER_TYPES:
202
    hv_class = hypervisor.GetHypervisorClass(hv_name)
203
204
205
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
206
207
208
209
210


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


211
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
212
213
  """Removes job queue files and archived jobs.

214
215
  @rtype: tuple
  @return: True, None
216
217

  """
218
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
219
220
221
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


222
223
224
225
226
227
228
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
229
  @return: master_netdev, master_ip, master_name, primary_ip_family
230
  @raise RPCFail: in case of errors
231
232
233

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


244
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
245
246
  """Activate local node as master node.

247
248
249
  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
250
251

  @type start_daemons: boolean
252
253
254
  @param start_daemons: whether to start the master daemons
      (ganeti-masterd and ganeti-rapi), or (if false) activate the
      master ip
255
256
257
  @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
258
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
259
260

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

264
  err_msgs = []
265
  # either start the master and rapi daemons
266
  if start_daemons:
267
    if no_voting:
268
269
270
271
272
273
274
275
276
277
278
279
280
      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)
281
282
283
  # or activate the IP
  else:
    if netutils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
284
      if netutils.IPAddress.Own(master_ip):
285
286
287
288
289
290
291
        # 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:
292
293
294
      ipcls = netutils.IP4Address
      if family == netutils.IP6Address.family:
        ipcls = netutils.IP6Address
295
296

      result = utils.RunCmd(["ip", "address", "add",
297
                             "%s/%d" % (master_ip, ipcls.iplen),
298
299
300
301
302
303
304
                             "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)

305
      # we ignore the exit code of the following cmds
306
      if ipcls == netutils.IP4Address:
307
308
        utils.RunCmd(["arping", "-q", "-U", "-c 3", "-I", master_netdev, "-s",
                      master_ip, master_ip])
309
      elif ipcls == netutils.IP6Address:
310
311
312
313
314
        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")
315

316
317
  if err_msgs:
    _Fail("; ".join(err_msgs))
318

Iustin Pop's avatar
Iustin Pop committed
319

320
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
321
322
  """Deactivate this node as master.

323
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
324
325
326
327
328
329
330
  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
331
332

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

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

339
340
341
  ipcls = netutils.IP4Address
  if family == netutils.IP6Address.family:
    ipcls = netutils.IP6Address
342
343

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

  if stop_daemons:
351
352
353
354
355
    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
356
357


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
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")


380
def LeaveCluster(modify_ssh_setup):
Iustin Pop's avatar
Iustin Pop committed
381
382
383
384
385
386
  """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
387
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
388
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
389

390
391
  @param modify_ssh_setup: boolean

Iustin Pop's avatar
Iustin Pop committed
392
  """
393
  _CleanDirectory(constants.DATA_DIR)
394
  _CleanDirectory(constants.CRYPTO_KEYS_DIR)
395
  JobQueuePurge()
396

397
398
399
  if modify_ssh_setup:
    try:
      priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
400

401
      utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
Iustin Pop's avatar
Iustin Pop committed
402

403
404
405
406
      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
407

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

415
416
417
418
  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)
419

420
421
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
422

Iustin Pop's avatar
Iustin Pop committed
423

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

427
428
429
430
431
432
433
434
435
436
437
438
  @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
439

440
  """
Iustin Pop's avatar
Iustin Pop committed
441
  outputarray = {}
442
443
444
445
446
447
448
449
450

  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
Iustin Pop's avatar
Iustin Pop committed
451

452
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
453
454
455
456
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

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

459
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
460
461


462
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
463
464
  """Verify the status of the local node.

465
466
467
468
469
470
471
472
473
  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
474

475
476
477
478
479
480
481
482
483
484
485
  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
486
487
488
  @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
489
490
491

  """
  result = {}
492
  my_name = netutils.Hostname.GetSysName()
493
  port = netutils.GetDaemonPort(constants.NODED)
Iustin Pop's avatar
Iustin Pop committed
494

495
496
497
  if constants.NV_HYPERVISOR in what:
    result[constants.NV_HYPERVISOR] = tmp = {}
    for hv_name in what[constants.NV_HYPERVISOR]:
498
499
500
501
502
      try:
        val = hypervisor.GetHypervisor(hv_name).Verify()
      except errors.HypervisorError, err:
        val = "Error while checking hypervisor: %s" % str(err)
      tmp[hv_name] = val
503
504
505
506
507
508
509
510
511

  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]:
512
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
513
      if not success:
514
515
516
517
        tmp[node] = message

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

539
540
541
542
543
  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:
544
      source = constants.IP4_ADDRESS_LOCALHOST
545
546
    else:
      source = None
547
    result[constants.NV_MASTERIP] = netutils.TcpPing(master_ip, port,
548
549
                                                  source=source)

550
  if constants.NV_LVLIST in what:
551
552
553
554
555
    try:
      val = GetVolumeList(what[constants.NV_LVLIST])
    except RPCFail, err:
      val = str(err)
    result[constants.NV_LVLIST] = val
556
557

  if constants.NV_INSTANCELIST in what:
558
559
560
561
562
563
    # GetInstanceList can fail
    try:
      val = GetInstanceList(what[constants.NV_INSTANCELIST])
    except RPCFail, err:
      val = str(err)
    result[constants.NV_INSTANCELIST] = val
564
565

  if constants.NV_VGLIST in what:
566
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
567

568
569
570
571
572
  if constants.NV_PVLIST in what:
    result[constants.NV_PVLIST] = \
      bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
                                   filter_allocatable=False)

573
  if constants.NV_VERSION in what:
574
575
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
576
577
578
579

  if constants.NV_HVINFO in what:
    hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
    result[constants.NV_HVINFO] = hyper.GetNodeInfo()
580

581
582
583
  if constants.NV_DRBDLIST in what:
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
584
    except errors.BlockDeviceError, err:
585
      logging.warning("Can't get used minors list", exc_info=True)
586
      used_minors = str(err)
587
588
    result[constants.NV_DRBDLIST] = used_minors

589
590
591
592
593
594
595
596
597
598
  if constants.NV_DRBDHELPER in what:
    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)

599
600
601
602
603
604
605
606
607
608
609
  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")
610
611
612
613

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

614
615
616
  if constants.NV_OSLIST in what:
    result[constants.NV_OSLIST] = DiagnoseOS()

617
  return result
Iustin Pop's avatar
Iustin Pop committed
618
619
620
621
622


def GetVolumeList(vg_name):
  """Compute list of logical volumes and their size.

Iustin Pop's avatar
Iustin Pop committed
623
624
625
626
627
628
629
630
631
632
633
  @type vg_name: str
  @param vg_name: the volume group whose LVs we should list
  @rtype: dict
  @return:
      dictionary of all partions (key) with value being a tuple of
      their size (in MiB), inactive and online status::

        {'test1': ('20.06', True, True)}

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

  """
636
637
638
639
640
  lvs = {}
  sep = '|'
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=%s" % sep,
                         "-olv_name,lv_size,lv_attr", vg_name])
Iustin Pop's avatar
Iustin Pop committed
641
  if result.failed:
642
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
643

644
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
645
  for line in result.stdout.splitlines():
646
647
648
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
649
      logging.error("Invalid line returned from lvs output: '%s'", line)
650
651
      continue
    name, size, attr = match.groups()
652
653
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
Iustin Pop's avatar
Iustin Pop committed
654
655
656
657
658
    virtual = attr[0] == 'v'
    if virtual:
      # we don't want to report such volumes as existing, since they
      # don't really hold data
      continue
659
660
661
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
662
663
664


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

Iustin Pop's avatar
Iustin Pop committed
667
668
669
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
670
671

  """
672
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
673
674


675
676
677
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
  @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.

693
694
695
696
697
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
698
699
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
700
701

  def parse_dev(dev):
702
703
704
705
    return dev.split('(')[0]

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

  def map_line(line):
708
709
710
711
712
713
714
715
716
717
718
    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
719
720


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

Iustin Pop's avatar
Iustin Pop committed
724
725
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
726
727

  """
728
  missing = []
Iustin Pop's avatar
Iustin Pop committed
729
730
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
731
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
732

733
  if missing:
734
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
735

Iustin Pop's avatar
Iustin Pop committed
736

737
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
738
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
739

740
741
742
743
744
  @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
745
746
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
747

748
  """
749
750
751
752
753
754
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
755
756
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
757

758
  return results
Iustin Pop's avatar
Iustin Pop committed
759
760


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

764
765
766
767
  @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
768

769
770
771
772
773
  @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
774

775
  """
Iustin Pop's avatar
Iustin Pop committed
776
777
  output = {}

778
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
779
780
781
782
783
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

784
  return output
Iustin Pop's avatar
Iustin Pop committed
785
786


787
788
789
790
791
792
793
794
795
796
797
798
799
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)
800
801
802
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
803
804

  for idx in range(len(instance.disks)):
805
    link_name = _GetBlockDevSymlinkPath(iname, idx)
806
    if not os.path.islink(link_name):
807
808
      logging.warning("Instance %s is missing symlink %s for disk %d",
                      iname, link_name, idx)
809
810


811
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
812
813
  """Gather data about all instances.

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

818
819
820
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

821
  @rtype: dict
822
823
824
825
  @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
826
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
827

828
  """
Iustin Pop's avatar
Iustin Pop committed
829
830
  output = {}

831
832
833
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
834
      for name, _, memory, vcpus, state, times in iinfo:
835
        value = {
836
837
838
839
840
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
841
842
843
844
845
846
        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]:
847
848
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
849
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
850

851
  return output
Iustin Pop's avatar
Iustin Pop committed
852
853


Iustin Pop's avatar
Iustin Pop committed
854
855
856
857
858
859
860
861
862
863
864
865
866
867
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.

  """
868
  # TODO: Use tempfile.mkstemp to create unique filename
869
870
  base = ("%s-%s-%s-%s.log" %
          (kind, os_name, instance, utils.TimestampForFilename()))
Iustin Pop's avatar
Iustin Pop committed
871
872
873
  return utils.PathJoin(constants.LOG_OS_DIR, base)


874
def InstanceOsAdd(instance, reinstall, debug):
Alexander Schreiber's avatar
Alexander Schreiber committed
875
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
876

877
878
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
879
880
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
881
882
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
883
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
884
885

  """
886
887
  inst_os = OSFromDisk(instance.os)

888
  create_env = OSEnvironment(instance, inst_os, debug)
889
890
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
891

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

894
895
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
896
  if result.failed:
897
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
898
                  " output: %s", result.cmd, result.fail_reason, logfile,
899
                  result.output)
900
    lines = [utils.SafeEncode(val)
901
             for val in utils.TailFile(logfile, lines=20)]
902
903
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
904
905


906
def RunRenameInstance(instance, old_name, debug):
907
908
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
909
  @type instance: L{objects.Instance}
910
911
912
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
913
914
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
Iustin Pop's avatar
Iustin Pop committed
915
916
  @rtype: boolean
  @return: the success of the operation
917
918
919
920

  """
  inst_os = OSFromDisk(instance.os)

921
  rename_env = OSEnvironment(instance, inst_os, debug)
922
  rename_env['OLD_INSTANCE_NAME'] = old_name
923

Iustin Pop's avatar
Iustin Pop committed
924
925
  logfile = _InstanceLogName("rename", instance.os,
                             "%s-%s" % (old_name, instance.name))
Iustin Pop's avatar
Iustin Pop committed
926

927
928
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
929
930

  if result.failed:
931
    logging.error("os create command '%s' returned error: %s output: %s",
932
                  result.cmd, result.fail_reason, result.output)
933
    lines = [utils.SafeEncode(val)
934
             for val in utils.TailFile(logfile, lines=20)]
935
936
    _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
937
938


939
def _GetBlockDevSymlinkPath(instance_name, idx):
940
941
  return utils.PathJoin(constants.DISK_LINKS_DIR,
                        "%s:%d" % (instance_name, idx))
942
943
944


def _SymlinkBlockDev(instance_name, device_path, idx):
945
946
947
948
949
950
  """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).


951
952
953
954
  @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
955
956

  """
957
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
958
959
  try:
    os.symlink(device_path, link_name)
960
961
  except OSError, err:
    if err.errno == errno.EEXIST:
962
963
964
965
966
967
968
969
970
971
      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


972
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
973
974
975
  """Remove the block device symlinks belonging to the given instance.

  """
Iustin Pop's avatar
Iustin Pop committed
976
  for idx, _ in enumerate(disks):
977
978
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
979
      try:
980
981
982
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
983
984


985
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
986
987
988
989
990
  """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
991
992
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
993
994
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
995

Iustin Pop's avatar
Iustin Pop committed
996
997
  """
  block_devices = []
998
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
999
1000
1001
1002
1003
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
1004
    try:
1005
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
1006
1007
1008
1009
1010
1011
    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
1012
1013
1014
  return block_devices


1015
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
1016
1017
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
1018
  @type instance: L{objects.Instance}
1019
  @param instance: the instance object
1020
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1021

1022
  """
1023
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
1024
1025

  if instance.name in running_instances:
1026
1027
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
1028
1029

  try:
1030
1031
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
1032
    hyper.StartInstance(instance, block_devices)
1033
  except errors.BlockDeviceError, err:
1034
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
1035
  except errors.HypervisorError, err:
1036
    _RemoveBlockDevLinks(instance.name, instance.disks)
1037
    _Fail("Hypervisor error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
1038
1039


1040
def InstanceShutdown(instance, timeout):
Iustin Pop's avatar
Iustin Pop committed
1041
1042
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
1043
1044
1045
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
1046
  @param instance: the instance object
1047
1048
  @type timeout: integer
  @param timeout: maximum timeout for soft shutdown
1049
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1050

1051
  """
1052
  hv_name = instance.hypervisor
1053
  hyper = hypervisor.GetHypervisor(hv_name)
1054
  iname = instance.name