Statistics
| Branch: | Tag: | Revision:

root / lib / backend.py @ be9150ea

History | View | Annotate | Download (134.6 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 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
"""Functions used by the node daemon
23

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

29
"""
30

    
31
# pylint: disable=E1103
32

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

    
37

    
38
import os
39
import os.path
40
import shutil
41
import time
42
import stat
43
import errno
44
import re
45
import random
46
import logging
47
import tempfile
48
import zlib
49
import base64
50
import signal
51

    
52
from ganeti import errors
53
from ganeti import utils
54
from ganeti import ssh
55
from ganeti import hypervisor
56
from ganeti import constants
57
from ganeti.storage import bdev
58
from ganeti.storage import drbd
59
from ganeti.storage import filestorage
60
from ganeti import objects
61
from ganeti import ssconf
62
from ganeti import serializer
63
from ganeti import netutils
64
from ganeti import runtime
65
from ganeti import compat
66
from ganeti import pathutils
67
from ganeti import vcluster
68
from ganeti import ht
69
from ganeti.storage.base import BlockDev
70
from ganeti.storage.drbd import DRBD8
71
from ganeti import hooksmaster
72

    
73

    
74
_BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"
75
_ALLOWED_CLEAN_DIRS = compat.UniqueFrozenset([
76
  pathutils.DATA_DIR,
77
  pathutils.JOB_QUEUE_ARCHIVE_DIR,
78
  pathutils.QUEUE_DIR,
79
  pathutils.CRYPTO_KEYS_DIR,
80
  ])
81
_MAX_SSL_CERT_VALIDITY = 7 * 24 * 60 * 60
82
_X509_KEY_FILE = "key"
83
_X509_CERT_FILE = "cert"
84
_IES_STATUS_FILE = "status"
85
_IES_PID_FILE = "pid"
86
_IES_CA_FILE = "ca"
87

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

    
91
# Actions for the master setup script
92
_MASTER_START = "start"
93
_MASTER_STOP = "stop"
94

    
95
#: Maximum file permissions for restricted command directory and executables
96
_RCMD_MAX_MODE = (stat.S_IRWXU |
97
                  stat.S_IRGRP | stat.S_IXGRP |
98
                  stat.S_IROTH | stat.S_IXOTH)
99

    
100
#: Delay before returning an error for restricted commands
101
_RCMD_INVALID_DELAY = 10
102

    
103
#: How long to wait to acquire lock for restricted commands (shorter than
104
#: L{_RCMD_INVALID_DELAY}) to reduce blockage of noded forks when many
105
#: command requests arrive
106
_RCMD_LOCK_TIMEOUT = _RCMD_INVALID_DELAY * 0.8
107

    
108

    
109
class RPCFail(Exception):
110
  """Class denoting RPC failure.
111

112
  Its argument is the error message.
113

114
  """
115

    
116

    
117
def _GetInstReasonFilename(instance_name):
118
  """Path of the file containing the reason of the instance status change.
119

120
  @type instance_name: string
121
  @param instance_name: The name of the instance
122
  @rtype: string
123
  @return: The path of the file
124

125
  """
126
  return utils.PathJoin(pathutils.INSTANCE_REASON_DIR, instance_name)
127

    
128

    
129
def _StoreInstReasonTrail(instance_name, trail):
130
  """Serialize a reason trail related to an instance change of state to file.
131

132
  The exact location of the file depends on the name of the instance and on
133
  the configuration of the Ganeti cluster defined at deploy time.
134

135
  @type instance_name: string
136
  @param instance_name: The name of the instance
137
  @rtype: None
138

139
  """
140
  json = serializer.DumpJson(trail)
141
  filename = _GetInstReasonFilename(instance_name)
142
  utils.WriteFile(filename, data=json)
143

    
144

    
145
def _Fail(msg, *args, **kwargs):
146
  """Log an error and the raise an RPCFail exception.
147

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

153
  @type msg: string
154
  @param msg: the text of the exception
155
  @raise RPCFail
156

157
  """
158
  if args:
159
    msg = msg % args
160
  if "log" not in kwargs or kwargs["log"]: # if we should log this error
161
    if "exc" in kwargs and kwargs["exc"]:
162
      logging.exception(msg)
163
    else:
164
      logging.error(msg)
165
  raise RPCFail(msg)
166

    
167

    
168
def _GetConfig():
169
  """Simple wrapper to return a SimpleStore.
170

171
  @rtype: L{ssconf.SimpleStore}
172
  @return: a SimpleStore instance
173

174
  """
175
  return ssconf.SimpleStore()
176

    
177

    
178
def _GetSshRunner(cluster_name):
179
  """Simple wrapper to return an SshRunner.
180

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

187
  """
188
  return ssh.SshRunner(cluster_name)
189

    
190

    
191
def _Decompress(data):
192
  """Unpacks data compressed by the RPC client.
193

194
  @type data: list or tuple
195
  @param data: Data sent by RPC client
196
  @rtype: str
197
  @return: Decompressed data
198

199
  """
200
  assert isinstance(data, (list, tuple))
201
  assert len(data) == 2
202
  (encoding, content) = data
203
  if encoding == constants.RPC_ENCODING_NONE:
204
    return content
205
  elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
206
    return zlib.decompress(base64.b64decode(content))
207
  else:
208
    raise AssertionError("Unknown data encoding")
209

    
210

    
211
def _CleanDirectory(path, exclude=None):
212
  """Removes all regular files in a directory.
213

214
  @type path: str
215
  @param path: the directory to clean
216
  @type exclude: list
217
  @param exclude: list of files to be excluded, defaults
218
      to the empty list
219

220
  """
221
  if path not in _ALLOWED_CLEAN_DIRS:
222
    _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'",
223
          path)
224

    
225
  if not os.path.isdir(path):
226
    return
227
  if exclude is None:
228
    exclude = []
229
  else:
230
    # Normalize excluded paths
231
    exclude = [os.path.normpath(i) for i in exclude]
232

    
233
  for rel_name in utils.ListVisibleFiles(path):
234
    full_name = utils.PathJoin(path, rel_name)
235
    if full_name in exclude:
236
      continue
237
    if os.path.isfile(full_name) and not os.path.islink(full_name):
238
      utils.RemoveFile(full_name)
239

    
240

    
241
def _BuildUploadFileList():
242
  """Build the list of allowed upload files.
243

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

246
  """
247
  allowed_files = set([
248
    pathutils.CLUSTER_CONF_FILE,
249
    pathutils.ETC_HOSTS,
250
    pathutils.SSH_KNOWN_HOSTS_FILE,
251
    pathutils.VNC_PASSWORD_FILE,
252
    pathutils.RAPI_CERT_FILE,
253
    pathutils.SPICE_CERT_FILE,
254
    pathutils.SPICE_CACERT_FILE,
255
    pathutils.RAPI_USERS_FILE,
256
    pathutils.CONFD_HMAC_KEY,
257
    pathutils.CLUSTER_DOMAIN_SECRET_FILE,
258
    ])
259

    
260
  for hv_name in constants.HYPER_TYPES:
261
    hv_class = hypervisor.GetHypervisorClass(hv_name)
262
    allowed_files.update(hv_class.GetAncillaryFiles()[0])
263

    
264
  assert pathutils.FILE_STORAGE_PATHS_FILE not in allowed_files, \
265
    "Allowed file storage paths should never be uploaded via RPC"
266

    
267
  return frozenset(allowed_files)
268

    
269

    
270
_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()
271

    
272

    
273
def JobQueuePurge():
274
  """Removes job queue files and archived jobs.
275

276
  @rtype: tuple
277
  @return: True, None
278

279
  """
280
  _CleanDirectory(pathutils.QUEUE_DIR, exclude=[pathutils.JOB_QUEUE_LOCK_FILE])
281
  _CleanDirectory(pathutils.JOB_QUEUE_ARCHIVE_DIR)
282

    
283

    
284
def GetMasterInfo():
285
  """Returns master information.
286

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

290
  @rtype: tuple
291
  @return: master_netdev, master_ip, master_name, primary_ip_family,
292
    master_netmask
293
  @raise RPCFail: in case of errors
294

295
  """
296
  try:
297
    cfg = _GetConfig()
298
    master_netdev = cfg.GetMasterNetdev()
299
    master_ip = cfg.GetMasterIP()
300
    master_netmask = cfg.GetMasterNetmask()
301
    master_node = cfg.GetMasterNode()
302
    primary_ip_family = cfg.GetPrimaryIPFamily()
303
  except errors.ConfigurationError, err:
304
    _Fail("Cluster configuration incomplete: %s", err, exc=True)
305
  return (master_netdev, master_ip, master_node, primary_ip_family,
306
          master_netmask)
307

    
308

    
309
def RunLocalHooks(hook_opcode, hooks_path, env_builder_fn):
310
  """Decorator that runs hooks before and after the decorated function.
311

312
  @type hook_opcode: string
313
  @param hook_opcode: opcode of the hook
314
  @type hooks_path: string
315
  @param hooks_path: path of the hooks
316
  @type env_builder_fn: function
317
  @param env_builder_fn: function that returns a dictionary containing the
318
    environment variables for the hooks. Will get all the parameters of the
319
    decorated function.
320
  @raise RPCFail: in case of pre-hook failure
321

322
  """
323
  def decorator(fn):
324
    def wrapper(*args, **kwargs):
325
      _, myself = ssconf.GetMasterAndMyself()
326
      nodes = ([myself], [myself])  # these hooks run locally
327

    
328
      env_fn = compat.partial(env_builder_fn, *args, **kwargs)
329

    
330
      cfg = _GetConfig()
331
      hr = HooksRunner()
332
      hm = hooksmaster.HooksMaster(hook_opcode, hooks_path, nodes,
333
                                   hr.RunLocalHooks, None, env_fn,
334
                                   logging.warning, cfg.GetClusterName(),
335
                                   cfg.GetMasterNode())
336
      hm.RunPhase(constants.HOOKS_PHASE_PRE)
337
      result = fn(*args, **kwargs)
338
      hm.RunPhase(constants.HOOKS_PHASE_POST)
339

    
340
      return result
341
    return wrapper
342
  return decorator
343

    
344

    
345
def _BuildMasterIpEnv(master_params, use_external_mip_script=None):
346
  """Builds environment variables for master IP hooks.
347

348
  @type master_params: L{objects.MasterNetworkParameters}
349
  @param master_params: network parameters of the master
350
  @type use_external_mip_script: boolean
351
  @param use_external_mip_script: whether to use an external master IP
352
    address setup script (unused, but necessary per the implementation of the
353
    _RunLocalHooks decorator)
354

355
  """
356
  # pylint: disable=W0613
357
  ver = netutils.IPAddress.GetVersionFromAddressFamily(master_params.ip_family)
358
  env = {
359
    "MASTER_NETDEV": master_params.netdev,
360
    "MASTER_IP": master_params.ip,
361
    "MASTER_NETMASK": str(master_params.netmask),
362
    "CLUSTER_IP_VERSION": str(ver),
363
  }
364

    
365
  return env
366

    
367

    
368
def _RunMasterSetupScript(master_params, action, use_external_mip_script):
369
  """Execute the master IP address setup script.
370

371
  @type master_params: L{objects.MasterNetworkParameters}
372
  @param master_params: network parameters of the master
373
  @type action: string
374
  @param action: action to pass to the script. Must be one of
375
    L{backend._MASTER_START} or L{backend._MASTER_STOP}
376
  @type use_external_mip_script: boolean
377
  @param use_external_mip_script: whether to use an external master IP
378
    address setup script
379
  @raise backend.RPCFail: if there are errors during the execution of the
380
    script
381

382
  """
383
  env = _BuildMasterIpEnv(master_params)
384

    
385
  if use_external_mip_script:
386
    setup_script = pathutils.EXTERNAL_MASTER_SETUP_SCRIPT
387
  else:
388
    setup_script = pathutils.DEFAULT_MASTER_SETUP_SCRIPT
389

    
390
  result = utils.RunCmd([setup_script, action], env=env, reset_env=True)
391

    
392
  if result.failed:
393
    _Fail("Failed to %s the master IP. Script return value: %s, output: '%s'" %
394
          (action, result.exit_code, result.output), log=True)
395

    
396

    
397
@RunLocalHooks(constants.FAKE_OP_MASTER_TURNUP, "master-ip-turnup",
398
               _BuildMasterIpEnv)
399
def ActivateMasterIp(master_params, use_external_mip_script):
400
  """Activate the IP address of the master daemon.
401

402
  @type master_params: L{objects.MasterNetworkParameters}
403
  @param master_params: network parameters of the master
404
  @type use_external_mip_script: boolean
405
  @param use_external_mip_script: whether to use an external master IP
406
    address setup script
407
  @raise RPCFail: in case of errors during the IP startup
408

409
  """
410
  _RunMasterSetupScript(master_params, _MASTER_START,
411
                        use_external_mip_script)
412

    
413

    
414
def StartMasterDaemons(no_voting):
415
  """Activate local node as master node.
416

417
  The function will start the master daemons (ganeti-masterd and ganeti-rapi).
418

419
  @type no_voting: boolean
420
  @param no_voting: whether to start ganeti-masterd without a node vote
421
      but still non-interactively
422
  @rtype: None
423

424
  """
425

    
426
  if no_voting:
427
    masterd_args = "--no-voting --yes-do-it"
428
  else:
429
    masterd_args = ""
430

    
431
  env = {
432
    "EXTRA_MASTERD_ARGS": masterd_args,
433
    }
434

    
435
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start-master"], env=env)
436
  if result.failed:
437
    msg = "Can't start Ganeti master: %s" % result.output
438
    logging.error(msg)
439
    _Fail(msg)
440

    
441

    
442
@RunLocalHooks(constants.FAKE_OP_MASTER_TURNDOWN, "master-ip-turndown",
443
               _BuildMasterIpEnv)
444
def DeactivateMasterIp(master_params, use_external_mip_script):
445
  """Deactivate the master IP on this node.
446

447
  @type master_params: L{objects.MasterNetworkParameters}
448
  @param master_params: network parameters of the master
449
  @type use_external_mip_script: boolean
450
  @param use_external_mip_script: whether to use an external master IP
451
    address setup script
452
  @raise RPCFail: in case of errors during the IP turndown
453

454
  """
455
  _RunMasterSetupScript(master_params, _MASTER_STOP,
456
                        use_external_mip_script)
457

    
458

    
459
def StopMasterDaemons():
460
  """Stop the master daemons on this node.
461

462
  Stop the master daemons (ganeti-masterd and ganeti-rapi) on this node.
463

464
  @rtype: None
465

466
  """
467
  # TODO: log and report back to the caller the error failures; we
468
  # need to decide in which case we fail the RPC for this
469

    
470
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "stop-master"])
471
  if result.failed:
472
    logging.error("Could not stop Ganeti master, command %s had exitcode %s"
473
                  " and error %s",
474
                  result.cmd, result.exit_code, result.output)
475

    
476

    
477
def ChangeMasterNetmask(old_netmask, netmask, master_ip, master_netdev):
478
  """Change the netmask of the master IP.
479

480
  @param old_netmask: the old value of the netmask
481
  @param netmask: the new value of the netmask
482
  @param master_ip: the master IP
483
  @param master_netdev: the master network device
484

485
  """
486
  if old_netmask == netmask:
487
    return
488

    
489
  if not netutils.IPAddress.Own(master_ip):
490
    _Fail("The master IP address is not up, not attempting to change its"
491
          " netmask")
492

    
493
  result = utils.RunCmd([constants.IP_COMMAND_PATH, "address", "add",
494
                         "%s/%s" % (master_ip, netmask),
495
                         "dev", master_netdev, "label",
496
                         "%s:0" % master_netdev])
497
  if result.failed:
498
    _Fail("Could not set the new netmask on the master IP address")
499

    
500
  result = utils.RunCmd([constants.IP_COMMAND_PATH, "address", "del",
501
                         "%s/%s" % (master_ip, old_netmask),
502
                         "dev", master_netdev, "label",
503
                         "%s:0" % master_netdev])
504
  if result.failed:
505
    _Fail("Could not bring down the master IP address with the old netmask")
506

    
507

    
508
def EtcHostsModify(mode, host, ip):
509
  """Modify a host entry in /etc/hosts.
510

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

515
  """
516
  if mode == constants.ETC_HOSTS_ADD:
517
    if not ip:
518
      RPCFail("Mode 'add' needs 'ip' parameter, but parameter not"
519
              " present")
520
    utils.AddHostToEtcHosts(host, ip)
521
  elif mode == constants.ETC_HOSTS_REMOVE:
522
    if ip:
523
      RPCFail("Mode 'remove' does not allow 'ip' parameter, but"
524
              " parameter is present")
525
    utils.RemoveHostFromEtcHosts(host)
526
  else:
527
    RPCFail("Mode not supported")
528

    
529

    
530
def LeaveCluster(modify_ssh_setup):
531
  """Cleans up and remove the current node.
532

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

536
  If processing is successful, then it raises an
537
  L{errors.QuitGanetiException} which is used as a special case to
538
  shutdown the node daemon.
539

540
  @param modify_ssh_setup: boolean
541

542
  """
543
  _CleanDirectory(pathutils.DATA_DIR)
544
  _CleanDirectory(pathutils.CRYPTO_KEYS_DIR)
545
  JobQueuePurge()
546

    
547
  if modify_ssh_setup:
548
    try:
549
      priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.SSH_LOGIN_USER)
550

    
551
      utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
552

    
553
      utils.RemoveFile(priv_key)
554
      utils.RemoveFile(pub_key)
555
    except errors.OpExecError:
556
      logging.exception("Error while processing ssh files")
557

    
558
  try:
559
    utils.RemoveFile(pathutils.CONFD_HMAC_KEY)
560
    utils.RemoveFile(pathutils.RAPI_CERT_FILE)
561
    utils.RemoveFile(pathutils.SPICE_CERT_FILE)
562
    utils.RemoveFile(pathutils.SPICE_CACERT_FILE)
563
    utils.RemoveFile(pathutils.NODED_CERT_FILE)
564
  except: # pylint: disable=W0702
565
    logging.exception("Error while removing cluster secrets")
566

    
567
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "stop", constants.CONFD])
568
  if result.failed:
569
    logging.error("Command %s failed with exitcode %s and error %s",
570
                  result.cmd, result.exit_code, result.output)
571

    
572
  # Raise a custom exception (handled in ganeti-noded)
573
  raise errors.QuitGanetiException(True, "Shutdown scheduled")
574

    
575

    
576
def _GetVgInfo(name, excl_stor):
577
  """Retrieves information about a LVM volume group.
578

579
  """
580
  # TODO: GetVGInfo supports returning information for multiple VGs at once
581
  vginfo = bdev.LogicalVolume.GetVGInfo([name], excl_stor)
582
  if vginfo:
583
    vg_free = int(round(vginfo[0][0], 0))
584
    vg_size = int(round(vginfo[0][1], 0))
585
  else:
586
    vg_free = None
587
    vg_size = None
588

    
589
  return {
590
    "type": constants.ST_LVM_VG,
591
    "name": name,
592
    "storage_free": vg_free,
593
    "storage_size": vg_size,
594
    }
595

    
596

    
597
def _GetVgSpindlesInfo(name, excl_stor):
598
  """Retrieves information about spindles in an LVM volume group.
599

600
  @type name: string
601
  @param name: VG name
602
  @type excl_stor: bool
603
  @param excl_stor: exclusive storage
604
  @rtype: dict
605
  @return: dictionary whose keys are "name", "vg_free", "vg_size" for VG name,
606
      free spindles, total spindles respectively
607

608
  """
609
  if excl_stor:
610
    (vg_free, vg_size) = bdev.LogicalVolume.GetVgSpindlesInfo(name)
611
  else:
612
    vg_free = 0
613
    vg_size = 0
614
  return {
615
    "type": constants.ST_LVM_PV,
616
    "name": name,
617
    "storage_free": vg_free,
618
    "storage_size": vg_size,
619
    }
620

    
621

    
622
def _GetHvInfo(name, hvparams, get_hv_fn=hypervisor.GetHypervisor):
623
  """Retrieves node information from a hypervisor.
624

625
  The information returned depends on the hypervisor. Common items:
626

627
    - vg_size is the size of the configured volume group in MiB
628
    - vg_free is the free size of the volume group in MiB
629
    - memory_dom0 is the memory allocated for domain0 in MiB
630
    - memory_free is the currently available (free) ram in MiB
631
    - memory_total is the total number of ram in MiB
632
    - hv_version: the hypervisor version, if available
633

634
  @type hvparams: dict of string
635
  @param hvparams: the hypervisor's hvparams
636

637
  """
638
  return get_hv_fn(name).GetNodeInfo(hvparams=hvparams)
639

    
640

    
641
def _GetHvInfoAll(hv_specs, get_hv_fn=hypervisor.GetHypervisor):
642
  """Retrieves node information for all hypervisors.
643

644
  See C{_GetHvInfo} for information on the output.
645

646
  @type hv_specs: list of pairs (string, dict of strings)
647
  @param hv_specs: list of pairs of a hypervisor's name and its hvparams
648

649
  """
650
  if hv_specs is None:
651
    return None
652

    
653
  result = []
654
  for hvname, hvparams in hv_specs:
655
    result.append(_GetHvInfo(hvname, hvparams, get_hv_fn))
656
  return result
657

    
658

    
659
def _GetNamedNodeInfo(names, fn):
660
  """Calls C{fn} for all names in C{names} and returns a dictionary.
661

662
  @rtype: None or dict
663

664
  """
665
  if names is None:
666
    return None
667
  else:
668
    return map(fn, names)
669

    
670

    
671
def GetNodeInfo(storage_units, hv_specs, excl_stor):
672
  """Gives back a hash with different information about the node.
673

674
  @type storage_units: list of pairs (string, string)
675
  @param storage_units: List of pairs (storage unit, identifier) to ask for disk
676
                        space information. In case of lvm-vg, the identifier is
677
                        the VG name.
678
  @type hv_specs: list of pairs (string, dict of strings)
679
  @param hv_specs: list of pairs of a hypervisor's name and its hvparams
680
  @type excl_stor: boolean
681
  @param excl_stor: Whether exclusive_storage is active
682
  @rtype: tuple; (string, None/dict, None/dict)
683
  @return: Tuple containing boot ID, volume group information and hypervisor
684
    information
685

686
  """
687
  bootid = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
688
  storage_info = _GetNamedNodeInfo(
689
    storage_units,
690
    (lambda storage_unit: _ApplyStorageInfoFunction(storage_unit[0],
691
                                                    storage_unit[1],
692
                                                    excl_stor)))
693
  hv_info = _GetHvInfoAll(hv_specs)
694
  return (bootid, storage_info, hv_info)
695

    
696

    
697
# pylint: disable=W0613
698
def _GetFileStorageSpaceInfo(path, *args):
699
  """Wrapper around filestorage.GetSpaceInfo.
700

701
  The purpose of this wrapper is to call filestorage.GetFileStorageSpaceInfo
702
  and ignore the *args parameter to not leak it into the filestorage
703
  module's code.
704

705
  @see: C{filestorage.GetFileStorageSpaceInfo} for description of the
706
    parameters.
707

708
  """
709
  return filestorage.GetFileStorageSpaceInfo(path)
710

    
711

    
712
# FIXME: implement storage reporting for all missing storage types.
713
_STORAGE_TYPE_INFO_FN = {
714
  constants.ST_BLOCK: None,
715
  constants.ST_DISKLESS: None,
716
  constants.ST_EXT: None,
717
  constants.ST_FILE: _GetFileStorageSpaceInfo,
718
  constants.ST_LVM_PV: _GetVgSpindlesInfo,
719
  constants.ST_LVM_VG: _GetVgInfo,
720
  constants.ST_RADOS: None,
721
}
722

    
723

    
724
def _ApplyStorageInfoFunction(storage_type, storage_key, *args):
725
  """Looks up and applies the correct function to calculate free and total
726
  storage for the given storage type.
727

728
  @type storage_type: string
729
  @param storage_type: the storage type for which the storage shall be reported.
730
  @type storage_key: string
731
  @param storage_key: identifier of a storage unit, e.g. the volume group name
732
    of an LVM storage unit
733
  @type args: any
734
  @param args: various parameters that can be used for storage reporting. These
735
    parameters and their semantics vary from storage type to storage type and
736
    are just propagated in this function.
737
  @return: the results of the application of the storage space function (see
738
    _STORAGE_TYPE_INFO_FN) if storage space reporting is implemented for that
739
    storage type
740
  @raises NotImplementedError: for storage types who don't support space
741
    reporting yet
742
  """
743
  fn = _STORAGE_TYPE_INFO_FN[storage_type]
744
  if fn is not None:
745
    return fn(storage_key, *args)
746
  else:
747
    raise NotImplementedError
748

    
749

    
750
def _CheckExclusivePvs(pvi_list):
751
  """Check that PVs are not shared among LVs
752

753
  @type pvi_list: list of L{objects.LvmPvInfo} objects
754
  @param pvi_list: information about the PVs
755

756
  @rtype: list of tuples (string, list of strings)
757
  @return: offending volumes, as tuples: (pv_name, [lv1_name, lv2_name...])
758

759
  """
760
  res = []
761
  for pvi in pvi_list:
762
    if len(pvi.lv_list) > 1:
763
      res.append((pvi.name, pvi.lv_list))
764
  return res
765

    
766

    
767
def _VerifyHypervisors(what, vm_capable, result, all_hvparams,
768
                       get_hv_fn=hypervisor.GetHypervisor):
769
  """Verifies the hypervisor. Appends the results to the 'results' list.
770

771
  @type what: C{dict}
772
  @param what: a dictionary of things to check
773
  @type vm_capable: boolean
774
  @param vm_capable: whether or not this node is vm capable
775
  @type result: dict
776
  @param result: dictionary of verification results; results of the
777
    verifications in this function will be added here
778
  @type all_hvparams: dict of dict of string
779
  @param all_hvparams: dictionary mapping hypervisor names to hvparams
780
  @type get_hv_fn: function
781
  @param get_hv_fn: function to retrieve the hypervisor, to improve testability
782

783
  """
784
  if not vm_capable:
785
    return
786

    
787
  if constants.NV_HYPERVISOR in what:
788
    result[constants.NV_HYPERVISOR] = {}
789
    for hv_name in what[constants.NV_HYPERVISOR]:
790
      hvparams = all_hvparams[hv_name]
791
      try:
792
        val = get_hv_fn(hv_name).Verify(hvparams=hvparams)
793
      except errors.HypervisorError, err:
794
        val = "Error while checking hypervisor: %s" % str(err)
795
      result[constants.NV_HYPERVISOR][hv_name] = val
796

    
797

    
798
def _VerifyHvparams(what, vm_capable, result,
799
                    get_hv_fn=hypervisor.GetHypervisor):
800
  """Verifies the hvparams. Appends the results to the 'results' list.
801

802
  @type what: C{dict}
803
  @param what: a dictionary of things to check
804
  @type vm_capable: boolean
805
  @param vm_capable: whether or not this node is vm capable
806
  @type result: dict
807
  @param result: dictionary of verification results; results of the
808
    verifications in this function will be added here
809
  @type get_hv_fn: function
810
  @param get_hv_fn: function to retrieve the hypervisor, to improve testability
811

812
  """
813
  if not vm_capable:
814
    return
815

    
816
  if constants.NV_HVPARAMS in what:
817
    result[constants.NV_HVPARAMS] = []
818
    for source, hv_name, hvparms in what[constants.NV_HVPARAMS]:
819
      try:
820
        logging.info("Validating hv %s, %s", hv_name, hvparms)
821
        get_hv_fn(hv_name).ValidateParameters(hvparms)
822
      except errors.HypervisorError, err:
823
        result[constants.NV_HVPARAMS].append((source, hv_name, str(err)))
824

    
825

    
826
def _VerifyInstanceList(what, vm_capable, result, all_hvparams):
827
  """Verifies the instance list.
828

829
  @type what: C{dict}
830
  @param what: a dictionary of things to check
831
  @type vm_capable: boolean
832
  @param vm_capable: whether or not this node is vm capable
833
  @type result: dict
834
  @param result: dictionary of verification results; results of the
835
    verifications in this function will be added here
836
  @type all_hvparams: dict of dict of string
837
  @param all_hvparams: dictionary mapping hypervisor names to hvparams
838

839
  """
840
  if constants.NV_INSTANCELIST in what and vm_capable:
841
    # GetInstanceList can fail
842
    try:
843
      val = GetInstanceList(what[constants.NV_INSTANCELIST],
844
                            all_hvparams=all_hvparams)
845
    except RPCFail, err:
846
      val = str(err)
847
    result[constants.NV_INSTANCELIST] = val
848

    
849

    
850
def _VerifyNodeInfo(what, vm_capable, result, all_hvparams):
851
  """Verifies the node info.
852

853
  @type what: C{dict}
854
  @param what: a dictionary of things to check
855
  @type vm_capable: boolean
856
  @param vm_capable: whether or not this node is vm capable
857
  @type result: dict
858
  @param result: dictionary of verification results; results of the
859
    verifications in this function will be added here
860
  @type all_hvparams: dict of dict of string
861
  @param all_hvparams: dictionary mapping hypervisor names to hvparams
862

863
  """
864
  if constants.NV_HVINFO in what and vm_capable:
865
    hvname = what[constants.NV_HVINFO]
866
    hyper = hypervisor.GetHypervisor(hvname)
867
    hvparams = all_hvparams[hvname]
868
    result[constants.NV_HVINFO] = hyper.GetNodeInfo(hvparams=hvparams)
869

    
870

    
871
def VerifyNode(what, cluster_name, all_hvparams):
872
  """Verify the status of the local node.
873

874
  Based on the input L{what} parameter, various checks are done on the
875
  local node.
876

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

880
  If the I{nodelist} key is present, we check that we have
881
  connectivity via ssh with the target nodes (and check the hostname
882
  report).
883

884
  If the I{node-net-test} key is present, we check that we have
885
  connectivity to the given nodes via both primary IP and, if
886
  applicable, secondary IPs.
887

888
  @type what: C{dict}
889
  @param what: a dictionary of things to check:
890
      - filelist: list of files for which to compute checksums
891
      - nodelist: list of nodes we should check ssh communication with
892
      - node-net-test: list of nodes we should check node daemon port
893
        connectivity with
894
      - hypervisor: list with hypervisors to run the verify for
895
  @type cluster_name: string
896
  @param cluster_name: the cluster's name
897
  @type all_hvparams: dict of dict of strings
898
  @param all_hvparams: a dictionary mapping hypervisor names to hvparams
899
  @rtype: dict
900
  @return: a dictionary with the same keys as the input dict, and
901
      values representing the result of the checks
902

903
  """
904
  result = {}
905
  my_name = netutils.Hostname.GetSysName()
906
  port = netutils.GetDaemonPort(constants.NODED)
907
  vm_capable = my_name not in what.get(constants.NV_VMNODES, [])
908

    
909
  _VerifyHypervisors(what, vm_capable, result, all_hvparams)
910
  _VerifyHvparams(what, vm_capable, result)
911

    
912
  if constants.NV_FILELIST in what:
913
    fingerprints = utils.FingerprintFiles(map(vcluster.LocalizeVirtualPath,
914
                                              what[constants.NV_FILELIST]))
915
    result[constants.NV_FILELIST] = \
916
      dict((vcluster.MakeVirtualPath(key), value)
917
           for (key, value) in fingerprints.items())
918

    
919
  if constants.NV_NODELIST in what:
920
    (nodes, bynode) = what[constants.NV_NODELIST]
921

    
922
    # Add nodes from other groups (different for each node)
923
    try:
924
      nodes.extend(bynode[my_name])
925
    except KeyError:
926
      pass
927

    
928
    # Use a random order
929
    random.shuffle(nodes)
930

    
931
    # Try to contact all nodes
932
    val = {}
933
    for node in nodes:
934
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
935
      if not success:
936
        val[node] = message
937

    
938
    result[constants.NV_NODELIST] = val
939

    
940
  if constants.NV_NODENETTEST in what:
941
    result[constants.NV_NODENETTEST] = tmp = {}
942
    my_pip = my_sip = None
943
    for name, pip, sip in what[constants.NV_NODENETTEST]:
944
      if name == my_name:
945
        my_pip = pip
946
        my_sip = sip
947
        break
948
    if not my_pip:
949
      tmp[my_name] = ("Can't find my own primary/secondary IP"
950
                      " in the node list")
951
    else:
952
      for name, pip, sip in what[constants.NV_NODENETTEST]:
953
        fail = []
954
        if not netutils.TcpPing(pip, port, source=my_pip):
955
          fail.append("primary")
956
        if sip != pip:
957
          if not netutils.TcpPing(sip, port, source=my_sip):
958
            fail.append("secondary")
959
        if fail:
960
          tmp[name] = ("failure using the %s interface(s)" %
961
                       " and ".join(fail))
962

    
963
  if constants.NV_MASTERIP in what:
964
    # FIXME: add checks on incoming data structures (here and in the
965
    # rest of the function)
966
    master_name, master_ip = what[constants.NV_MASTERIP]
967
    if master_name == my_name:
968
      source = constants.IP4_ADDRESS_LOCALHOST
969
    else:
970
      source = None
971
    result[constants.NV_MASTERIP] = netutils.TcpPing(master_ip, port,
972
                                                     source=source)
973

    
974
  if constants.NV_USERSCRIPTS in what:
975
    result[constants.NV_USERSCRIPTS] = \
976
      [script for script in what[constants.NV_USERSCRIPTS]
977
       if not utils.IsExecutable(script)]
978

    
979
  if constants.NV_OOB_PATHS in what:
980
    result[constants.NV_OOB_PATHS] = tmp = []
981
    for path in what[constants.NV_OOB_PATHS]:
982
      try:
983
        st = os.stat(path)
984
      except OSError, err:
985
        tmp.append("error stating out of band helper: %s" % err)
986
      else:
987
        if stat.S_ISREG(st.st_mode):
988
          if stat.S_IMODE(st.st_mode) & stat.S_IXUSR:
989
            tmp.append(None)
990
          else:
991
            tmp.append("out of band helper %s is not executable" % path)
992
        else:
993
          tmp.append("out of band helper %s is not a file" % path)
994

    
995
  if constants.NV_LVLIST in what and vm_capable:
996
    try:
997
      val = GetVolumeList(utils.ListVolumeGroups().keys())
998
    except RPCFail, err:
999
      val = str(err)
1000
    result[constants.NV_LVLIST] = val
1001

    
1002
  _VerifyInstanceList(what, vm_capable, result, all_hvparams)
1003

    
1004
  if constants.NV_VGLIST in what and vm_capable:
1005
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
1006

    
1007
  if constants.NV_PVLIST in what and vm_capable:
1008
    check_exclusive_pvs = constants.NV_EXCLUSIVEPVS in what
1009
    val = bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
1010
                                       filter_allocatable=False,
1011
                                       include_lvs=check_exclusive_pvs)
1012
    if check_exclusive_pvs:
1013
      result[constants.NV_EXCLUSIVEPVS] = _CheckExclusivePvs(val)
1014
      for pvi in val:
1015
        # Avoid sending useless data on the wire
1016
        pvi.lv_list = []
1017
    result[constants.NV_PVLIST] = map(objects.LvmPvInfo.ToDict, val)
1018

    
1019
  if constants.NV_VERSION in what:
1020
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
1021
                                    constants.RELEASE_VERSION)
1022

    
1023
  _VerifyNodeInfo(what, vm_capable, result, all_hvparams)
1024

    
1025
  if constants.NV_DRBDVERSION in what and vm_capable:
1026
    try:
1027
      drbd_version = DRBD8.GetProcInfo().GetVersionString()
1028
    except errors.BlockDeviceError, err:
1029
      logging.warning("Can't get DRBD version", exc_info=True)
1030
      drbd_version = str(err)
1031
    result[constants.NV_DRBDVERSION] = drbd_version
1032

    
1033
  if constants.NV_DRBDLIST in what and vm_capable:
1034
    try:
1035
      used_minors = drbd.DRBD8.GetUsedDevs()
1036
    except errors.BlockDeviceError, err:
1037
      logging.warning("Can't get used minors list", exc_info=True)
1038
      used_minors = str(err)
1039
    result[constants.NV_DRBDLIST] = used_minors
1040

    
1041
  if constants.NV_DRBDHELPER in what and vm_capable:
1042
    status = True
1043
    try:
1044
      payload = drbd.DRBD8.GetUsermodeHelper()
1045
    except errors.BlockDeviceError, err:
1046
      logging.error("Can't get DRBD usermode helper: %s", str(err))
1047
      status = False
1048
      payload = str(err)
1049
    result[constants.NV_DRBDHELPER] = (status, payload)
1050

    
1051
  if constants.NV_NODESETUP in what:
1052
    result[constants.NV_NODESETUP] = tmpr = []
1053
    if not os.path.isdir("/sys/block") or not os.path.isdir("/sys/class/net"):
1054
      tmpr.append("The sysfs filesytem doesn't seem to be mounted"
1055
                  " under /sys, missing required directories /sys/block"
1056
                  " and /sys/class/net")
1057
    if (not os.path.isdir("/proc/sys") or
1058
        not os.path.isfile("/proc/sysrq-trigger")):
1059
      tmpr.append("The procfs filesystem doesn't seem to be mounted"
1060
                  " under /proc, missing required directory /proc/sys and"
1061
                  " the file /proc/sysrq-trigger")
1062

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

    
1066
  if constants.NV_OSLIST in what and vm_capable:
1067
    result[constants.NV_OSLIST] = DiagnoseOS()
1068

    
1069
  if constants.NV_BRIDGES in what and vm_capable:
1070
    result[constants.NV_BRIDGES] = [bridge
1071
                                    for bridge in what[constants.NV_BRIDGES]
1072
                                    if not utils.BridgeExists(bridge)]
1073

    
1074
  if what.get(constants.NV_FILE_STORAGE_PATHS) == my_name:
1075
    result[constants.NV_FILE_STORAGE_PATHS] = \
1076
      bdev.ComputeWrongFileStoragePaths()
1077

    
1078
  return result
1079

    
1080

    
1081
def GetBlockDevSizes(devices):
1082
  """Return the size of the given block devices
1083

1084
  @type devices: list
1085
  @param devices: list of block device nodes to query
1086
  @rtype: dict
1087
  @return:
1088
    dictionary of all block devices under /dev (key). The value is their
1089
    size in MiB.
1090

1091
    {'/dev/disk/by-uuid/123456-12321231-312312-312': 124}
1092

1093
  """
1094
  DEV_PREFIX = "/dev/"
1095
  blockdevs = {}
1096

    
1097
  for devpath in devices:
1098
    if not utils.IsBelowDir(DEV_PREFIX, devpath):
1099
      continue
1100

    
1101
    try:
1102
      st = os.stat(devpath)
1103
    except EnvironmentError, err:
1104
      logging.warning("Error stat()'ing device %s: %s", devpath, str(err))
1105
      continue
1106

    
1107
    if stat.S_ISBLK(st.st_mode):
1108
      result = utils.RunCmd(["blockdev", "--getsize64", devpath])
1109
      if result.failed:
1110
        # We don't want to fail, just do not list this device as available
1111
        logging.warning("Cannot get size for block device %s", devpath)
1112
        continue
1113

    
1114
      size = int(result.stdout) / (1024 * 1024)
1115
      blockdevs[devpath] = size
1116
  return blockdevs
1117

    
1118

    
1119
def GetVolumeList(vg_names):
1120
  """Compute list of logical volumes and their size.
1121

1122
  @type vg_names: list
1123
  @param vg_names: the volume groups whose LVs we should list, or
1124
      empty for all volume groups
1125
  @rtype: dict
1126
  @return:
1127
      dictionary of all partions (key) with value being a tuple of
1128
      their size (in MiB), inactive and online status::
1129

1130
        {'xenvg/test1': ('20.06', True, True)}
1131

1132
      in case of errors, a string is returned with the error
1133
      details.
1134

1135
  """
1136
  lvs = {}
1137
  sep = "|"
1138
  if not vg_names:
1139
    vg_names = []
1140
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
1141
                         "--separator=%s" % sep,
1142
                         "-ovg_name,lv_name,lv_size,lv_attr"] + vg_names)
1143
  if result.failed:
1144
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
1145

    
1146
  for line in result.stdout.splitlines():
1147
    line = line.strip()
1148
    match = _LVSLINE_REGEX.match(line)
1149
    if not match:
1150
      logging.error("Invalid line returned from lvs output: '%s'", line)
1151
      continue
1152
    vg_name, name, size, attr = match.groups()
1153
    inactive = attr[4] == "-"
1154
    online = attr[5] == "o"
1155
    virtual = attr[0] == "v"
1156
    if virtual:
1157
      # we don't want to report such volumes as existing, since they
1158
      # don't really hold data
1159
      continue
1160
    lvs[vg_name + "/" + name] = (size, inactive, online)
1161

    
1162
  return lvs
1163

    
1164

    
1165
def ListVolumeGroups():
1166
  """List the volume groups and their size.
1167

1168
  @rtype: dict
1169
  @return: dictionary with keys volume name and values the
1170
      size of the volume
1171

1172
  """
1173
  return utils.ListVolumeGroups()
1174

    
1175

    
1176
def NodeVolumes():
1177
  """List all volumes on this node.
1178

1179
  @rtype: list
1180
  @return:
1181
    A list of dictionaries, each having four keys:
1182
      - name: the logical volume name,
1183
      - size: the size of the logical volume
1184
      - dev: the physical device on which the LV lives
1185
      - vg: the volume group to which it belongs
1186

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

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

1194
  """
1195
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
1196
                         "--separator=|",
1197
                         "--options=lv_name,lv_size,devices,vg_name"])
1198
  if result.failed:
1199
    _Fail("Failed to list logical volumes, lvs output: %s",
1200
          result.output)
1201

    
1202
  def parse_dev(dev):
1203
    return dev.split("(")[0]
1204

    
1205
  def handle_dev(dev):
1206
    return [parse_dev(x) for x in dev.split(",")]
1207

    
1208
  def map_line(line):
1209
    line = [v.strip() for v in line]
1210
    return [{"name": line[0], "size": line[1],
1211
             "dev": dev, "vg": line[3]} for dev in handle_dev(line[2])]
1212

    
1213
  all_devs = []
1214
  for line in result.stdout.splitlines():
1215
    if line.count("|") >= 3:
1216
      all_devs.extend(map_line(line.split("|")))
1217
    else:
1218
      logging.warning("Strange line in the output from lvs: '%s'", line)
1219
  return all_devs
1220

    
1221

    
1222
def BridgesExist(bridges_list):
1223
  """Check if a list of bridges exist on the current node.
1224

1225
  @rtype: boolean
1226
  @return: C{True} if all of them exist, C{False} otherwise
1227

1228
  """
1229
  missing = []
1230
  for bridge in bridges_list:
1231
    if not utils.BridgeExists(bridge):
1232
      missing.append(bridge)
1233

    
1234
  if missing:
1235
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
1236

    
1237

    
1238
def GetInstanceListForHypervisor(hname, hvparams=None,
1239
                                 get_hv_fn=hypervisor.GetHypervisor):
1240
  """Provides a list of instances of the given hypervisor.
1241

1242
  @type hname: string
1243
  @param hname: name of the hypervisor
1244
  @type hvparams: dict of strings
1245
  @param hvparams: hypervisor parameters for the given hypervisor
1246
  @type get_hv_fn: function
1247
  @param get_hv_fn: function that returns a hypervisor for the given hypervisor
1248
    name; optional parameter to increase testability
1249

1250
  @rtype: list
1251
  @return: a list of all running instances on the current node
1252
    - instance1.example.com
1253
    - instance2.example.com
1254

1255
  """
1256
  results = []
1257
  try:
1258
    hv = get_hv_fn(hname)
1259
    names = hv.ListInstances(hvparams=hvparams)
1260
    results.extend(names)
1261
  except errors.HypervisorError, err:
1262
    _Fail("Error enumerating instances (hypervisor %s): %s",
1263
          hname, err, exc=True)
1264
  return results
1265

    
1266

    
1267
def GetInstanceList(hypervisor_list, all_hvparams=None,
1268
                    get_hv_fn=hypervisor.GetHypervisor):
1269
  """Provides a list of instances.
1270

1271
  @type hypervisor_list: list
1272
  @param hypervisor_list: the list of hypervisors to query information
1273
  @type all_hvparams: dict of dict of strings
1274
  @param all_hvparams: a dictionary mapping hypervisor types to respective
1275
    cluster-wide hypervisor parameters
1276
  @type get_hv_fn: function
1277
  @param get_hv_fn: function that returns a hypervisor for the given hypervisor
1278
    name; optional parameter to increase testability
1279

1280
  @rtype: list
1281
  @return: a list of all running instances on the current node
1282
    - instance1.example.com
1283
    - instance2.example.com
1284

1285
  """
1286
  results = []
1287
  for hname in hypervisor_list:
1288
    hvparams = all_hvparams[hname]
1289
    results.extend(GetInstanceListForHypervisor(hname, hvparams=hvparams,
1290
                                                get_hv_fn=get_hv_fn))
1291
  return results
1292

    
1293

    
1294
def GetInstanceInfo(instance, hname, hvparams=None):
1295
  """Gives back the information about an instance as a dictionary.
1296

1297
  @type instance: string
1298
  @param instance: the instance name
1299
  @type hname: string
1300
  @param hname: the hypervisor type of the instance
1301
  @type hvparams: dict of strings
1302
  @param hvparams: the instance's hvparams
1303

1304
  @rtype: dict
1305
  @return: dictionary with the following keys:
1306
      - memory: memory size of instance (int)
1307
      - state: xen state of instance (string)
1308
      - time: cpu time of instance (float)
1309
      - vcpus: the number of vcpus (int)
1310

1311
  """
1312
  output = {}
1313

    
1314
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance,
1315
                                                          hvparams=hvparams)
1316
  if iinfo is not None:
1317
    output["memory"] = iinfo[2]
1318
    output["vcpus"] = iinfo[3]
1319
    output["state"] = iinfo[4]
1320
    output["time"] = iinfo[5]
1321

    
1322
  return output
1323

    
1324

    
1325
def GetInstanceMigratable(instance):
1326
  """Computes whether an instance can be migrated.
1327

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

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

1336
  """
1337
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1338
  iname = instance.name
1339
  if iname not in hyper.ListInstances(instance.hvparams):
1340
    _Fail("Instance %s is not running", iname)
1341

    
1342
  for idx in range(len(instance.disks)):
1343
    link_name = _GetBlockDevSymlinkPath(iname, idx)
1344
    if not os.path.islink(link_name):
1345
      logging.warning("Instance %s is missing symlink %s for disk %d",
1346
                      iname, link_name, idx)
1347

    
1348

    
1349
def GetAllInstancesInfo(hypervisor_list, all_hvparams):
1350
  """Gather data about all instances.
1351

1352
  This is the equivalent of L{GetInstanceInfo}, except that it
1353
  computes data for all instances at once, thus being faster if one
1354
  needs data about more than one instance.
1355

1356
  @type hypervisor_list: list
1357
  @param hypervisor_list: list of hypervisors to query for instance data
1358
  @type all_hvparams: dict of dict of strings
1359
  @param all_hvparams: mapping of hypervisor names to hvparams
1360

1361
  @rtype: dict
1362
  @return: dictionary of instance: data, with data having the following keys:
1363
      - memory: memory size of instance (int)
1364
      - state: xen state of instance (string)
1365
      - time: cpu time of instance (float)
1366
      - vcpus: the number of vcpus
1367

1368
  """
1369
  output = {}
1370

    
1371
  for hname in hypervisor_list:
1372
    hvparams = all_hvparams[hname]
1373
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo(hvparams)
1374
    if iinfo:
1375
      for name, _, memory, vcpus, state, times in iinfo:
1376
        value = {
1377
          "memory": memory,
1378
          "vcpus": vcpus,
1379
          "state": state,
1380
          "time": times,
1381
          }
1382
        if name in output:
1383
          # we only check static parameters, like memory and vcpus,
1384
          # and not state and time which can change between the
1385
          # invocations of the different hypervisors
1386
          for key in "memory", "vcpus":
1387
            if value[key] != output[name][key]:
1388
              _Fail("Instance %s is running twice"
1389
                    " with different parameters", name)
1390
        output[name] = value
1391

    
1392
  return output
1393

    
1394

    
1395
def _InstanceLogName(kind, os_name, instance, component):
1396
  """Compute the OS log filename for a given instance and operation.
1397

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

1401
  @type kind: string
1402
  @param kind: the operation type (e.g. add, import, etc.)
1403
  @type os_name: string
1404
  @param os_name: the os name
1405
  @type instance: string
1406
  @param instance: the name of the instance being imported/added/etc.
1407
  @type component: string or None
1408
  @param component: the name of the component of the instance being
1409
      transferred
1410

1411
  """
1412
  # TODO: Use tempfile.mkstemp to create unique filename
1413
  if component:
1414
    assert "/" not in component
1415
    c_msg = "-%s" % component
1416
  else:
1417
    c_msg = ""
1418
  base = ("%s-%s-%s%s-%s.log" %
1419
          (kind, os_name, instance, c_msg, utils.TimestampForFilename()))
1420
  return utils.PathJoin(pathutils.LOG_OS_DIR, base)
1421

    
1422

    
1423
def InstanceOsAdd(instance, reinstall, debug):
1424
  """Add an OS to an instance.
1425

1426
  @type instance: L{objects.Instance}
1427
  @param instance: Instance whose OS is to be installed
1428
  @type reinstall: boolean
1429
  @param reinstall: whether this is an instance reinstall
1430
  @type debug: integer
1431
  @param debug: debug level, passed to the OS scripts
1432
  @rtype: None
1433

1434
  """
1435
  inst_os = OSFromDisk(instance.os)
1436

    
1437
  create_env = OSEnvironment(instance, inst_os, debug)
1438
  if reinstall:
1439
    create_env["INSTANCE_REINSTALL"] = "1"
1440

    
1441
  logfile = _InstanceLogName("add", instance.os, instance.name, None)
1442

    
1443
  result = utils.RunCmd([inst_os.create_script], env=create_env,
1444
                        cwd=inst_os.path, output=logfile, reset_env=True)
1445
  if result.failed:
1446
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
1447
                  " output: %s", result.cmd, result.fail_reason, logfile,
1448
                  result.output)
1449
    lines = [utils.SafeEncode(val)
1450
             for val in utils.TailFile(logfile, lines=20)]
1451
    _Fail("OS create script failed (%s), last lines in the"
1452
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
1453

    
1454

    
1455
def RunRenameInstance(instance, old_name, debug):
1456
  """Run the OS rename script for an instance.
1457

1458
  @type instance: L{objects.Instance}
1459
  @param instance: Instance whose OS is to be installed
1460
  @type old_name: string
1461
  @param old_name: previous instance name
1462
  @type debug: integer
1463
  @param debug: debug level, passed to the OS scripts
1464
  @rtype: boolean
1465
  @return: the success of the operation
1466

1467
  """
1468
  inst_os = OSFromDisk(instance.os)
1469

    
1470
  rename_env = OSEnvironment(instance, inst_os, debug)
1471
  rename_env["OLD_INSTANCE_NAME"] = old_name
1472

    
1473
  logfile = _InstanceLogName("rename", instance.os,
1474
                             "%s-%s" % (old_name, instance.name), None)
1475

    
1476
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
1477
                        cwd=inst_os.path, output=logfile, reset_env=True)
1478

    
1479
  if result.failed:
1480
    logging.error("os create command '%s' returned error: %s output: %s",
1481
                  result.cmd, result.fail_reason, result.output)
1482
    lines = [utils.SafeEncode(val)
1483
             for val in utils.TailFile(logfile, lines=20)]
1484
    _Fail("OS rename script failed (%s), last lines in the"
1485
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
1486

    
1487

    
1488
def _GetBlockDevSymlinkPath(instance_name, idx, _dir=None):
1489
  """Returns symlink path for block device.
1490

1491
  """
1492
  if _dir is None:
1493
    _dir = pathutils.DISK_LINKS_DIR
1494

    
1495
  return utils.PathJoin(_dir,
1496
                        ("%s%s%s" %
1497
                         (instance_name, constants.DISK_SEPARATOR, idx)))
1498

    
1499

    
1500
def _SymlinkBlockDev(instance_name, device_path, idx):
1501
  """Set up symlinks to a instance's block device.
1502

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

1506

1507
  @param instance_name: the name of the target instance
1508
  @param device_path: path of the physical block device, on the node
1509
  @param idx: the disk index
1510
  @return: absolute path to the disk's symlink
1511

1512
  """
1513
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
1514
  try:
1515
    os.symlink(device_path, link_name)
1516
  except OSError, err:
1517
    if err.errno == errno.EEXIST:
1518
      if (not os.path.islink(link_name) or
1519
          os.readlink(link_name) != device_path):
1520
        os.remove(link_name)
1521
        os.symlink(device_path, link_name)
1522
    else:
1523
      raise
1524

    
1525
  return link_name
1526

    
1527

    
1528
def _RemoveBlockDevLinks(instance_name, disks):
1529
  """Remove the block device symlinks belonging to the given instance.
1530

1531
  """
1532
  for idx, _ in enumerate(disks):
1533
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
1534
    if os.path.islink(link_name):
1535
      try:
1536
        os.remove(link_name)
1537
      except OSError:
1538
        logging.exception("Can't remove symlink '%s'", link_name)
1539

    
1540

    
1541
def _GatherAndLinkBlockDevs(instance):
1542
  """Set up an instance's block device(s).
1543

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

1547
  @type instance: L{objects.Instance}
1548
  @param instance: the instance whose disks we shoul assemble
1549
  @rtype: list
1550
  @return: list of (disk_object, device_path)
1551

1552
  """
1553
  block_devices = []
1554
  for idx, disk in enumerate(instance.disks):
1555
    device = _RecursiveFindBD(disk)
1556
    if device is None:
1557
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
1558
                                    str(disk))
1559
    device.Open()
1560
    try:
1561
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
1562
    except OSError, e:
1563
      raise errors.BlockDeviceError("Cannot create block device symlink: %s" %
1564
                                    e.strerror)
1565

    
1566
    block_devices.append((disk, link_name))
1567

    
1568
  return block_devices
1569

    
1570

    
1571
def StartInstance(instance, startup_paused, reason, store_reason=True):
1572
  """Start an instance.
1573

1574
  @type instance: L{objects.Instance}
1575
  @param instance: the instance object
1576
  @type startup_paused: bool
1577
  @param instance: pause instance at startup?
1578
  @type reason: list of reasons
1579
  @param reason: the reason trail for this startup
1580
  @type store_reason: boolean
1581
  @param store_reason: whether to store the shutdown reason trail on file
1582
  @rtype: None
1583

1584
  """
1585
  running_instances = GetInstanceListForHypervisor(instance.hypervisor,
1586
                                                   instance.hvparams)
1587

    
1588
  if instance.name in running_instances:
1589
    logging.info("Instance %s already running, not starting", instance.name)
1590
    return
1591

    
1592
  try:
1593
    block_devices = _GatherAndLinkBlockDevs(instance)
1594
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
1595
    hyper.StartInstance(instance, block_devices, startup_paused)
1596
    if store_reason:
1597
      _StoreInstReasonTrail(instance.name, reason)
1598
  except errors.BlockDeviceError, err:
1599
    _Fail("Block device error: %s", err, exc=True)
1600
  except errors.HypervisorError, err:
1601
    _RemoveBlockDevLinks(instance.name, instance.disks)
1602
    _Fail("Hypervisor error: %s", err, exc=True)
1603

    
1604

    
1605
def InstanceShutdown(instance, timeout, reason, store_reason=True):
1606
  """Shut an instance down.
1607

1608
  @note: this functions uses polling with a hardcoded timeout.
1609

1610
  @type instance: L{objects.Instance}
1611
  @param instance: the instance object
1612
  @type timeout: integer
1613
  @param timeout: maximum timeout for soft shutdown
1614
  @type reason: list of reasons
1615
  @param reason: the reason trail for this shutdown
1616
  @type store_reason: boolean
1617
  @param store_reason: whether to store the shutdown reason trail on file
1618
  @rtype: None
1619

1620
  """
1621
  hv_name = instance.hypervisor
1622
  hyper = hypervisor.GetHypervisor(hv_name)
1623
  iname = instance.name
1624

    
1625
  if instance.name not in hyper.ListInstances(instance.hvparams):
1626
    logging.info("Instance %s not running, doing nothing", iname)
1627
    return
1628

    
1629
  class _TryShutdown:
1630
    def __init__(self):
1631
      self.tried_once = False
1632

    
1633
    def __call__(self):
1634
      if iname not in hyper.ListInstances(instance.hvparams):
1635
        return
1636

    
1637
      try:
1638
        hyper.StopInstance(instance, retry=self.tried_once)
1639
        if store_reason:
1640
          _StoreInstReasonTrail(instance.name, reason)
1641
      except errors.HypervisorError, err:
1642
        if iname not in hyper.ListInstances(instance.hvparams):
1643
          # if the instance is no longer existing, consider this a
1644
          # success and go to cleanup
1645
          return
1646

    
1647
        _Fail("Failed to stop instance %s: %s", iname, err)
1648

    
1649
      self.tried_once = True
1650

    
1651
      raise utils.RetryAgain()
1652

    
1653
  try:
1654
    utils.Retry(_TryShutdown(), 5, timeout)
1655
  except utils.RetryTimeout:
1656
    # the shutdown did not succeed
1657
    logging.error("Shutdown of '%s' unsuccessful, forcing", iname)
1658

    
1659
    try:
1660
      hyper.StopInstance(instance, force=True)
1661
    except errors.HypervisorError, err:
1662
      if iname in hyper.ListInstances(instance.hvparams):
1663
        # only raise an error if the instance still exists, otherwise
1664
        # the error could simply be "instance ... unknown"!
1665
        _Fail("Failed to force stop instance %s: %s", iname, err)
1666

    
1667
    time.sleep(1)
1668

    
1669
    if iname in hyper.ListInstances(instance.hvparams):
1670
      _Fail("Could not shutdown instance %s even by destroy", iname)
1671

    
1672
  try:
1673
    hyper.CleanupInstance(instance.name)
1674
  except errors.HypervisorError, err:
1675
    logging.warning("Failed to execute post-shutdown cleanup step: %s", err)
1676

    
1677
  _RemoveBlockDevLinks(iname, instance.disks)
1678

    
1679

    
1680
def InstanceReboot(instance, reboot_type, shutdown_timeout, reason):
1681
  """Reboot an instance.
1682

1683
  @type instance: L{objects.Instance}
1684
  @param instance: the instance object to reboot
1685
  @type reboot_type: str
1686
  @param reboot_type: the type of reboot, one the following
1687
    constants:
1688
      - L{constants.INSTANCE_REBOOT_SOFT}: only reboot the
1689
        instance OS, do not recreate the VM
1690
      - L{constants.INSTANCE_REBOOT_HARD}: tear down and
1691
        restart the VM (at the hypervisor level)
1692
      - the other reboot type (L{constants.INSTANCE_REBOOT_FULL}) is
1693
        not accepted here, since that mode is handled differently, in
1694
        cmdlib, and translates into full stop and start of the
1695
        instance (instead of a call_instance_reboot RPC)
1696
  @type shutdown_timeout: integer
1697
  @param shutdown_timeout: maximum timeout for soft shutdown
1698
  @type reason: list of reasons
1699
  @param reason: the reason trail for this reboot
1700
  @rtype: None
1701

1702
  """
1703
  running_instances = GetInstanceListForHypervisor(instance.hypervisor,
1704
                                                   instance.hvparams)
1705

    
1706
  if instance.name not in running_instances:
1707
    _Fail("Cannot reboot instance %s that is not running", instance.name)
1708

    
1709
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1710
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
1711
    try:
1712
      hyper.RebootInstance(instance)
1713
    except errors.HypervisorError, err:
1714
      _Fail("Failed to soft reboot instance %s: %s", instance.name, err)
1715
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
1716
    try:
1717
      InstanceShutdown(instance, shutdown_timeout, reason, store_reason=False)
1718
      result = StartInstance(instance, False, reason, store_reason=False)
1719
      _StoreInstReasonTrail(instance.name, reason)
1720
      return result
1721
    except errors.HypervisorError, err:
1722
      _Fail("Failed to hard reboot instance %s: %s", instance.name, err)
1723
  else:
1724
    _Fail("Invalid reboot_type received: %s", reboot_type)
1725

    
1726

    
1727
def InstanceBalloonMemory(instance, memory):
1728
  """Resize an instance's memory.
1729

1730
  @type instance: L{objects.Instance}
1731
  @param instance: the instance object
1732
  @type memory: int
1733
  @param memory: new memory amount in MB
1734
  @rtype: None
1735

1736
  """
1737
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1738
  running = hyper.ListInstances(instance.hvparams)
1739
  if instance.name not in running:
1740
    logging.info("Instance %s is not running, cannot balloon", instance.name)
1741
    return
1742
  try:
1743
    hyper.BalloonInstanceMemory(instance, memory)
1744
  except errors.HypervisorError, err:
1745
    _Fail("Failed to balloon instance memory: %s", err, exc=True)
1746

    
1747

    
1748
def MigrationInfo(instance):
1749
  """Gather information about an instance to be migrated.
1750

1751
  @type instance: L{objects.Instance}
1752
  @param instance: the instance definition
1753

1754
  """
1755
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1756
  try:
1757
    info = hyper.MigrationInfo(instance)
1758
  except errors.HypervisorError, err:
1759
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1760
  return info
1761

    
1762

    
1763
def AcceptInstance(instance, info, target):
1764
  """Prepare the node to accept an instance.
1765

1766
  @type instance: L{objects.Instance}
1767
  @param instance: the instance definition
1768
  @type info: string/data (opaque)
1769
  @param info: migration information, from the source node
1770
  @type target: string
1771
  @param target: target host (usually ip), on this node
1772

1773
  """
1774
  # TODO: why is this required only for DTS_EXT_MIRROR?
1775
  if instance.disk_template in constants.DTS_EXT_MIRROR:
1776
    # Create the symlinks, as the disks are not active
1777
    # in any way
1778
    try:
1779
      _GatherAndLinkBlockDevs(instance)
1780
    except errors.BlockDeviceError, err:
1781
      _Fail("Block device error: %s", err, exc=True)
1782

    
1783
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1784
  try:
1785
    hyper.AcceptInstance(instance, info, target)
1786
  except errors.HypervisorError, err:
1787
    if instance.disk_template in constants.DTS_EXT_MIRROR:
1788
      _RemoveBlockDevLinks(instance.name, instance.disks)
1789
    _Fail("Failed to accept instance: %s", err, exc=True)
1790

    
1791

    
1792
def FinalizeMigrationDst(instance, info, success):
1793
  """Finalize any preparation to accept an instance.
1794

1795
  @type instance: L{objects.Instance}
1796
  @param instance: the instance definition
1797
  @type info: string/data (opaque)
1798
  @param info: migration information, from the source node
1799
  @type success: boolean
1800
  @param success: whether the migration was a success or a failure
1801

1802
  """
1803
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1804
  try:
1805
    hyper.FinalizeMigrationDst(instance, info, success)
1806
  except errors.HypervisorError, err:
1807
    _Fail("Failed to finalize migration on the target node: %s", err, exc=True)
1808

    
1809

    
1810
def MigrateInstance(cluster_name, instance, target, live):
1811
  """Migrates an instance to another node.
1812

1813
  @type cluster_name: string
1814
  @param cluster_name: name of the cluster
1815
  @type instance: L{objects.Instance}
1816
  @param instance: the instance definition
1817
  @type target: string
1818
  @param target: the target node name
1819
  @type live: boolean
1820
  @param live: whether the migration should be done live or not (the
1821
      interpretation of this parameter is left to the hypervisor)
1822
  @raise RPCFail: if migration fails for some reason
1823

1824
  """
1825
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1826

    
1827
  try:
1828
    hyper.MigrateInstance(cluster_name, instance, target, live)
1829
  except errors.HypervisorError, err:
1830
    _Fail("Failed to migrate instance: %s", err, exc=True)
1831

    
1832

    
1833
def FinalizeMigrationSource(instance, success, live):
1834
  """Finalize the instance migration on the source node.
1835

1836
  @type instance: L{objects.Instance}
1837
  @param instance: the instance definition of the migrated instance
1838
  @type success: bool
1839
  @param success: whether the migration succeeded or not
1840
  @type live: bool
1841
  @param live: whether the user requested a live migration or not
1842
  @raise RPCFail: If the execution fails for some reason
1843

1844
  """
1845
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1846

    
1847
  try:
1848
    hyper.FinalizeMigrationSource(instance, success, live)
1849
  except Exception, err:  # pylint: disable=W0703
1850
    _Fail("Failed to finalize the migration on the source node: %s", err,
1851
          exc=True)
1852

    
1853

    
1854
def GetMigrationStatus(instance):
1855
  """Get the migration status
1856

1857
  @type instance: L{objects.Instance}
1858
  @param instance: the instance that is being migrated
1859
  @rtype: L{objects.MigrationStatus}
1860
  @return: the status of the current migration (one of
1861
           L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
1862
           progress info that can be retrieved from the hypervisor
1863
  @raise RPCFail: If the migration status cannot be retrieved
1864

1865
  """
1866
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1867
  try:
1868
    return hyper.GetMigrationStatus(instance)
1869
  except Exception, err:  # pylint: disable=W0703
1870
    _Fail("Failed to get migration status: %s", err, exc=True)
1871

    
1872

    
1873
def BlockdevCreate(disk, size, owner, on_primary, info, excl_stor):
1874
  """Creates a block device for an instance.
1875

1876
  @type disk: L{objects.Disk}
1877
  @param disk: the object describing the disk we should create
1878
  @type size: int
1879
  @param size: the size of the physical underlying device, in MiB
1880
  @type owner: str
1881
  @param owner: the name of the instance for which disk is created,
1882
      used for device cache data
1883
  @type on_primary: boolean
1884
  @param on_primary:  indicates if it is the primary node or not
1885
  @type info: string
1886
  @param info: string that will be sent to the physical device
1887
      creation, used for example to set (LVM) tags on LVs
1888
  @type excl_stor: boolean
1889
  @param excl_stor: Whether exclusive_storage is active
1890

1891
  @return: the new unique_id of the device (this can sometime be
1892
      computed only after creation), or None. On secondary nodes,
1893
      it's not required to return anything.
1894

1895
  """
1896
  # TODO: remove the obsolete "size" argument
1897
  # pylint: disable=W0613
1898
  clist = []
1899
  if disk.children:
1900
    for child in disk.children:
1901
      try:
1902
        crdev = _RecursiveAssembleBD(child, owner, on_primary)
1903
      except errors.BlockDeviceError, err:
1904
        _Fail("Can't assemble device %s: %s", child, err)
1905
      if on_primary or disk.AssembleOnSecondary():
1906
        # we need the children open in case the device itself has to
1907
        # be assembled
1908
        try:
1909
          # pylint: disable=E1103
1910
          crdev.Open()
1911
        except errors.BlockDeviceError, err:
1912
          _Fail("Can't make child '%s' read-write: %s", child, err)
1913
      clist.append(crdev)
1914

    
1915
  try:
1916
    device = bdev.Create(disk, clist, excl_stor)
1917
  except errors.BlockDeviceError, err:
1918
    _Fail("Can't create block device: %s", err)
1919

    
1920
  if on_primary or disk.AssembleOnSecondary():
1921
    try:
1922
      device.Assemble()
1923
    except errors.BlockDeviceError, err:
1924
      _Fail("Can't assemble device after creation, unusual event: %s", err)
1925
    if on_primary or disk.OpenOnSecondary():
1926
      try:
1927
        device.Open(force=True)
1928
      except errors.BlockDeviceError, err:
1929
        _Fail("Can't make device r/w after creation, unusual event: %s", err)
1930
    DevCacheManager.UpdateCache(device.dev_path, owner,
1931
                                on_primary, disk.iv_name)
1932

    
1933
  device.SetInfo(info)
1934

    
1935
  return device.unique_id
1936

    
1937

    
1938
def _WipeDevice(path, offset, size):
1939
  """This function actually wipes the device.
1940

1941
  @param path: The path to the device to wipe
1942
  @param offset: The offset in MiB in the file
1943
  @param size: The size in MiB to write
1944

1945
  """
1946
  # Internal sizes are always in Mebibytes; if the following "dd" command
1947
  # should use a different block size the offset and size given to this
1948
  # function must be adjusted accordingly before being passed to "dd".
1949
  block_size = 1024 * 1024
1950

    
1951
  cmd = [constants.DD_CMD, "if=/dev/zero", "seek=%d" % offset,
1952
         "bs=%s" % block_size, "oflag=direct", "of=%s" % path,
1953
         "count=%d" % size]
1954
  result = utils.RunCmd(cmd)
1955

    
1956
  if result.failed:
1957
    _Fail("Wipe command '%s' exited with error: %s; output: %s", result.cmd,
1958
          result.fail_reason, result.output)
1959

    
1960

    
1961
def BlockdevWipe(disk, offset, size):
1962
  """Wipes a block device.
1963

1964
  @type disk: L{objects.Disk}
1965
  @param disk: the disk object we want to wipe
1966
  @type offset: int
1967
  @param offset: The offset in MiB in the file
1968
  @type size: int
1969
  @param size: The size in MiB to write
1970

1971
  """
1972
  try:
1973
    rdev = _RecursiveFindBD(disk)
1974
  except errors.BlockDeviceError:
1975
    rdev = None
1976

    
1977
  if not rdev:
1978
    _Fail("Cannot execute wipe for device %s: device not found", disk.iv_name)
1979

    
1980
  # Do cross verify some of the parameters
1981
  if offset < 0:
1982
    _Fail("Negative offset")
1983
  if size < 0:
1984
    _Fail("Negative size")
1985
  if offset > rdev.size:
1986
    _Fail("Offset is bigger than device size")
1987
  if (offset + size) > rdev.size:
1988
    _Fail("The provided offset and size to wipe is bigger than device size")
1989

    
1990
  _WipeDevice(rdev.dev_path, offset, size)
1991

    
1992

    
1993
def BlockdevPauseResumeSync(disks, pause):
1994
  """Pause or resume the sync of the block device.
1995

1996
  @type disks: list of L{objects.Disk}
1997
  @param disks: the disks object we want to pause/resume
1998
  @type pause: bool
1999
  @param pause: Wheater to pause or resume
2000

2001
  """
2002
  success = []
2003
  for disk in disks:
2004
    try:
2005
      rdev = _RecursiveFindBD(disk)
2006
    except errors.BlockDeviceError:
2007
      rdev = None
2008

    
2009
    if not rdev:
2010
      success.append((False, ("Cannot change sync for device %s:"
2011
                              " device not found" % disk.iv_name)))
2012
      continue
2013

    
2014
    result = rdev.PauseResumeSync(pause)
2015

    
2016
    if result:
2017
      success.append((result, None))
2018
    else:
2019
      if pause:
2020
        msg = "Pause"
2021
      else:
2022
        msg = "Resume"
2023
      success.append((result, "%s for device %s failed" % (msg, disk.iv_name)))
2024

    
2025
  return success
2026

    
2027

    
2028
def BlockdevRemove(disk):
2029
  """Remove a block device.
2030

2031
  @note: This is intended to be called recursively.
2032

2033
  @type disk: L{objects.Disk}
2034
  @param disk: the disk object we should remove
2035
  @rtype: boolean
2036
  @return: the success of the operation
2037

2038
  """
2039
  msgs = []
2040
  try:
2041
    rdev = _RecursiveFindBD(disk)
2042
  except errors.BlockDeviceError, err:
2043
    # probably can't attach
2044
    logging.info("Can't attach to device %s in remove", disk)
2045
    rdev = None
2046
  if rdev is not None:
2047
    r_path = rdev.dev_path
2048
    try:
2049
      rdev.Remove()
2050
    except errors.BlockDeviceError, err:
2051
      msgs.append(str(err))
2052
    if not msgs:
2053
      DevCacheManager.RemoveCache(r_path)
2054

    
2055
  if disk.children:
2056
    for child in disk.children:
2057
      try:
2058
        BlockdevRemove(child)
2059
      except RPCFail, err:
2060
        msgs.append(str(err))
2061

    
2062
  if msgs:
2063
    _Fail("; ".join(msgs))
2064

    
2065

    
2066
def _RecursiveAssembleBD(disk, owner, as_primary):
2067
  """Activate a block device for an instance.
2068

2069
  This is run on the primary and secondary nodes for an instance.
2070

2071
  @note: this function is called recursively.
2072

2073
  @type disk: L{objects.Disk}
2074
  @param disk: the disk we try to assemble
2075
  @type owner: str
2076
  @param owner: the name of the instance which owns the disk
2077
  @type as_primary: boolean
2078
  @param as_primary: if we should make the block device
2079
      read/write
2080

2081
  @return: the assembled device or None (in case no device
2082
      was assembled)
2083
  @raise errors.BlockDeviceError: in case there is an error
2084
      during the activation of the children or the device
2085
      itself
2086

2087
  """
2088
  children = []
2089
  if disk.children:
2090
    mcn = disk.ChildrenNeeded()
2091
    if mcn == -1:
2092
      mcn = 0 # max number of Nones allowed
2093
    else:
2094
      mcn = len(disk.children) - mcn # max number of Nones
2095
    for chld_disk in disk.children:
2096
      try:
2097
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
2098
      except errors.BlockDeviceError, err:
2099
        if children.count(None) >= mcn:
2100
          raise
2101
        cdev = None
2102
        logging.error("Error in child activation (but continuing): %s",
2103
                      str(err))
2104
      children.append(cdev)
2105

    
2106
  if as_primary or disk.AssembleOnSecondary():
2107
    r_dev = bdev.Assemble(disk, children)
2108
    result = r_dev
2109
    if as_primary or disk.OpenOnSecondary():
2110
      r_dev.Open()
2111
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
2112
                                as_primary, disk.iv_name)
2113

    
2114
  else:
2115
    result = True
2116
  return result
2117

    
2118

    
2119
def BlockdevAssemble(disk, owner, as_primary, idx):
2120
  """Activate a block device for an instance.
2121

2122
  This is a wrapper over _RecursiveAssembleBD.
2123

2124
  @rtype: str or boolean
2125
  @return: a C{/dev/...} path for primary nodes, and
2126
      C{True} for secondary nodes
2127

2128
  """
2129
  try:
2130
    result = _RecursiveAssembleBD(disk, owner, as_primary)
2131
    if isinstance(result, BlockDev):
2132
      # pylint: disable=E1103
2133
      result = result.dev_path
2134
      if as_primary:
2135
        _SymlinkBlockDev(owner, result, idx)
2136
  except errors.BlockDeviceError, err:
2137
    _Fail("Error while assembling disk: %s", err, exc=True)
2138
  except OSError, err:
2139
    _Fail("Error while symlinking disk: %s", err, exc=True)
2140

    
2141
  return result
2142

    
2143

    
2144
def BlockdevShutdown(disk):
2145
  """Shut down a block device.
2146

2147
  First, if the device is assembled (Attach() is successful), then
2148
  the device is shutdown. Then the children of the device are
2149
  shutdown.
2150

2151
  This function is called recursively. Note that we don't cache the
2152
  children or such, as oppossed to assemble, shutdown of different
2153
  devices doesn't require that the upper device was active.
2154

2155
  @type disk: L{objects.Disk}
2156
  @param disk: the description of the disk we should
2157
      shutdown
2158
  @rtype: None
2159

2160
  """
2161
  msgs = []
2162
  r_dev = _RecursiveFindBD(disk)
2163
  if r_dev is not None:
2164
    r_path = r_dev.dev_path
2165
    try:
2166
      r_dev.Shutdown()
2167
      DevCacheManager.RemoveCache(r_path)
2168
    except errors.BlockDeviceError, err:
2169
      msgs.append(str(err))
2170

    
2171
  if disk.children:
2172
    for child in disk.children:
2173
      try:
2174
        BlockdevShutdown(child)
2175
      except RPCFail, err:
2176
        msgs.append(str(err))
2177

    
2178
  if msgs:
2179
    _Fail("; ".join(msgs))
2180

    
2181

    
2182
def BlockdevAddchildren(parent_cdev, new_cdevs):
2183
  """Extend a mirrored block device.
2184

2185
  @type parent_cdev: L{objects.Disk}
2186
  @param parent_cdev: the disk to which we should add children
2187
  @type new_cdevs: list of L{objects.Disk}
2188
  @param new_cdevs: the list of children which we should add
2189
  @rtype: None
2190

2191
  """
2192
  parent_bdev = _RecursiveFindBD(parent_cdev)
2193
  if parent_bdev is None:
2194
    _Fail("Can't find parent device '%s' in add children", parent_cdev)
2195
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
2196
  if new_bdevs.count(None) > 0:
2197
    _Fail("Can't find new device(s) to add: %s:%s", new_bdevs, new_cdevs)
2198
  parent_bdev.AddChildren(new_bdevs)
2199

    
2200

    
2201
def BlockdevRemovechildren(parent_cdev, new_cdevs):
2202
  """Shrink a mirrored block device.
2203

2204
  @type parent_cdev: L{objects.Disk}
2205
  @param parent_cdev: the disk from which we should remove children
2206
  @type new_cdevs: list of L{objects.Disk}
2207
  @param new_cdevs: the list of children which we should remove
2208
  @rtype: None
2209

2210
  """
2211
  parent_bdev = _RecursiveFindBD(parent_cdev)
2212
  if parent_bdev is None:
2213
    _Fail("Can't find parent device '%s' in remove children", parent_cdev)
2214
  devs = []
2215
  for disk in new_cdevs:
2216
    rpath = disk.StaticDevPath()
2217
    if rpath is None:
2218
      bd = _RecursiveFindBD(disk)
2219
      if bd is None:
2220
        _Fail("Can't find device %s while removing children", disk)
2221
      else:
2222
        devs.append(bd.dev_path)
2223
    else:
2224
      if not utils.IsNormAbsPath(rpath):
2225
        _Fail("Strange path returned from StaticDevPath: '%s'", rpath)
2226
      devs.append(rpath)
2227
  parent_bdev.RemoveChildren(devs)
2228

    
2229

    
2230
def BlockdevGetmirrorstatus(disks):
2231
  """Get the mirroring status of a list of devices.
2232

2233
  @type disks: list of L{objects.Disk}
2234
  @param disks: the list of disks which we should query
2235
  @rtype: disk
2236
  @return: List of L{objects.BlockDevStatus}, one for each disk
2237
  @raise errors.BlockDeviceError: if any of the disks cannot be
2238
      found
2239

2240
  """
2241
  stats = []
2242
  for dsk in disks:
2243
    rbd = _RecursiveFindBD(dsk)
2244
    if rbd is None:
2245
      _Fail("Can't find device %s", dsk)
2246

    
2247
    stats.append(rbd.CombinedSyncStatus())
2248

    
2249
  return stats
2250

    
2251

    
2252
def BlockdevGetmirrorstatusMulti(disks):
2253
  """Get the mirroring status of a list of devices.
2254

2255
  @type disks: list of L{objects.Disk}
2256
  @param disks: the list of disks which we should query
2257
  @rtype: disk
2258
  @return: List of tuples, (bool, status), one for each disk; bool denotes
2259
    success/failure, status is L{objects.BlockDevStatus} on success, string
2260
    otherwise
2261

2262
  """
2263
  result = []
2264
  for disk in disks:
2265
    try:
2266
      rbd = _RecursiveFindBD(disk)
2267
      if rbd is None:
2268
        result.append((False, "Can't find device %s" % disk))
2269
        continue
2270

    
2271
      status = rbd.CombinedSyncStatus()
2272
    except errors.BlockDeviceError, err:
2273
      logging.exception("Error while getting disk status")
2274
      result.append((False, str(err)))
2275
    else:
2276
      result.append((True, status))
2277

    
2278
  assert len(disks) == len(result)
2279

    
2280
  return result
2281

    
2282

    
2283
def _RecursiveFindBD(disk):
2284
  """Check if a device is activated.
2285

2286
  If so, return information about the real device.
2287

2288
  @type disk: L{objects.Disk}
2289
  @param disk: the disk object we need to find
2290

2291
  @return: None if the device can't be found,
2292
      otherwise the device instance
2293

2294
  """
2295
  children = []
2296
  if disk.children:
2297
    for chdisk in disk.children:
2298
      children.append(_RecursiveFindBD(chdisk))
2299

    
2300
  return bdev.FindDevice(disk, children)
2301

    
2302

    
2303
def _OpenRealBD(disk):
2304
  """Opens the underlying block device of a disk.
2305

2306
  @type disk: L{objects.Disk}
2307
  @param disk: the disk object we want to open
2308

2309
  """
2310
  real_disk = _RecursiveFindBD(disk)
2311
  if real_disk is None:
2312
    _Fail("Block device '%s' is not set up", disk)
2313

    
2314
  real_disk.Open()
2315

    
2316
  return real_disk
2317

    
2318

    
2319
def BlockdevFind(disk):
2320
  """Check if a device is activated.
2321

2322
  If it is, return information about the real device.
2323

2324
  @type disk: L{objects.Disk}
2325
  @param disk: the disk to find
2326
  @rtype: None or objects.BlockDevStatus
2327
  @return: None if the disk cannot be found, otherwise a the current
2328
           information
2329

2330
  """
2331
  try:
2332
    rbd = _RecursiveFindBD(disk)
2333
  except errors.BlockDeviceError, err:
2334
    _Fail("Failed to find device: %s", err, exc=True)
2335

    
2336
  if rbd is None:
2337
    return None
2338

    
2339
  return rbd.GetSyncStatus()
2340

    
2341

    
2342
def BlockdevGetdimensions(disks):
2343
  """Computes the size of the given disks.
2344

2345
  If a disk is not found, returns None instead.
2346

2347
  @type disks: list of L{objects.Disk}
2348
  @param disks: the list of disk to compute the size for
2349
  @rtype: list
2350
  @return: list with elements None if the disk cannot be found,
2351
      otherwise the pair (size, spindles), where spindles is None if the
2352
      device doesn't support that
2353

2354
  """
2355
  result = []
2356
  for cf in disks:
2357
    try:
2358
      rbd = _RecursiveFindBD(cf)
2359
    except errors.BlockDeviceError:
2360
      result.append(None)
2361
      continue
2362
    if rbd is None:
2363
      result.append(None)
2364
    else:
2365
      result.append(rbd.GetActualDimensions())
2366
  return result
2367

    
2368

    
2369
def BlockdevExport(disk, dest_node, dest_path, cluster_name):
2370
  """Export a block device to a remote node.
2371

2372
  @type disk: L{objects.Disk}
2373
  @param disk: the description of the disk to export
2374
  @type dest_node: str
2375
  @param dest_node: the destination node to export to
2376
  @type dest_path: str
2377
  @param dest_path: the destination path on the target node
2378
  @type cluster_name: str
2379
  @param cluster_name: the cluster name, needed for SSH hostalias
2380
  @rtype: None
2381

2382
  """
2383
  real_disk = _OpenRealBD(disk)
2384

    
2385
  # the block size on the read dd is 1MiB to match our units
2386
  expcmd = utils.BuildShellCmd("set -e; set -o pipefail; "
2387
                               "dd if=%s bs=1048576 count=%s",
2388
                               real_disk.dev_path, str(disk.size))
2389

    
2390
  # we set here a smaller block size as, due to ssh buffering, more
2391
  # than 64-128k will mostly ignored; we use nocreat to fail if the
2392
  # device is not already there or we pass a wrong path; we use
2393
  # notrunc to no attempt truncate on an LV device; we use oflag=dsync
2394
  # to not buffer too much memory; this means that at best, we flush
2395
  # every 64k, which will not be very fast
2396
  destcmd = utils.BuildShellCmd("dd of=%s conv=nocreat,notrunc bs=65536"
2397
                                " oflag=dsync", dest_path)
2398

    
2399
  remotecmd = _GetSshRunner(cluster_name).BuildCmd(dest_node,
2400
                                                   constants.SSH_LOGIN_USER,
2401
                                                   destcmd)
2402

    
2403
  # all commands have been checked, so we're safe to combine them
2404
  command = "|".join([expcmd, utils.ShellQuoteArgs(remotecmd)])
2405

    
2406
  result = utils.RunCmd(["bash", "-c", command])
2407

    
2408
  if result.failed:
2409
    _Fail("Disk copy command '%s' returned error: %s"
2410
          " output: %s", command, result.fail_reason, result.output)
2411

    
2412

    
2413
def UploadFile(file_name, data, mode, uid, gid, atime, mtime):
2414
  """Write a file to the filesystem.
2415

2416
  This allows the master to overwrite(!) a file. It will only perform
2417
  the operation if the file belongs to a list of configuration files.
2418

2419
  @type file_name: str
2420
  @param file_name: the target file name
2421
  @type data: str
2422
  @param data: the new contents of the file
2423
  @type mode: int
2424
  @param mode: the mode to give the file (can be None)
2425
  @type uid: string
2426
  @param uid: the owner of the file
2427
  @type gid: string
2428
  @param gid: the group of the file
2429
  @type atime: float
2430
  @param atime: the atime to set on the file (can be None)
2431
  @type mtime: float
2432
  @param mtime: the mtime to set on the file (can be None)
2433
  @rtype: None
2434

2435
  """
2436
  file_name = vcluster.LocalizeVirtualPath(file_name)
2437

    
2438
  if not os.path.isabs(file_name):
2439
    _Fail("Filename passed to UploadFile is not absolute: '%s'", file_name)
2440

    
2441
  if file_name not in _ALLOWED_UPLOAD_FILES:
2442
    _Fail("Filename passed to UploadFile not in allowed upload targets: '%s'",
2443
          file_name)
2444

    
2445
  raw_data = _Decompress(data)
2446

    
2447
  if not (isinstance(uid, basestring) and isinstance(gid, basestring)):
2448
    _Fail("Invalid username/groupname type")
2449

    
2450
  getents = runtime.GetEnts()
2451
  uid = getents.LookupUser(uid)
2452
  gid = getents.LookupGroup(gid)
2453

    
2454
  utils.SafeWriteFile(file_name, None,
2455
                      data=raw_data, mode=mode, uid=uid, gid=gid,
2456
                      atime=atime, mtime=mtime)
2457

    
2458

    
2459
def RunOob(oob_program, command, node, timeout):
2460
  """Executes oob_program with given command on given node.
2461

2462
  @param oob_program: The path to the executable oob_program
2463
  @param command: The command to invoke on oob_program
2464
  @param node: The node given as an argument to the program
2465
  @param timeout: Timeout after which we kill the oob program
2466

2467
  @return: stdout
2468
  @raise RPCFail: If execution fails for some reason
2469

2470
  """
2471
  result = utils.RunCmd([oob_program, command, node], timeout=timeout)
2472

    
2473
  if result.failed:
2474
    _Fail("'%s' failed with reason '%s'; output: %s", result.cmd,
2475
          result.fail_reason, result.output)
2476

    
2477
  return result.stdout
2478

    
2479

    
2480
def _OSOndiskAPIVersion(os_dir):
2481
  """Compute and return the API version of a given OS.
2482

2483
  This function will try to read the API version of the OS residing in
2484
  the 'os_dir' directory.
2485

2486
  @type os_dir: str
2487
  @param os_dir: the directory in which we should look for the OS
2488
  @rtype: tuple
2489
  @return: tuple (status, data) with status denoting the validity and
2490
      data holding either the vaid versions or an error message
2491

2492
  """
2493
  api_file = utils.PathJoin(os_dir, constants.OS_API_FILE)
2494

    
2495
  try:
2496
    st = os.stat(api_file)
2497
  except EnvironmentError, err:
2498
    return False, ("Required file '%s' not found under path %s: %s" %
2499
                   (constants.OS_API_FILE, os_dir, utils.ErrnoOrStr(err)))
2500

    
2501
  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
2502
    return False, ("File '%s' in %s is not a regular file" %
2503
                   (constants.OS_API_FILE, os_dir))
2504

    
2505
  try:
2506
    api_versions = utils.ReadFile(api_file).splitlines()
2507
  except EnvironmentError, err:
2508
    return False, ("Error while reading the API version file at %s: %s" %
2509
                   (api_file, utils.ErrnoOrStr(err)))
2510

    
2511
  try:
2512
    api_versions = [int(version.strip()) for version in api_versions]
2513
  except (TypeError, ValueError), err:
2514
    return False, ("API version(s) can't be converted to integer: %s" %
2515
                   str(err))
2516

    
2517
  return True, api_versions
2518

    
2519

    
2520
def DiagnoseOS(top_dirs=None):
2521
  """Compute the validity for all OSes.
2522

2523
  @type top_dirs: list
2524
  @param top_dirs: the list of directories in which to
2525
      search (if not given defaults to
2526
      L{pathutils.OS_SEARCH_PATH})
2527
  @rtype: list of L{objects.OS}
2528
  @return: a list of tuples (name, path, status, diagnose, variants,
2529
      parameters, api_version) for all (potential) OSes under all
2530
      search paths, where:
2531
          - name is the (potential) OS name
2532
          - path is the full path to the OS
2533
          - status True/False is the validity of the OS
2534
          - diagnose is the error message for an invalid OS, otherwise empty
2535
          - variants is a list of supported OS variants, if any
2536
          - parameters is a list of (name, help) parameters, if any
2537
          - api_version is a list of support OS API versions
2538

2539
  """
2540
  if top_dirs is None:
2541
    top_dirs = pathutils.OS_SEARCH_PATH
2542

    
2543
  result = []
2544
  for dir_name in top_dirs:
2545
    if os.path.isdir(dir_name):
2546
      try:
2547
        f_names = utils.ListVisibleFiles(dir_name)
2548
      except EnvironmentError, err:
2549
        logging.exception("Can't list the OS directory %s: %s", dir_name, err)
2550
        break
2551
      for name in f_names:
2552
        os_path = utils.PathJoin(dir_name, name)
2553
        status, os_inst = _TryOSFromDisk(name, base_dir=dir_name)
2554
        if status:
2555
          diagnose = ""
2556
          variants = os_inst.supported_variants
2557
          parameters = os_inst.supported_parameters
2558
          api_versions = os_inst.api_versions
2559
        else:
2560
          diagnose = os_inst
2561
          variants = parameters = api_versions = []
2562
        result.append((name, os_path, status, diagnose, variants,
2563
                       parameters, api_versions))
2564

    
2565
  return result
2566

    
2567

    
2568
def _TryOSFromDisk(name, base_dir=None):
2569
  """Create an OS instance from disk.
2570

2571
  This function will return an OS instance if the given name is a
2572
  valid OS name.
2573

2574
  @type base_dir: string
2575
  @keyword base_dir: Base directory containing OS installations.
2576
                     Defaults to a search in all the OS_SEARCH_PATH dirs.
2577
  @rtype: tuple
2578
  @return: success and either the OS instance if we find a valid one,
2579
      or error message
2580

2581
  """
2582
  if base_dir is None:
2583
    os_dir = utils.FindFile(name, pathutils.OS_SEARCH_PATH, os.path.isdir)
2584
  else:
2585
    os_dir = utils.FindFile(name, [base_dir], os.path.isdir)
2586

    
2587
  if os_dir is None:
2588
    return False, "Directory for OS %s not found in search path" % name
2589

    
2590
  status, api_versions = _OSOndiskAPIVersion(os_dir)
2591
  if not status:
2592
    # push the error up
2593
    return status, api_versions
2594

    
2595
  if not constants.OS_API_VERSIONS.intersection(api_versions):
2596
    return False, ("API version mismatch for path '%s': found %s, want %s." %
2597
                   (os_dir, api_versions, constants.OS_API_VERSIONS))
2598

    
2599
  # OS Files dictionary, we will populate it with the absolute path
2600
  # names; if the value is True, then it is a required file, otherwise
2601
  # an optional one
2602
  os_files = dict.fromkeys(constants.OS_SCRIPTS, True)
2603

    
2604
  if max(api_versions) >= constants.OS_API_V15:
2605
    os_files[constants.OS_VARIANTS_FILE] = False
2606

    
2607
  if max(api_versions) >= constants.OS_API_V20:
2608
    os_files[constants.OS_PARAMETERS_FILE] = True
2609
  else:
2610
    del os_files[constants.OS_SCRIPT_VERIFY]
2611

    
2612
  for (filename, required) in os_files.items():
2613
    os_files[filename] = utils.PathJoin(os_dir, filename)
2614

    
2615
    try:
2616
      st = os.stat(os_files[filename])
2617
    except EnvironmentError, err:
2618
      if err.errno == errno.ENOENT and not required:
2619
        del os_files[filename]
2620
        continue
2621
      return False, ("File '%s' under path '%s' is missing (%s)" %
2622
                     (filename, os_dir, utils.ErrnoOrStr(err)))
2623

    
2624
    if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
2625
      return False, ("File '%s' under path '%s' is not a regular file" %
2626
                     (filename, os_dir))
2627

    
2628
    if filename in constants.OS_SCRIPTS:
2629
      if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR:
2630
        return False, ("File '%s' under path '%s' is not executable" %
2631
                       (filename, os_dir))
2632

    
2633
  variants = []
2634
  if constants.OS_VARIANTS_FILE in os_files:
2635
    variants_file = os_files[constants.OS_VARIANTS_FILE]
2636
    try:
2637
      variants = \
2638
        utils.FilterEmptyLinesAndComments(utils.ReadFile(variants_file))
2639
    except EnvironmentError, err:
2640
      # we accept missing files, but not other errors
2641
      if err.errno != errno.ENOENT:
2642
        return False, ("Error while reading the OS variants file at %s: %s" %
2643
                       (variants_file, utils.ErrnoOrStr(err)))
2644

    
2645
  parameters = []
2646
  if constants.OS_PARAMETERS_FILE in os_files:
2647
    parameters_file = os_files[constants.OS_PARAMETERS_FILE]
2648
    try:
2649
      parameters = utils.ReadFile(parameters_file).splitlines()
2650
    except EnvironmentError, err:
2651
      return False, ("Error while reading the OS parameters file at %s: %s" %
2652
                     (parameters_file, utils.ErrnoOrStr(err)))
2653
    parameters = [v.split(None, 1) for v in parameters]
2654

    
2655
  os_obj = objects.OS(name=name, path=os_dir,
2656
                      create_script=os_files[constants.OS_SCRIPT_CREATE],
2657
                      export_script=os_files[constants.OS_SCRIPT_EXPORT],
2658
                      import_script=os_files[constants.OS_SCRIPT_IMPORT],
2659
                      rename_script=os_files[constants.OS_SCRIPT_RENAME],
2660
                      verify_script=os_files.get(constants.OS_SCRIPT_VERIFY,
2661
                                                 None),
2662
                      supported_variants=variants,
2663
                      supported_parameters=parameters,
2664
                      api_versions=api_versions)
2665
  return True, os_obj
2666

    
2667

    
2668
def OSFromDisk(name, base_dir=None):
2669
  """Create an OS instance from disk.
2670

2671
  This function will return an OS instance if the given name is a
2672
  valid OS name. Otherwise, it will raise an appropriate
2673
  L{RPCFail} exception, detailing why this is not a valid OS.
2674

2675
  This is just a wrapper over L{_TryOSFromDisk}, which doesn't raise
2676
  an exception but returns true/false status data.
2677

2678
  @type base_dir: string
2679
  @keyword base_dir: Base directory containing OS installations.
2680
                     Defaults to a search in all the OS_SEARCH_PATH dirs.
2681
  @rtype: L{objects.OS}
2682
  @return: the OS instance if we find a valid one
2683
  @raise RPCFail: if we don't find a valid OS
2684

2685
  """
2686
  name_only = objects.OS.GetName(name)
2687
  status, payload = _TryOSFromDisk(name_only, base_dir)
2688

    
2689
  if not status:
2690
    _Fail(payload)
2691

    
2692
  return payload
2693

    
2694

    
2695
def OSCoreEnv(os_name, inst_os, os_params, debug=0):
2696
  """Calculate the basic environment for an os script.
2697

2698
  @type os_name: str
2699
  @param os_name: full operating system name (including variant)
2700
  @type inst_os: L{objects.OS}
2701
  @param inst_os: operating system for which the environment is being built
2702
  @type os_params: dict
2703
  @param os_params: the OS parameters
2704
  @type debug: integer
2705
  @param debug: debug level (0 or 1, for OS Api 10)
2706
  @rtype: dict
2707
  @return: dict of environment variables
2708
  @raise errors.BlockDeviceError: if the block device
2709
      cannot be found
2710

2711
  """
2712
  result = {}
2713
  api_version = \
2714
    max(constants.OS_API_VERSIONS.intersection(inst_os.api_versions))
2715
  result["OS_API_VERSION"] = "%d" % api_version
2716
  result["OS_NAME"] = inst_os.name
2717
  result["DEBUG_LEVEL"] = "%d" % debug
2718

    
2719
  # OS variants
2720
  if api_version >= constants.OS_API_V15 and inst_os.supported_variants:
2721
    variant = objects.OS.GetVariant(os_name)
2722
    if not variant:
2723
      variant = inst_os.supported_variants[0]
2724
  else:
2725
    variant = ""
2726
  result["OS_VARIANT"] = variant
2727

    
2728
  # OS params
2729
  for pname, pvalue in os_params.items():
2730
    result["OSP_%s" % pname.upper()] = pvalue
2731

    
2732
  # Set a default path otherwise programs called by OS scripts (or
2733
  # even hooks called from OS scripts) might break, and we don't want
2734
  # to have each script require setting a PATH variable
2735
  result["PATH"] = constants.HOOKS_PATH
2736

    
2737
  return result
2738

    
2739

    
2740
def OSEnvironment(instance, inst_os, debug=0):
2741
  """Calculate the environment for an os script.
2742

2743
  @type instance: L{objects.Instance}
2744
  @param instance: target instance for the os script run
2745
  @type inst_os: L{objects.OS}
2746
  @param inst_os: operating system for which the environment is being built
2747
  @type debug: integer
2748
  @param debug: debug level (0 or 1, for OS Api 10)
2749
  @rtype: dict
2750
  @return: dict of environment variables
2751
  @raise errors.BlockDeviceError: if the block device
2752
      cannot be found
2753

2754
  """
2755
  result = OSCoreEnv(instance.os, inst_os, instance.osparams, debug=debug)
2756

    
2757
  for attr in ["name", "os", "uuid", "ctime", "mtime", "primary_node"]:
2758
    result["INSTANCE_%s" % attr.upper()] = str(getattr(instance, attr))
2759

    
2760
  result["HYPERVISOR"] = instance.hypervisor
2761
  result["DISK_COUNT"] = "%d" % len(instance.disks)
2762
  result["NIC_COUNT"] = "%d" % len(instance.nics)
2763
  result["INSTANCE_SECONDARY_NODES"] = \
2764
      ("%s" % " ".join(instance.secondary_nodes))
2765

    
2766
  # Disks
2767
  for idx, disk in enumerate(instance.disks):
2768
    real_disk = _OpenRealBD(disk)
2769
    result["DISK_%d_PATH" % idx] = real_disk.dev_path
2770
    result["DISK_%d_ACCESS" % idx] = disk.mode
2771
    result["DISK_%d_UUID" % idx] = disk.uuid
2772
    if disk.name:
2773
      result["DISK_%d_NAME" % idx] = disk.name
2774
    if constants.HV_DISK_TYPE in instance.hvparams:
2775
      result["DISK_%d_FRONTEND_TYPE" % idx] = \
2776
        instance.hvparams[constants.HV_DISK_TYPE]
2777
    if disk.dev_type in constants.LDS_BLOCK:
2778
      result["DISK_%d_BACKEND_TYPE" % idx] = "block"
2779
    elif disk.dev_type == constants.LD_FILE:
2780
      result["DISK_%d_BACKEND_TYPE" % idx] = \
2781
        "file:%s" % disk.physical_id[0]
2782

    
2783
  # NICs
2784
  for idx, nic in enumerate(instance.nics):
2785
    result["NIC_%d_MAC" % idx] = nic.mac
2786
    result["NIC_%d_UUID" % idx] = nic.uuid
2787
    if nic.name:
2788
      result["NIC_%d_NAME" % idx] = nic.name
2789
    if nic.ip:
2790
      result["NIC_%d_IP" % idx] = nic.ip
2791
    result["NIC_%d_MODE" % idx] = nic.nicparams[constants.NIC_MODE]
2792
    if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
2793
      result["NIC_%d_BRIDGE" % idx] = nic.nicparams[constants.NIC_LINK]
2794
    if nic.nicparams[constants.NIC_LINK]:
2795
      result["NIC_%d_LINK" % idx] = nic.nicparams[constants.NIC_LINK]
2796
    if nic.netinfo:
2797
      nobj = objects.Network.FromDict(nic.netinfo)
2798
      result.update(nobj.HooksDict("NIC_%d_" % idx))
2799
    if constants.HV_NIC_TYPE in instance.hvparams:
2800
      result["NIC_%d_FRONTEND_TYPE" % idx] = \
2801
        instance.hvparams[constants.HV_NIC_TYPE]
2802

    
2803
  # HV/BE params
2804
  for source, kind in [(instance.beparams, "BE"), (instance.hvparams, "HV")]:
2805
    for key, value in source.items():
2806
      result["INSTANCE_%s_%s" % (kind, key)] = str(value)
2807

    
2808
  return result
2809

    
2810

    
2811
def DiagnoseExtStorage(top_dirs=None):
2812
  """Compute the validity for all ExtStorage Providers.
2813

2814
  @type top_dirs: list
2815
  @param top_dirs: the list of directories in which to
2816
      search (if not given defaults to
2817
      L{pathutils.ES_SEARCH_PATH})
2818
  @rtype: list of L{objects.ExtStorage}
2819
  @return: a list of tuples (name, path, status, diagnose, parameters)
2820
      for all (potential) ExtStorage Providers under all
2821
      search paths, where:
2822
          - name is the (potential) ExtStorage Provider
2823
          - path is the full path to the ExtStorage Provider
2824
          - status True/False is the validity of the ExtStorage Provider
2825
          - diagnose is the error message for an invalid ExtStorage Provider,
2826
            otherwise empty
2827
          - parameters is a list of (name, help) parameters, if any
2828

2829
  """
2830
  if top_dirs is None:
2831
    top_dirs = pathutils.ES_SEARCH_PATH
2832

    
2833
  result = []
2834
  for dir_name in top_dirs:
2835
    if os.path.isdir(dir_name):
2836
      try:
2837
        f_names = utils.ListVisibleFiles(dir_name)
2838
      except EnvironmentError, err:
2839
        logging.exception("Can't list the ExtStorage directory %s: %s",
2840
                          dir_name, err)
2841
        break
2842
      for name in f_names:
2843
        es_path = utils.PathJoin(dir_name, name)
2844
        status, es_inst = bdev.ExtStorageFromDisk(name, base_dir=dir_name)
2845
        if status:
2846
          diagnose = ""
2847
          parameters = es_inst.supported_parameters
2848
        else:
2849
          diagnose = es_inst
2850
          parameters = []
2851
        result.append((name, es_path, status, diagnose, parameters))
2852

    
2853
  return result
2854

    
2855

    
2856
def BlockdevGrow(disk, amount, dryrun, backingstore, excl_stor):
2857
  """Grow a stack of block devices.
2858

2859
  This function is called recursively, with the childrens being the
2860
  first ones to resize.
2861

2862
  @type disk: L{objects.Disk}
2863
  @param disk: the disk to be grown
2864
  @type amount: integer
2865
  @param amount: the amount (in mebibytes) to grow with
2866
  @type dryrun: boolean
2867
  @param dryrun: whether to execute the operation in simulation mode
2868
      only, without actually increasing the size
2869
  @param backingstore: whether to execute the operation on backing storage
2870
      only, or on "logical" storage only; e.g. DRBD is logical storage,
2871
      whereas LVM, file, RBD are backing storage
2872
  @rtype: (status, result)
2873
  @type excl_stor: boolean
2874
  @param excl_stor: Whether exclusive_storage is active
2875
  @return: a tuple with the status of the operation (True/False), and
2876
      the errors message if status is False
2877

2878
  """
2879
  r_dev = _RecursiveFindBD(disk)
2880
  if r_dev is None:
2881
    _Fail("Cannot find block device %s", disk)
2882

    
2883
  try:
2884
    r_dev.Grow(amount, dryrun, backingstore, excl_stor)
2885
  except errors.BlockDeviceError, err:
2886
    _Fail("Failed to grow block device: %s", err, exc=True)
2887

    
2888

    
2889
def BlockdevSnapshot(disk):
2890
  """Create a snapshot copy of a block device.
2891

2892
  This function is called recursively, and the snapshot is actually created
2893
  just for the leaf lvm backend device.
2894

2895
  @type disk: L{objects.Disk}
2896
  @param disk: the disk to be snapshotted
2897
  @rtype: string
2898
  @return: snapshot disk ID as (vg, lv)
2899

2900
  """
2901
  if disk.dev_type == constants.LD_DRBD8:
2902
    if not disk.children:
2903
      _Fail("DRBD device '%s' without backing storage cannot be snapshotted",
2904
            disk.unique_id)
2905
    return BlockdevSnapshot(disk.children[0])
2906
  elif disk.dev_type == constants.LD_LV:
2907
    r_dev = _RecursiveFindBD(disk)
2908
    if r_dev is not None:
2909
      # FIXME: choose a saner value for the snapshot size
2910
      # let's stay on the safe side and ask for the full size, for now
2911
      return r_dev.Snapshot(disk.size)
2912
    else:
2913
      _Fail("Cannot find block device %s", disk)
2914
  else:
2915
    _Fail("Cannot snapshot non-lvm block device '%s' of type '%s'",
2916
          disk.unique_id, disk.dev_type)
2917

    
2918

    
2919
def BlockdevSetInfo(disk, info):
2920
  """Sets 'metadata' information on block devices.
2921

2922
  This function sets 'info' metadata on block devices. Initial
2923
  information is set at device creation; this function should be used
2924
  for example after renames.
2925

2926
  @type disk: L{objects.Disk}
2927
  @param disk: the disk to be grown
2928
  @type info: string
2929
  @param info: new 'info' metadata
2930
  @rtype: (status, result)
2931
  @return: a tuple with the status of the operation (True/False), and
2932
      the errors message if status is False
2933

2934
  """
2935
  r_dev = _RecursiveFindBD(disk)
2936
  if r_dev is None:
2937
    _Fail("Cannot find block device %s", disk)
2938

    
2939
  try:
2940
    r_dev.SetInfo(info)
2941
  except errors.BlockDeviceError, err:
2942
    _Fail("Failed to set information on block device: %s", err, exc=True)
2943

    
2944

    
2945
def FinalizeExport(instance, snap_disks):
2946
  """Write out the export configuration information.
2947

2948
  @type instance: L{objects.Instance}
2949
  @param instance: the instance which we export, used for
2950
      saving configuration
2951
  @type snap_disks: list of L{objects.Disk}
2952
  @param snap_disks: list of snapshot block devices, which
2953
      will be used to get the actual name of the dump file
2954

2955
  @rtype: None
2956

2957
  """
2958
  destdir = utils.PathJoin(pathutils.EXPORT_DIR, instance.name + ".new")
2959
  finaldestdir = utils.PathJoin(pathutils.EXPORT_DIR, instance.name)
2960

    
2961
  config = objects.SerializableConfigParser()
2962

    
2963
  config.add_section(constants.INISECT_EXP)
2964
  config.set(constants.INISECT_EXP, "version", "0")
2965
  config.set(constants.INISECT_EXP, "timestamp", "%d" % int(time.time()))
2966
  config.set(constants.INISECT_EXP, "source", instance.primary_node)
2967
  config.set(constants.INISECT_EXP, "os", instance.os)
2968
  config.set(constants.INISECT_EXP, "compression", "none")
2969

    
2970
  config.add_section(constants.INISECT_INS)
2971
  config.set(constants.INISECT_INS, "name", instance.name)
2972
  config.set(constants.INISECT_INS, "maxmem", "%d" %
2973
             instance.beparams[constants.BE_MAXMEM])
2974
  config.set(constants.INISECT_INS, "minmem", "%d" %
2975
             instance.beparams[constants.BE_MINMEM])
2976
  # "memory" is deprecated, but useful for exporting to old ganeti versions
2977
  config.set(constants.INISECT_INS, "memory", "%d" %
2978
             instance.beparams[constants.BE_MAXMEM])
2979
  config.set(constants.INISECT_INS, "vcpus", "%d" %
2980
             instance.beparams[constants.BE_VCPUS])
2981
  config.set(constants.INISECT_INS, "disk_template", instance.disk_template)
2982
  config.set(constants.INISECT_INS, "hypervisor", instance.hypervisor)
2983
  config.set(constants.INISECT_INS, "tags", " ".join(instance.GetTags()))
2984

    
2985
  nic_total = 0
2986
  for nic_count, nic in enumerate(instance.nics):
2987
    nic_total += 1
2988
    config.set(constants.INISECT_INS, "nic%d_mac" %
2989
               nic_count, "%s" % nic.mac)
2990
    config.set(constants.INISECT_INS, "nic%d_ip" % nic_count, "%s" % nic.ip)
2991
    config.set(constants.INISECT_INS, "nic%d_network" % nic_count,
2992
               "%s" % nic.network)
2993
    for param in constants.NICS_PARAMETER_TYPES:
2994
      config.set(constants.INISECT_INS, "nic%d_%s" % (nic_count, param),
2995
                 "%s" % nic.nicparams.get(param, None))
2996
  # TODO: redundant: on load can read nics until it doesn't exist
2997
  config.set(constants.INISECT_INS, "nic_count", "%d" % nic_total)
2998

    
2999
  disk_total = 0
3000
  for disk_count, disk in enumerate(snap_disks):
3001
    if disk:
3002
      disk_total += 1
3003
      config.set(constants.INISECT_INS, "disk%d_ivname" % disk_count,
3004
                 ("%s" % disk.iv_name))
3005
      config.set(constants.INISECT_INS, "disk%d_dump" % disk_count,
3006
                 ("%s" % disk.physical_id[1]))
3007
      config.set(constants.INISECT_INS, "disk%d_size" % disk_count,
3008
                 ("%d" % disk.size))
3009

    
3010
  config.set(constants.INISECT_INS, "disk_count", "%d" % disk_total)
3011

    
3012
  # New-style hypervisor/backend parameters
3013

    
3014
  config.add_section(constants.INISECT_HYP)
3015
  for name, value in instance.hvparams.items():
3016
    if name not in constants.HVC_GLOBALS:
3017
      config.set(constants.INISECT_HYP, name, str(value))
3018

    
3019
  config.add_section(constants.INISECT_BEP)
3020
  for name, value in instance.beparams.items():
3021
    config.set(constants.INISECT_BEP, name, str(value))
3022

    
3023
  config.add_section(constants.INISECT_OSP)
3024
  for name, value in instance.osparams.items():
3025
    config.set(constants.INISECT_OSP, name, str(value))
3026

    
3027
  utils.WriteFile(utils.PathJoin(destdir, constants.EXPORT_CONF_FILE),
3028
                  data=config.Dumps())
3029
  shutil.rmtree(finaldestdir, ignore_errors=True)
3030
  shutil.move(destdir, finaldestdir)
3031

    
3032

    
3033
def ExportInfo(dest):
3034
  """Get export configuration information.
3035

3036
  @type dest: str
3037
  @param dest: directory containing the export
3038

3039
  @rtype: L{objects.SerializableConfigParser}
3040
  @return: a serializable config file containing the
3041
      export info
3042

3043
  """
3044
  cff = utils.PathJoin(dest, constants.EXPORT_CONF_FILE)
3045

    
3046
  config = objects.SerializableConfigParser()
3047
  config.read(cff)
3048

    
3049
  if (not config.has_section(constants.INISECT_EXP) or
3050
      not config.has_section(constants.INISECT_INS)):
3051
    _Fail("Export info file doesn't have the required fields")
3052

    
3053
  return config.Dumps()
3054

    
3055

    
3056
def ListExports():
3057
  """Return a list of exports currently available on this machine.
3058

3059
  @rtype: list
3060
  @return: list of the exports
3061

3062
  """
3063
  if os.path.isdir(pathutils.EXPORT_DIR):
3064
    return sorted(utils.ListVisibleFiles(pathutils.EXPORT_DIR))
3065
  else:
3066
    _Fail("No exports directory")
3067

    
3068

    
3069
def RemoveExport(export):
3070
  """Remove an existing export from the node.
3071

3072
  @type export: str
3073
  @param export: the name of the export to remove
3074
  @rtype: None
3075

3076
  """
3077
  target = utils.PathJoin(pathutils.EXPORT_DIR, export)
3078

    
3079
  try:
3080
    shutil.rmtree(target)
3081
  except EnvironmentError, err:
3082
    _Fail("Error while removing the export: %s", err, exc=True)
3083

    
3084

    
3085
def BlockdevRename(devlist):
3086
  """Rename a list of block devices.
3087

3088
  @type devlist: list of tuples
3089
  @param devlist: list of tuples of the form  (disk,
3090
      new_logical_id, new_physical_id); disk is an
3091
      L{objects.Disk} object describing the current disk,
3092
      and new logical_id/physical_id is the name we
3093
      rename it to
3094
  @rtype: boolean
3095
  @return: True if all renames succeeded, False otherwise
3096

3097
  """
3098
  msgs = []
3099
  result = True
3100
  for disk, unique_id in devlist:
3101
    dev = _RecursiveFindBD(disk)
3102
    if dev is None:
3103
      msgs.append("Can't find device %s in rename" % str(disk))
3104
      result = False
3105
      continue
3106
    try:
3107
      old_rpath = dev.dev_path
3108
      dev.Rename(unique_id)
3109
      new_rpath = dev.dev_path
3110
      if old_rpath != new_rpath:
3111
        DevCacheManager.RemoveCache(old_rpath)
3112
        # FIXME: we should add the new cache information here, like:
3113
        # DevCacheManager.UpdateCache(new_rpath, owner, ...)
3114
        # but we don't have the owner here - maybe parse from existing
3115
        # cache? for now, we only lose lvm data when we rename, which
3116
        # is less critical than DRBD or MD
3117
    except errors.BlockDeviceError, err:
3118
      msgs.append("Can't rename device '%s' to '%s': %s" %
3119
                  (dev, unique_id, err))
3120
      logging.exception("Can't rename device '%s' to '%s'", dev, unique_id)
3121
      result = False
3122
  if not result:
3123
    _Fail("; ".join(msgs))
3124

    
3125

    
3126
def _TransformFileStorageDir(fs_dir):
3127
  """Checks whether given file_storage_dir is valid.
3128

3129
  Checks wheter the given fs_dir is within the cluster-wide default
3130
  file_storage_dir or the shared_file_storage_dir, which are stored in
3131
  SimpleStore. Only paths under those directories are allowed.
3132

3133
  @type fs_dir: str
3134
  @param fs_dir: the path to check
3135

3136
  @return: the normalized path if valid, None otherwise
3137

3138
  """
3139
  if not (constants.ENABLE_FILE_STORAGE or
3140
          constants.ENABLE_SHARED_FILE_STORAGE):
3141
    _Fail("File storage disabled at configure time")
3142

    
3143
  bdev.CheckFileStoragePath(fs_dir)
3144

    
3145
  return os.path.normpath(fs_dir)
3146

    
3147

    
3148
def CreateFileStorageDir(file_storage_dir):
3149
  """Create file storage directory.
3150

3151
  @type file_storage_dir: str
3152
  @param file_storage_dir: directory to create
3153

3154
  @rtype: tuple
3155
  @return: tuple with first element a boolean indicating wheter dir
3156
      creation was successful or not
3157

3158
  """
3159
  file_storage_dir = _TransformFileStorageDir(file_storage_dir)
3160
  if os.path.exists(file_storage_dir):
3161
    if not os.path.isdir(file_storage_dir):
3162
      _Fail("Specified storage dir '%s' is not a directory",
3163
            file_storage_dir)
3164
  else:
3165
    try:
3166
      os.makedirs(file_storage_dir, 0750)
3167
    except OSError, err:
3168
      _Fail("Cannot create file storage directory '%s': %s",
3169
            file_storage_dir, err, exc=True)
3170

    
3171

    
3172
def RemoveFileStorageDir(file_storage_dir):
3173
  """Remove file storage directory.
3174

3175
  Remove it only if it's empty. If not log an error and return.
3176

3177
  @type file_storage_dir: str
3178
  @param file_storage_dir: the directory we should cleanup
3179
  @rtype: tuple (success,)
3180
  @return: tuple of one element, C{success}, denoting
3181
      whether the operation was successful
3182

3183
  """
3184
  file_storage_dir = _TransformFileStorageDir(file_storage_dir)
3185
  if os.path.exists(file_storage_dir):
3186
    if not os.path.isdir(file_storage_dir):
3187
      _Fail("Specified Storage directory '%s' is not a directory",
3188
            file_storage_dir)
3189
    # deletes dir only if empty, otherwise we want to fail the rpc call
3190
    try:
3191
      os.rmdir(file_storage_dir)
3192
    except OSError, err:
3193
      _Fail("Cannot remove file storage directory '%s': %s",
3194
            file_storage_dir, err)
3195

    
3196

    
3197
def RenameFileStorageDir(old_file_storage_dir, new_file_storage_dir):
3198
  """Rename the file storage directory.
3199

3200
  @type old_file_storage_dir: str
3201
  @param old_file_storage_dir: the current path
3202
  @type new_file_storage_dir: str
3203
  @param new_file_storage_dir: the name we should rename to
3204
  @rtype: tuple (success,)
3205
  @return: tuple of one element, C{success}, denoting
3206
      whether the operation was successful
3207

3208
  """
3209
  old_file_storage_dir = _TransformFileStorageDir(old_file_storage_dir)
3210
  new_file_storage_dir = _TransformFileStorageDir(new_file_storage_dir)
3211
  if not os.path.exists(new_file_storage_dir):
3212
    if os.path.isdir(old_file_storage_dir):
3213
      try:
3214
        os.rename(old_file_storage_dir, new_file_storage_dir)
3215
      except OSError, err:
3216
        _Fail("Cannot rename '%s' to '%s': %s",
3217
              old_file_storage_dir, new_file_storage_dir, err)
3218
    else:
3219
      _Fail("Specified storage dir '%s' is not a directory",
3220
            old_file_storage_dir)
3221
  else:
3222
    if os.path.exists(old_file_storage_dir):
3223
      _Fail("Cannot rename '%s' to '%s': both locations exist",
3224
            old_file_storage_dir, new_file_storage_dir)
3225

    
3226

    
3227
def _EnsureJobQueueFile(file_name):
3228
  """Checks whether the given filename is in the queue directory.
3229

3230
  @type file_name: str
3231
  @param file_name: the file name we should check
3232
  @rtype: None
3233
  @raises RPCFail: if the file is not valid
3234

3235
  """
3236
  if not utils.IsBelowDir(pathutils.QUEUE_DIR, file_name):
3237
    _Fail("Passed job queue file '%s' does not belong to"
3238
          " the queue directory '%s'", file_name, pathutils.QUEUE_DIR)
3239

    
3240

    
3241
def JobQueueUpdate(file_name, content):
3242
  """Updates a file in the queue directory.
3243

3244
  This is just a wrapper over L{utils.io.WriteFile}, with proper
3245
  checking.
3246

3247
  @type file_name: str
3248
  @param file_name: the job file name
3249
  @type content: str
3250
  @param content: the new job contents
3251
  @rtype: boolean
3252
  @return: the success of the operation
3253

3254
  """
3255
  file_name = vcluster.LocalizeVirtualPath(file_name)
3256

    
3257
  _EnsureJobQueueFile(file_name)
3258
  getents = runtime.GetEnts()
3259

    
3260
  # Write and replace the file atomically
3261
  utils.WriteFile(file_name, data=_Decompress(content), uid=getents.masterd_uid,
3262
                  gid=getents.daemons_gid, mode=constants.JOB_QUEUE_FILES_PERMS)
3263

    
3264

    
3265
def JobQueueRename(old, new):
3266
  """Renames a job queue file.
3267

3268
  This is just a wrapper over os.rename with proper checking.
3269

3270
  @type old: str
3271
  @param old: the old (actual) file name
3272
  @type new: str
3273
  @param new: the desired file name
3274
  @rtype: tuple
3275
  @return: the success of the operation and payload
3276

3277
  """
3278
  old = vcluster.LocalizeVirtualPath(old)
3279
  new = vcluster.LocalizeVirtualPath(new)
3280

    
3281
  _EnsureJobQueueFile(old)
3282
  _EnsureJobQueueFile(new)
3283

    
3284
  getents = runtime.GetEnts()
3285

    
3286
  utils.RenameFile(old, new, mkdir=True, mkdir_mode=0750,
3287
                   dir_uid=getents.masterd_uid, dir_gid=getents.daemons_gid)
3288

    
3289

    
3290
def BlockdevClose(instance_name, disks):
3291
  """Closes the given block devices.
3292

3293
  This means they will be switched to secondary mode (in case of
3294
  DRBD).
3295

3296
  @param instance_name: if the argument is not empty, the symlinks
3297
      of this instance will be removed
3298
  @type disks: list of L{objects.Disk}
3299
  @param disks: the list of disks to be closed
3300
  @rtype: tuple (success, message)
3301
  @return: a tuple of success and message, where success
3302
      indicates the succes of the operation, and message
3303
      which will contain the error details in case we
3304
      failed
3305

3306
  """
3307
  bdevs = []
3308
  for cf in disks:
3309
    rd = _RecursiveFindBD(cf)
3310
    if rd is None:
3311
      _Fail("Can't find device %s", cf)
3312
    bdevs.append(rd)
3313

    
3314
  msg = []
3315
  for rd in bdevs:
3316
    try:
3317
      rd.Close()
3318
    except errors.BlockDeviceError, err:
3319
      msg.append(str(err))
3320
  if msg:
3321
    _Fail("Can't make devices secondary: %s", ",".join(msg))
3322
  else:
3323
    if instance_name:
3324
      _RemoveBlockDevLinks(instance_name, disks)
3325

    
3326

    
3327
def ValidateHVParams(hvname, hvparams):
3328
  """Validates the given hypervisor parameters.
3329

3330
  @type hvname: string
3331
  @param hvname: the hypervisor name
3332
  @type hvparams: dict
3333
  @param hvparams: the hypervisor parameters to be validated
3334
  @rtype: None
3335

3336
  """
3337
  try:
3338
    hv_type = hypervisor.GetHypervisor(hvname)
3339
    hv_type.ValidateParameters(hvparams)
3340
  except errors.HypervisorError, err:
3341
    _Fail(str(err), log=False)
3342

    
3343

    
3344
def _CheckOSPList(os_obj, parameters):
3345
  """Check whether a list of parameters is supported by the OS.
3346

3347
  @type os_obj: L{objects.OS}
3348
  @param os_obj: OS object to check
3349
  @type parameters: list
3350
  @param parameters: the list of parameters to check
3351

3352
  """
3353
  supported = [v[0] for v in os_obj.supported_parameters]
3354
  delta = frozenset(parameters).difference(supported)
3355
  if delta:
3356
    _Fail("The following parameters are not supported"
3357
          " by the OS %s: %s" % (os_obj.name, utils.CommaJoin(delta)))
3358

    
3359

    
3360
def ValidateOS(required, osname, checks, osparams):
3361
  """Validate the given OS' parameters.
3362

3363
  @type required: boolean
3364
  @param required: whether absence of the OS should translate into
3365
      failure or not
3366
  @type osname: string
3367
  @param osname: the OS to be validated
3368
  @type checks: list
3369
  @param checks: list of the checks to run (currently only 'parameters')
3370
  @type osparams: dict
3371
  @param osparams: dictionary with OS parameters
3372
  @rtype: boolean
3373
  @return: True if the validation passed, or False if the OS was not
3374
      found and L{required} was false
3375

3376
  """
3377
  if not constants.OS_VALIDATE_CALLS.issuperset(checks):
3378
    _Fail("Unknown checks required for OS %s: %s", osname,
3379
          set(checks).difference(constants.OS_VALIDATE_CALLS))
3380

    
3381
  name_only = objects.OS.GetName(osname)
3382
  status, tbv = _TryOSFromDisk(name_only, None)
3383

    
3384
  if not status:
3385
    if required:
3386
      _Fail(tbv)
3387
    else:
3388
      return False
3389

    
3390
  if max(tbv.api_versions) < constants.OS_API_V20:
3391
    return True
3392

    
3393
  if constants.OS_VALIDATE_PARAMETERS in checks:
3394
    _CheckOSPList(tbv, osparams.keys())
3395

    
3396
  validate_env = OSCoreEnv(osname, tbv, osparams)
3397
  result = utils.RunCmd([tbv.verify_script] + checks, env=validate_env,
3398
                        cwd=tbv.path, reset_env=True)
3399
  if result.failed:
3400
    logging.error("os validate command '%s' returned error: %s output: %s",
3401
                  result.cmd, result.fail_reason, result.output)
3402
    _Fail("OS validation script failed (%s), output: %s",
3403
          result.fail_reason, result.output, log=False)
3404

    
3405
  return True
3406

    
3407

    
3408
def DemoteFromMC():
3409
  """Demotes the current node from master candidate role.
3410

3411
  """
3412
  # try to ensure we're not the master by mistake
3413
  master, myself = ssconf.GetMasterAndMyself()
3414
  if master == myself:
3415
    _Fail("ssconf status shows I'm the master node, will not demote")
3416

    
3417
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "check", constants.MASTERD])
3418
  if not result.failed:
3419
    _Fail("The master daemon is running, will not demote")
3420

    
3421
  try:
3422
    if os.path.isfile(pathutils.CLUSTER_CONF_FILE):
3423
      utils.CreateBackup(pathutils.CLUSTER_CONF_FILE)
3424
  except EnvironmentError, err:
3425
    if err.errno != errno.ENOENT:
3426
      _Fail("Error while backing up cluster file: %s", err, exc=True)
3427

    
3428
  utils.RemoveFile(pathutils.CLUSTER_CONF_FILE)
3429

    
3430

    
3431
def _GetX509Filenames(cryptodir, name):
3432
  """Returns the full paths for the private key and certificate.
3433

3434
  """
3435
  return (utils.PathJoin(cryptodir, name),
3436
          utils.PathJoin(cryptodir, name, _X509_KEY_FILE),
3437
          utils.PathJoin(cryptodir, name, _X509_CERT_FILE))
3438

    
3439

    
3440
def CreateX509Certificate(validity, cryptodir=pathutils.CRYPTO_KEYS_DIR):
3441
  """Creates a new X509 certificate for SSL/TLS.
3442

3443
  @type validity: int
3444
  @param validity: Validity in seconds
3445
  @rtype: tuple; (string, string)
3446
  @return: Certificate name and public part
3447

3448
  """
3449
  (key_pem, cert_pem) = \
3450
    utils.GenerateSelfSignedX509Cert(netutils.Hostname.GetSysName(),
3451
                                     min(validity, _MAX_SSL_CERT_VALIDITY))
3452

    
3453
  cert_dir = tempfile.mkdtemp(dir=cryptodir,
3454
                              prefix="x509-%s-" % utils.TimestampForFilename())
3455
  try:
3456
    name = os.path.basename(cert_dir)
3457
    assert len(name) > 5
3458

    
3459
    (_, key_file, cert_file) = _GetX509Filenames(cryptodir, name)
3460

    
3461
    utils.WriteFile(key_file, mode=0400, data=key_pem)
3462
    utils.WriteFile(cert_file, mode=0400, data=cert_pem)
3463

    
3464
    # Never return private key as it shouldn't leave the node
3465
    return (name, cert_pem)
3466
  except Exception:
3467
    shutil.rmtree(cert_dir, ignore_errors=True)
3468
    raise
3469

    
3470

    
3471
def RemoveX509Certificate(name, cryptodir=pathutils.CRYPTO_KEYS_DIR):
3472
  """Removes a X509 certificate.
3473

3474
  @type name: string
3475
  @param name: Certificate name
3476

3477
  """
3478
  (cert_dir, key_file, cert_file) = _GetX509Filenames(cryptodir, name)
3479

    
3480
  utils.RemoveFile(key_file)
3481
  utils.RemoveFile(cert_file)
3482

    
3483
  try:
3484
    os.rmdir(cert_dir)
3485
  except EnvironmentError, err:
3486
    _Fail("Cannot remove certificate directory '%s': %s",
3487
          cert_dir, err)
3488

    
3489

    
3490
def _GetImportExportIoCommand(instance, mode, ieio, ieargs):
3491
  """Returns the command for the requested input/output.
3492

3493
  @type instance: L{objects.Instance}
3494
  @param instance: The instance object
3495
  @param mode: Import/export mode
3496
  @param ieio: Input/output type
3497
  @param ieargs: Input/output arguments
3498

3499
  """
3500
  assert mode in (constants.IEM_IMPORT, constants.IEM_EXPORT)
3501

    
3502
  env = None
3503
  prefix = None
3504
  suffix = None
3505
  exp_size = None
3506

    
3507
  if ieio == constants.IEIO_FILE:
3508
    (filename, ) = ieargs
3509

    
3510
    if not utils.IsNormAbsPath(filename):
3511
      _Fail("Path '%s' is not normalized or absolute", filename)
3512

    
3513
    real_filename = os.path.realpath(filename)
3514
    directory = os.path.dirname(real_filename)
3515

    
3516
    if not utils.IsBelowDir(pathutils.EXPORT_DIR, real_filename):
3517
      _Fail("File '%s' is not under exports directory '%s': %s",
3518
            filename, pathutils.EXPORT_DIR, real_filename)
3519

    
3520
    # Create directory
3521
    utils.Makedirs(directory, mode=0750)
3522

    
3523
    quoted_filename = utils.ShellQuote(filename)
3524

    
3525
    if mode == constants.IEM_IMPORT:
3526
      suffix = "> %s" % quoted_filename
3527
    elif mode == constants.IEM_EXPORT:
3528
      suffix = "< %s" % quoted_filename
3529

    
3530
      # Retrieve file size
3531
      try:
3532
        st = os.stat(filename)
3533
      except EnvironmentError, err:
3534
        logging.error("Can't stat(2) %s: %s", filename, err)
3535
      else:
3536
        exp_size = utils.BytesToMebibyte(st.st_size)
3537

    
3538
  elif ieio == constants.IEIO_RAW_DISK:
3539
    (disk, ) = ieargs
3540

    
3541
    real_disk = _OpenRealBD(disk)
3542

    
3543
    if mode == constants.IEM_IMPORT:
3544
      # we set here a smaller block size as, due to transport buffering, more
3545
      # than 64-128k will mostly ignored; we use nocreat to fail if the device
3546
      # is not already there or we pass a wrong path; we use notrunc to no
3547
      # attempt truncate on an LV device; we use oflag=dsync to not buffer too
3548
      # much memory; this means that at best, we flush every 64k, which will
3549
      # not be very fast
3550
      suffix = utils.BuildShellCmd(("| dd of=%s conv=nocreat,notrunc"
3551
                                    " bs=%s oflag=dsync"),
3552
                                    real_disk.dev_path,
3553
                                    str(64 * 1024))
3554

    
3555
    elif mode == constants.IEM_EXPORT:
3556
      # the block size on the read dd is 1MiB to match our units
3557
      prefix = utils.BuildShellCmd("dd if=%s bs=%s count=%s |",
3558
                                   real_disk.dev_path,
3559
                                   str(1024 * 1024), # 1 MB
3560
                                   str(disk.size))
3561
      exp_size = disk.size
3562

    
3563
  elif ieio == constants.IEIO_SCRIPT:
3564
    (disk, disk_index, ) = ieargs
3565

    
3566
    assert isinstance(disk_index, (int, long))
3567

    
3568
    real_disk = _OpenRealBD(disk)
3569

    
3570
    inst_os = OSFromDisk(instance.os)
3571
    env = OSEnvironment(instance, inst_os)
3572

    
3573
    if mode == constants.IEM_IMPORT:
3574
      env["IMPORT_DEVICE"] = env["DISK_%d_PATH" % disk_index]
3575
      env["IMPORT_INDEX"] = str(disk_index)
3576
      script = inst_os.import_script
3577

    
3578
    elif mode == constants.IEM_EXPORT:
3579
      env["EXPORT_DEVICE"] = real_disk.dev_path
3580
      env["EXPORT_INDEX"] = str(disk_index)
3581
      script = inst_os.export_script
3582

    
3583
    # TODO: Pass special environment only to script
3584
    script_cmd = utils.BuildShellCmd("( cd %s && %s; )", inst_os.path, script)
3585

    
3586
    if mode == constants.IEM_IMPORT:
3587
      suffix = "| %s" % script_cmd
3588

    
3589
    elif mode == constants.IEM_EXPORT:
3590
      prefix = "%s |" % script_cmd
3591

    
3592
    # Let script predict size
3593
    exp_size = constants.IE_CUSTOM_SIZE
3594

    
3595
  else:
3596
    _Fail("Invalid %s I/O mode %r", mode, ieio)
3597

    
3598
  return (env, prefix, suffix, exp_size)
3599

    
3600

    
3601
def _CreateImportExportStatusDir(prefix):
3602
  """Creates status directory for import/export.
3603

3604
  """
3605
  return tempfile.mkdtemp(dir=pathutils.IMPORT_EXPORT_DIR,
3606
                          prefix=("%s-%s-" %
3607
                                  (prefix, utils.TimestampForFilename())))
3608

    
3609

    
3610
def StartImportExportDaemon(mode, opts, host, port, instance, component,
3611
                            ieio, ieioargs):
3612
  """Starts an import or export daemon.
3613

3614
  @param mode: Import/output mode
3615
  @type opts: L{objects.ImportExportOptions}
3616
  @param opts: Daemon options
3617
  @type host: string
3618
  @param host: Remote host for export (None for import)
3619
  @type port: int
3620
  @param port: Remote port for export (None for import)
3621
  @type instance: L{objects.Instance}
3622
  @param instance: Instance object
3623
  @type component: string
3624
  @param component: which part of the instance is transferred now,
3625
      e.g. 'disk/0'
3626
  @param ieio: Input/output type
3627
  @param ieioargs: Input/output arguments
3628

3629
  """
3630
  if mode == constants.IEM_IMPORT:
3631
    prefix = "import"
3632

    
3633
    if not (host is None and port is None):
3634
      _Fail("Can not specify host or port on import")
3635

    
3636
  elif mode == constants.IEM_EXPORT:
3637
    prefix = "export"
3638

    
3639
    if host is None or port is None:
3640
      _Fail("Host and port must be specified for an export")
3641

    
3642
  else:
3643
    _Fail("Invalid mode %r", mode)
3644

    
3645
  if (opts.key_name is None) ^ (opts.ca_pem is None):
3646
    _Fail("Cluster certificate can only be used for both key and CA")
3647

    
3648
  (cmd_env, cmd_prefix, cmd_suffix, exp_size) = \
3649
    _GetImportExportIoCommand(instance, mode, ieio, ieioargs)
3650

    
3651
  if opts.key_name is None:
3652
    # Use server.pem
3653
    key_path = pathutils.NODED_CERT_FILE
3654
    cert_path = pathutils.NODED_CERT_FILE
3655
    assert opts.ca_pem is None
3656
  else:
3657
    (_, key_path, cert_path) = _GetX509Filenames(pathutils.CRYPTO_KEYS_DIR,
3658
                                                 opts.key_name)
3659
    assert opts.ca_pem is not None
3660

    
3661
  for i in [key_path, cert_path]:
3662
    if not os.path.exists(i):
3663
      _Fail("File '%s' does not exist" % i)
3664

    
3665
  status_dir = _CreateImportExportStatusDir("%s-%s" % (prefix, component))
3666
  try:
3667
    status_file = utils.PathJoin(status_dir, _IES_STATUS_FILE)
3668
    pid_file = utils.PathJoin(status_dir, _IES_PID_FILE)
3669
    ca_file = utils.PathJoin(status_dir, _IES_CA_FILE)
3670

    
3671
    if opts.ca_pem is None:
3672
      # Use server.pem
3673
      ca = utils.ReadFile(pathutils.NODED_CERT_FILE)
3674
    else:
3675
      ca = opts.ca_pem
3676

    
3677
    # Write CA file
3678
    utils.WriteFile(ca_file, data=ca, mode=0400)
3679

    
3680
    cmd = [
3681
      pathutils.IMPORT_EXPORT_DAEMON,
3682
      status_file, mode,
3683
      "--key=%s" % key_path,
3684
      "--cert=%s" % cert_path,
3685
      "--ca=%s" % ca_file,
3686
      ]
3687

    
3688
    if host:
3689
      cmd.append("--host=%s" % host)
3690

    
3691
    if port:
3692
      cmd.append("--port=%s" % port)
3693

    
3694
    if opts.ipv6:
3695
      cmd.append("--ipv6")
3696
    else:
3697
      cmd.append("--ipv4")
3698

    
3699
    if opts.compress:
3700
      cmd.append("--compress=%s" % opts.compress)
3701

    
3702
    if opts.magic:
3703
      cmd.append("--magic=%s" % opts.magic)
3704

    
3705
    if exp_size is not None:
3706
      cmd.append("--expected-size=%s" % exp_size)
3707

    
3708
    if cmd_prefix:
3709
      cmd.append("--cmd-prefix=%s" % cmd_prefix)
3710

    
3711
    if cmd_suffix:
3712
      cmd.append("--cmd-suffix=%s" % cmd_suffix)
3713

    
3714
    if mode == constants.IEM_EXPORT:
3715
      # Retry connection a few times when connecting to remote peer
3716
      cmd.append("--connect-retries=%s" % constants.RIE_CONNECT_RETRIES)
3717
      cmd.append("--connect-timeout=%s" % constants.RIE_CONNECT_ATTEMPT_TIMEOUT)
3718
    elif opts.connect_timeout is not None:
3719
      assert mode == constants.IEM_IMPORT
3720
      # Overall timeout for establishing connection while listening
3721
      cmd.append("--connect-timeout=%s" % opts.connect_timeout)
3722

    
3723
    logfile = _InstanceLogName(prefix, instance.os, instance.name, component)
3724

    
3725
    # TODO: Once _InstanceLogName uses tempfile.mkstemp, StartDaemon has
3726
    # support for receiving a file descriptor for output
3727
    utils.StartDaemon(cmd, env=cmd_env, pidfile=pid_file,
3728
                      output=logfile)
3729

    
3730
    # The import/export name is simply the status directory name
3731
    return os.path.basename(status_dir)
3732

    
3733
  except Exception:
3734
    shutil.rmtree(status_dir, ignore_errors=True)
3735
    raise
3736

    
3737

    
3738
def GetImportExportStatus(names):
3739
  """Returns import/export daemon status.
3740

3741
  @type names: sequence
3742
  @param names: List of names
3743
  @rtype: List of dicts
3744
  @return: Returns a list of the state of each named import/export or None if a
3745
           status couldn't be read
3746

3747
  """
3748
  result = []
3749

    
3750
  for name in names:
3751
    status_file = utils.PathJoin(pathutils.IMPORT_EXPORT_DIR, name,
3752
                                 _IES_STATUS_FILE)
3753

    
3754
    try:
3755
      data = utils.ReadFile(status_file)
3756
    except EnvironmentError, err:
3757
      if err.errno != errno.ENOENT:
3758
        raise
3759
      data = None
3760

    
3761
    if not data:
3762
      result.append(None)
3763
      continue
3764

    
3765
    result.append(serializer.LoadJson(data))
3766

    
3767
  return result
3768

    
3769

    
3770
def AbortImportExport(name):
3771
  """Sends SIGTERM to a running import/export daemon.
3772

3773
  """
3774
  logging.info("Abort import/export %s", name)
3775

    
3776
  status_dir = utils.PathJoin(pathutils.IMPORT_EXPORT_DIR, name)
3777
  pid = utils.ReadLockedPidFile(utils.PathJoin(status_dir, _IES_PID_FILE))
3778

    
3779
  if pid:
3780
    logging.info("Import/export %s is running with PID %s, sending SIGTERM",
3781
                 name, pid)
3782
    utils.IgnoreProcessNotFound(os.kill, pid, signal.SIGTERM)
3783

    
3784

    
3785
def CleanupImportExport(name):
3786
  """Cleanup after an import or export.
3787

3788
  If the import/export daemon is still running it's killed. Afterwards the
3789
  whole status directory is removed.
3790

3791
  """
3792
  logging.info("Finalizing import/export %s", name)
3793

    
3794
  status_dir = utils.PathJoin(pathutils.IMPORT_EXPORT_DIR, name)
3795

    
3796
  pid = utils.ReadLockedPidFile(utils.PathJoin(status_dir, _IES_PID_FILE))
3797

    
3798
  if pid:
3799
    logging.info("Import/export %s is still running with PID %s",
3800
                 name, pid)
3801
    utils.KillProcess(pid, waitpid=False)
3802

    
3803
  shutil.rmtree(status_dir, ignore_errors=True)
3804

    
3805

    
3806
def _FindDisks(target_node_uuid, nodes_ip, disks):
3807
  """Sets the physical ID on disks and returns the block devices.
3808

3809
  """
3810
  # set the correct physical ID
3811
  for cf in disks:
3812
    cf.SetPhysicalID(target_node_uuid, nodes_ip)
3813

    
3814
  bdevs = []
3815

    
3816
  for cf in disks:
3817
    rd = _RecursiveFindBD(cf)
3818
    if rd is None:
3819
      _Fail("Can't find device %s", cf)
3820
    bdevs.append(rd)
3821
  return bdevs
3822

    
3823

    
3824
def DrbdDisconnectNet(target_node_uuid, nodes_ip, disks):
3825
  """Disconnects the network on a list of drbd devices.
3826

3827
  """
3828
  bdevs = _FindDisks(target_node_uuid, nodes_ip, disks)
3829

    
3830
  # disconnect disks
3831
  for rd in bdevs:
3832
    try:
3833
      rd.DisconnectNet()
3834
    except errors.BlockDeviceError, err:
3835
      _Fail("Can't change network configuration to standalone mode: %s",
3836
            err, exc=True)
3837

    
3838

    
3839
def DrbdAttachNet(target_node_uuid, nodes_ip, disks, instance_name,
3840
                  multimaster):
3841
  """Attaches the network on a list of drbd devices.
3842

3843
  """
3844
  bdevs = _FindDisks(target_node_uuid, nodes_ip, disks)
3845

    
3846
  if multimaster:
3847
    for idx, rd in enumerate(bdevs):
3848
      try:
3849
        _SymlinkBlockDev(instance_name, rd.dev_path, idx)
3850
      except EnvironmentError, err:
3851
        _Fail("Can't create symlink: %s", err)
3852
  # reconnect disks, switch to new master configuration and if
3853
  # needed primary mode
3854
  for rd in bdevs:
3855
    try:
3856
      rd.AttachNet(multimaster)
3857
    except errors.BlockDeviceError, err:
3858
      _Fail("Can't change network configuration: %s", err)
3859

    
3860
  # wait until the disks are connected; we need to retry the re-attach
3861
  # if the device becomes standalone, as this might happen if the one
3862
  # node disconnects and reconnects in a different mode before the
3863
  # other node reconnects; in this case, one or both of the nodes will
3864
  # decide it has wrong configuration and switch to standalone
3865

    
3866
  def _Attach():
3867
    all_connected = True
3868

    
3869
    for rd in bdevs:
3870
      stats = rd.GetProcStatus()
3871

    
3872
      all_connected = (all_connected and
3873
                       (stats.is_connected or stats.is_in_resync))
3874

    
3875
      if stats.is_standalone:
3876
        # peer had different config info and this node became
3877
        # standalone, even though this should not happen with the
3878
        # new staged way of changing disk configs
3879
        try:
3880
          rd.AttachNet(multimaster)
3881
        except errors.BlockDeviceError, err:
3882
          _Fail("Can't change network configuration: %s", err)
3883

    
3884
    if not all_connected:
3885
      raise utils.RetryAgain()
3886

    
3887
  try:
3888
    # Start with a delay of 100 miliseconds and go up to 5 seconds
3889
    utils.Retry(_Attach, (0.1, 1.5, 5.0), 2 * 60)
3890
  except utils.RetryTimeout:
3891
    _Fail("Timeout in disk reconnecting")
3892

    
3893
  if multimaster:
3894
    # change to primary mode
3895
    for rd in bdevs:
3896
      try:
3897
        rd.Open()
3898
      except errors.BlockDeviceError, err:
3899
        _Fail("Can't change to primary mode: %s", err)
3900

    
3901

    
3902
def DrbdWaitSync(target_node_uuid, nodes_ip, disks):
3903
  """Wait until DRBDs have synchronized.
3904

3905
  """
3906
  def _helper(rd):
3907
    stats = rd.GetProcStatus()
3908
    if not (stats.is_connected or stats.is_in_resync):
3909
      raise utils.RetryAgain()
3910
    return stats
3911

    
3912
  bdevs = _FindDisks(target_node_uuid, nodes_ip, disks)
3913

    
3914
  min_resync = 100
3915
  alldone = True
3916
  for rd in bdevs:
3917
    try:
3918
      # poll each second for 15 seconds
3919
      stats = utils.Retry(_helper, 1, 15, args=[rd])
3920
    except utils.RetryTimeout:
3921
      stats = rd.GetProcStatus()
3922
      # last check
3923
      if not (stats.is_connected or stats.is_in_resync):
3924
        _Fail("DRBD device %s is not in sync: stats=%s", rd, stats)
3925
    alldone = alldone and (not stats.is_in_resync)
3926
    if stats.sync_percent is not None:
3927
      min_resync = min(min_resync, stats.sync_percent)
3928

    
3929
  return (alldone, min_resync)
3930

    
3931

    
3932
def GetDrbdUsermodeHelper():
3933
  """Returns DRBD usermode helper currently configured.
3934

3935
  """
3936
  try:
3937
    return drbd.DRBD8.GetUsermodeHelper()
3938
  except errors.BlockDeviceError, err:
3939
    _Fail(str(err))
3940

    
3941

    
3942
def PowercycleNode(hypervisor_type, hvparams=None):
3943
  """Hard-powercycle the node.
3944

3945
  Because we need to return first, and schedule the powercycle in the
3946
  background, we won't be able to report failures nicely.
3947

3948
  """
3949
  hyper = hypervisor.GetHypervisor(hypervisor_type)
3950
  try:
3951
    pid = os.fork()
3952
  except OSError:
3953
    # if we can't fork, we'll pretend that we're in the child process
3954
    pid = 0
3955
  if pid > 0:
3956
    return "Reboot scheduled in 5 seconds"
3957
  # ensure the child is running on ram
3958
  try:
3959
    utils.Mlockall()
3960
  except Exception: # pylint: disable=W0703
3961
    pass
3962
  time.sleep(5)
3963
  hyper.PowercycleNode(hvparams=hvparams)
3964

    
3965

    
3966
def _VerifyRestrictedCmdName(cmd):
3967
  """Verifies a restricted command name.
3968

3969
  @type cmd: string
3970
  @param cmd: Command name
3971
  @rtype: tuple; (boolean, string or None)
3972
  @return: The tuple's first element is the status; if C{False}, the second
3973
    element is an error message string, otherwise it's C{None}
3974

3975
  """
3976
  if not cmd.strip():
3977
    return (False, "Missing command name")
3978

    
3979
  if os.path.basename(cmd) != cmd:
3980
    return (False, "Invalid command name")
3981

    
3982
  if not constants.EXT_PLUGIN_MASK.match(cmd):
3983
    return (False, "Command name contains forbidden characters")
3984

    
3985
  return (True, None)
3986

    
3987

    
3988
def _CommonRestrictedCmdCheck(path, owner):
3989
  """Common checks for restricted command file system directories and files.
3990

3991
  @type path: string
3992
  @param path: Path to check
3993
  @param owner: C{None} or tuple containing UID and GID
3994
  @rtype: tuple; (boolean, string or C{os.stat} result)
3995
  @return: The tuple's first element is the status; if C{False}, the second
3996
    element is an error message string, otherwise it's the result of C{os.stat}
3997

3998
  """
3999
  if owner is None:
4000
    # Default to root as owner
4001
    owner = (0, 0)
4002

    
4003
  try:
4004
    st = os.stat(path)
4005
  except EnvironmentError, err:
4006
    return (False, "Can't stat(2) '%s': %s" % (path, err))
4007

    
4008
  if stat.S_IMODE(st.st_mode) & (~_RCMD_MAX_MODE):
4009
    return (False, "Permissions on '%s' are too permissive" % path)
4010

    
4011
  if (st.st_uid, st.st_gid) != owner:
4012
    (owner_uid, owner_gid) = owner
4013
    return (False, "'%s' is not owned by %s:%s" % (path, owner_uid, owner_gid))
4014

    
4015
  return (True, st)
4016

    
4017

    
4018
def _VerifyRestrictedCmdDirectory(path, _owner=None):
4019
  """Verifies restricted command directory.
4020

4021
  @type path: string
4022
  @param path: Path to check
4023
  @rtype: tuple; (boolean, string or None)
4024
  @return: The tuple's first element is the status; if C{False}, the second
4025
    element is an error message string, otherwise it's C{None}
4026

4027
  """
4028
  (status, value) = _CommonRestrictedCmdCheck(path, _owner)
4029

    
4030
  if not status:
4031
    return (False, value)
4032

    
4033
  if not stat.S_ISDIR(value.st_mode):
4034
    return (False, "Path '%s' is not a directory" % path)
4035

    
4036
  return (True, None)
4037

    
4038

    
4039
def _VerifyRestrictedCmd(path, cmd, _owner=None):
4040
  """Verifies a whole restricted command and returns its executable filename.
4041

4042
  @type path: string
4043
  @param path: Directory containing restricted commands
4044
  @type cmd: string
4045
  @param cmd: Command name
4046
  @rtype: tuple; (boolean, string)
4047
  @return: The tuple's first element is the status; if C{False}, the second
4048
    element is an error message string, otherwise the second element is the
4049
    absolute path to the executable
4050

4051
  """
4052
  executable = utils.PathJoin(path, cmd)
4053

    
4054
  (status, msg) = _CommonRestrictedCmdCheck(executable, _owner)
4055

    
4056
  if not status:
4057
    return (False, msg)
4058

    
4059
  if not utils.IsExecutable(executable):
4060
    return (False, "access(2) thinks '%s' can't be executed" % executable)
4061

    
4062
  return (True, executable)
4063

    
4064

    
4065
def _PrepareRestrictedCmd(path, cmd,
4066
                          _verify_dir=_VerifyRestrictedCmdDirectory,
4067
                          _verify_name=_VerifyRestrictedCmdName,
4068
                          _verify_cmd=_VerifyRestrictedCmd):
4069
  """Performs a number of tests on a restricted command.
4070

4071
  @type path: string
4072
  @param path: Directory containing restricted commands
4073
  @type cmd: string
4074
  @param cmd: Command name
4075
  @return: Same as L{_VerifyRestrictedCmd}
4076

4077
  """
4078
  # Verify the directory first
4079
  (status, msg) = _verify_dir(path)
4080
  if status:
4081
    # Check command if everything was alright
4082
    (status, msg) = _verify_name(cmd)
4083

    
4084
  if not status:
4085
    return (False, msg)
4086

    
4087
  # Check actual executable
4088
  return _verify_cmd(path, cmd)
4089

    
4090

    
4091
def RunRestrictedCmd(cmd,
4092
                     _lock_timeout=_RCMD_LOCK_TIMEOUT,
4093
                     _lock_file=pathutils.RESTRICTED_COMMANDS_LOCK_FILE,
4094
                     _path=pathutils.RESTRICTED_COMMANDS_DIR,
4095
                     _sleep_fn=time.sleep,
4096
                     _prepare_fn=_PrepareRestrictedCmd,
4097
                     _runcmd_fn=utils.RunCmd,
4098
                     _enabled=constants.ENABLE_RESTRICTED_COMMANDS):
4099
  """Executes a restricted command after performing strict tests.
4100

4101
  @type cmd: string
4102
  @param cmd: Command name
4103
  @rtype: string
4104
  @return: Command output<