Statistics
| Branch: | Tag: | Revision:

root / lib / backend.py @ b54ecf12

History | View | Annotate | Download (127.5 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 import objects
60
from ganeti import ssconf
61
from ganeti import serializer
62
from ganeti import netutils
63
from ganeti import runtime
64
from ganeti import compat
65
from ganeti import pathutils
66
from ganeti import vcluster
67
from ganeti import ht
68
from ganeti.storage.base import BlockDev
69
from ganeti.storage.drbd import DRBD8
70
from ganeti import hooksmaster
71

    
72

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

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

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

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

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

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

    
107

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

111
  Its argument is the error message.
112

113
  """
114

    
115

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

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

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

    
127

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

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

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

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

    
143

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

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

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

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

    
166

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

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

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

    
176

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

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

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

    
189

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

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

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

    
209

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

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

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

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

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

    
239

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

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

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

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

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

    
266
  return frozenset(allowed_files)
267

    
268

    
269
_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()
270

    
271

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

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

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

    
282

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

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

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

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

    
307

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

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

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

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

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

    
339
      return result
340
    return wrapper
341
  return decorator
342

    
343

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

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

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

    
364
  return env
365

    
366

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

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

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

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

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

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

    
395

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

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

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

    
412

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

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

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

423
  """
424

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

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

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

    
440

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

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

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

    
457

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

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

463
  @rtype: None
464

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

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

    
475

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

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

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

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

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

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

    
506

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

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

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

    
528

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

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

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

539
  @param modify_ssh_setup: boolean
540

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

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

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

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

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

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

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

    
574

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

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

    
588
  return {
589
    "name": name,
590
    "vg_free": vg_free,
591
    "vg_size": vg_size,
592
    }
593

    
594

    
595
def _GetHvInfo(name):
596
  """Retrieves node information from a hypervisor.
597

598
  The information returned depends on the hypervisor. Common items:
599

600
    - vg_size is the size of the configured volume group in MiB
601
    - vg_free is the free size of the volume group in MiB
602
    - memory_dom0 is the memory allocated for domain0 in MiB
603
    - memory_free is the currently available (free) ram in MiB
604
    - memory_total is the total number of ram in MiB
605
    - hv_version: the hypervisor version, if available
606

607
  """
608
  return hypervisor.GetHypervisor(name).GetNodeInfo()
609

    
610

    
611
def _GetNamedNodeInfo(names, fn):
612
  """Calls C{fn} for all names in C{names} and returns a dictionary.
613

614
  @rtype: None or dict
615

616
  """
617
  if names is None:
618
    return None
619
  else:
620
    return map(fn, names)
621

    
622

    
623
def GetNodeInfo(storage_units, hv_names, excl_stor):
624
  """Gives back a hash with different information about the node.
625

626
  @type storage_units: list of pairs (string, string)
627
  @param storage_units: List of pairs (storage unit, identifier) to ask for disk
628
                        space information. In case of lvm-vg, the identifier is
629
                        the VG name.
630
  @type hv_names: list of string
631
  @param hv_names: Names of the hypervisors to ask for node information
632
  @type excl_stor: boolean
633
  @param excl_stor: Whether exclusive_storage is active
634
  @rtype: tuple; (string, None/dict, None/dict)
635
  @return: Tuple containing boot ID, volume group information and hypervisor
636
    information
637

638
  """
639
  bootid = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
640
  storage_info = _GetNamedNodeInfo(
641
    storage_units,
642
    (lambda storage_unit: _ApplyStorageInfoFunction(storage_unit[0],
643
                                                    storage_unit[1],
644
                                                    excl_stor)))
645
  hv_info = _GetNamedNodeInfo(hv_names, _GetHvInfo)
646

    
647
  return (bootid, storage_info, hv_info)
648

    
649

    
650
# FIXME: implement storage reporting for all missing storage types.
651
_STORAGE_TYPE_INFO_FN = {
652
  constants.ST_BLOCK: None,
653
  constants.ST_DISKLESS: None,
654
  constants.ST_EXT: None,
655
  constants.ST_FILE: None,
656
  constants.ST_LVM_VG: _GetVgInfo,
657
  constants.ST_RADOS: None,
658
}
659

    
660

    
661
def _ApplyStorageInfoFunction(storage_type, storage_key, *args):
662
  """Looks up and applies the correct function to calculate free and total
663
  storage for the given storage type.
664

665
  @type storage_type: string
666
  @param storage_type: the storage type for which the storage shall be reported.
667
  @type storage_key: string
668
  @param storage_key: identifier of a storage unit, e.g. the volume group name
669
    of an LVM storage unit
670
  @type args: any
671
  @param args: various parameters that can be used for storage reporting. These
672
    parameters and their semantics vary from storage type to storage type and
673
    are just propagated in this function.
674
  @return: the results of the application of the storage space function (see
675
    _STORAGE_TYPE_INFO_FN) if storage space reporting is implemented for that
676
    storage type
677
  @raises NotImplementedError: for storage types who don't support space
678
    reporting yet
679
  """
680
  fn = _STORAGE_TYPE_INFO_FN[storage_type]
681
  if fn is not None:
682
    return fn(storage_key, *args)
683
  else:
684
    raise NotImplementedError
685

    
686

    
687
def _CheckExclusivePvs(pvi_list):
688
  """Check that PVs are not shared among LVs
689

690
  @type pvi_list: list of L{objects.LvmPvInfo} objects
691
  @param pvi_list: information about the PVs
692

693
  @rtype: list of tuples (string, list of strings)
694
  @return: offending volumes, as tuples: (pv_name, [lv1_name, lv2_name...])
695

696
  """
697
  res = []
698
  for pvi in pvi_list:
699
    if len(pvi.lv_list) > 1:
700
      res.append((pvi.name, pvi.lv_list))
701
  return res
702

    
703

    
704
def VerifyNode(what, cluster_name):
705
  """Verify the status of the local node.
706

707
  Based on the input L{what} parameter, various checks are done on the
708
  local node.
709

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

713
  If the I{nodelist} key is present, we check that we have
714
  connectivity via ssh with the target nodes (and check the hostname
715
  report).
716

717
  If the I{node-net-test} key is present, we check that we have
718
  connectivity to the given nodes via both primary IP and, if
719
  applicable, secondary IPs.
720

721
  @type what: C{dict}
722
  @param what: a dictionary of things to check:
723
      - filelist: list of files for which to compute checksums
724
      - nodelist: list of nodes we should check ssh communication with
725
      - node-net-test: list of nodes we should check node daemon port
726
        connectivity with
727
      - hypervisor: list with hypervisors to run the verify for
728
  @rtype: dict
729
  @return: a dictionary with the same keys as the input dict, and
730
      values representing the result of the checks
731

732
  """
733
  result = {}
734
  my_name = netutils.Hostname.GetSysName()
735
  port = netutils.GetDaemonPort(constants.NODED)
736
  vm_capable = my_name not in what.get(constants.NV_VMNODES, [])
737

    
738
  if constants.NV_HYPERVISOR in what and vm_capable:
739
    result[constants.NV_HYPERVISOR] = tmp = {}
740
    for hv_name in what[constants.NV_HYPERVISOR]:
741
      try:
742
        val = hypervisor.GetHypervisor(hv_name).Verify()
743
      except errors.HypervisorError, err:
744
        val = "Error while checking hypervisor: %s" % str(err)
745
      tmp[hv_name] = val
746

    
747
  if constants.NV_HVPARAMS in what and vm_capable:
748
    result[constants.NV_HVPARAMS] = tmp = []
749
    for source, hv_name, hvparms in what[constants.NV_HVPARAMS]:
750
      try:
751
        logging.info("Validating hv %s, %s", hv_name, hvparms)
752
        hypervisor.GetHypervisor(hv_name).ValidateParameters(hvparms)
753
      except errors.HypervisorError, err:
754
        tmp.append((source, hv_name, str(err)))
755

    
756
  if constants.NV_FILELIST in what:
757
    fingerprints = utils.FingerprintFiles(map(vcluster.LocalizeVirtualPath,
758
                                              what[constants.NV_FILELIST]))
759
    result[constants.NV_FILELIST] = \
760
      dict((vcluster.MakeVirtualPath(key), value)
761
           for (key, value) in fingerprints.items())
762

    
763
  if constants.NV_NODELIST in what:
764
    (nodes, bynode) = what[constants.NV_NODELIST]
765

    
766
    # Add nodes from other groups (different for each node)
767
    try:
768
      nodes.extend(bynode[my_name])
769
    except KeyError:
770
      pass
771

    
772
    # Use a random order
773
    random.shuffle(nodes)
774

    
775
    # Try to contact all nodes
776
    val = {}
777
    for node in nodes:
778
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
779
      if not success:
780
        val[node] = message
781

    
782
    result[constants.NV_NODELIST] = val
783

    
784
  if constants.NV_NODENETTEST in what:
785
    result[constants.NV_NODENETTEST] = tmp = {}
786
    my_pip = my_sip = None
787
    for name, pip, sip in what[constants.NV_NODENETTEST]:
788
      if name == my_name:
789
        my_pip = pip
790
        my_sip = sip
791
        break
792
    if not my_pip:
793
      tmp[my_name] = ("Can't find my own primary/secondary IP"
794
                      " in the node list")
795
    else:
796
      for name, pip, sip in what[constants.NV_NODENETTEST]:
797
        fail = []
798
        if not netutils.TcpPing(pip, port, source=my_pip):
799
          fail.append("primary")
800
        if sip != pip:
801
          if not netutils.TcpPing(sip, port, source=my_sip):
802
            fail.append("secondary")
803
        if fail:
804
          tmp[name] = ("failure using the %s interface(s)" %
805
                       " and ".join(fail))
806

    
807
  if constants.NV_MASTERIP in what:
808
    # FIXME: add checks on incoming data structures (here and in the
809
    # rest of the function)
810
    master_name, master_ip = what[constants.NV_MASTERIP]
811
    if master_name == my_name:
812
      source = constants.IP4_ADDRESS_LOCALHOST
813
    else:
814
      source = None
815
    result[constants.NV_MASTERIP] = netutils.TcpPing(master_ip, port,
816
                                                     source=source)
817

    
818
  if constants.NV_USERSCRIPTS in what:
819
    result[constants.NV_USERSCRIPTS] = \
820
      [script for script in what[constants.NV_USERSCRIPTS]
821
       if not utils.IsExecutable(script)]
822

    
823
  if constants.NV_OOB_PATHS in what:
824
    result[constants.NV_OOB_PATHS] = tmp = []
825
    for path in what[constants.NV_OOB_PATHS]:
826
      try:
827
        st = os.stat(path)
828
      except OSError, err:
829
        tmp.append("error stating out of band helper: %s" % err)
830
      else:
831
        if stat.S_ISREG(st.st_mode):
832
          if stat.S_IMODE(st.st_mode) & stat.S_IXUSR:
833
            tmp.append(None)
834
          else:
835
            tmp.append("out of band helper %s is not executable" % path)
836
        else:
837
          tmp.append("out of band helper %s is not a file" % path)
838

    
839
  if constants.NV_LVLIST in what and vm_capable:
840
    try:
841
      val = GetVolumeList(utils.ListVolumeGroups().keys())
842
    except RPCFail, err:
843
      val = str(err)
844
    result[constants.NV_LVLIST] = val
845

    
846
  if constants.NV_INSTANCELIST in what and vm_capable:
847
    # GetInstanceList can fail
848
    try:
849
      val = GetInstanceList(what[constants.NV_INSTANCELIST])
850
    except RPCFail, err:
851
      val = str(err)
852
    result[constants.NV_INSTANCELIST] = val
853

    
854
  if constants.NV_VGLIST in what and vm_capable:
855
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
856

    
857
  if constants.NV_PVLIST in what and vm_capable:
858
    check_exclusive_pvs = constants.NV_EXCLUSIVEPVS in what
859
    val = bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
860
                                       filter_allocatable=False,
861
                                       include_lvs=check_exclusive_pvs)
862
    if check_exclusive_pvs:
863
      result[constants.NV_EXCLUSIVEPVS] = _CheckExclusivePvs(val)
864
      for pvi in val:
865
        # Avoid sending useless data on the wire
866
        pvi.lv_list = []
867
    result[constants.NV_PVLIST] = map(objects.LvmPvInfo.ToDict, val)
868

    
869
  if constants.NV_VERSION in what:
870
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
871
                                    constants.RELEASE_VERSION)
872

    
873
  if constants.NV_HVINFO in what and vm_capable:
874
    hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
875
    result[constants.NV_HVINFO] = hyper.GetNodeInfo()
876

    
877
  if constants.NV_DRBDVERSION in what and vm_capable:
878
    try:
879
      drbd_version = DRBD8.GetProcInfo().GetVersionString()
880
    except errors.BlockDeviceError, err:
881
      logging.warning("Can't get DRBD version", exc_info=True)
882
      drbd_version = str(err)
883
    result[constants.NV_DRBDVERSION] = drbd_version
884

    
885
  if constants.NV_DRBDLIST in what and vm_capable:
886
    try:
887
      used_minors = drbd.DRBD8.GetUsedDevs()
888
    except errors.BlockDeviceError, err:
889
      logging.warning("Can't get used minors list", exc_info=True)
890
      used_minors = str(err)
891
    result[constants.NV_DRBDLIST] = used_minors
892

    
893
  if constants.NV_DRBDHELPER in what and vm_capable:
894
    status = True
895
    try:
896
      payload = drbd.DRBD8.GetUsermodeHelper()
897
    except errors.BlockDeviceError, err:
898
      logging.error("Can't get DRBD usermode helper: %s", str(err))
899
      status = False
900
      payload = str(err)
901
    result[constants.NV_DRBDHELPER] = (status, payload)
902

    
903
  if constants.NV_NODESETUP in what:
904
    result[constants.NV_NODESETUP] = tmpr = []
905
    if not os.path.isdir("/sys/block") or not os.path.isdir("/sys/class/net"):
906
      tmpr.append("The sysfs filesytem doesn't seem to be mounted"
907
                  " under /sys, missing required directories /sys/block"
908
                  " and /sys/class/net")
909
    if (not os.path.isdir("/proc/sys") or
910
        not os.path.isfile("/proc/sysrq-trigger")):
911
      tmpr.append("The procfs filesystem doesn't seem to be mounted"
912
                  " under /proc, missing required directory /proc/sys and"
913
                  " the file /proc/sysrq-trigger")
914

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

    
918
  if constants.NV_OSLIST in what and vm_capable:
919
    result[constants.NV_OSLIST] = DiagnoseOS()
920

    
921
  if constants.NV_BRIDGES in what and vm_capable:
922
    result[constants.NV_BRIDGES] = [bridge
923
                                    for bridge in what[constants.NV_BRIDGES]
924
                                    if not utils.BridgeExists(bridge)]
925

    
926
  if what.get(constants.NV_FILE_STORAGE_PATHS) == my_name:
927
    result[constants.NV_FILE_STORAGE_PATHS] = \
928
      bdev.ComputeWrongFileStoragePaths()
929

    
930
  return result
931

    
932

    
933
def GetBlockDevSizes(devices):
934
  """Return the size of the given block devices
935

936
  @type devices: list
937
  @param devices: list of block device nodes to query
938
  @rtype: dict
939
  @return:
940
    dictionary of all block devices under /dev (key). The value is their
941
    size in MiB.
942

943
    {'/dev/disk/by-uuid/123456-12321231-312312-312': 124}
944

945
  """
946
  DEV_PREFIX = "/dev/"
947
  blockdevs = {}
948

    
949
  for devpath in devices:
950
    if not utils.IsBelowDir(DEV_PREFIX, devpath):
951
      continue
952

    
953
    try:
954
      st = os.stat(devpath)
955
    except EnvironmentError, err:
956
      logging.warning("Error stat()'ing device %s: %s", devpath, str(err))
957
      continue
958

    
959
    if stat.S_ISBLK(st.st_mode):
960
      result = utils.RunCmd(["blockdev", "--getsize64", devpath])
961
      if result.failed:
962
        # We don't want to fail, just do not list this device as available
963
        logging.warning("Cannot get size for block device %s", devpath)
964
        continue
965

    
966
      size = int(result.stdout) / (1024 * 1024)
967
      blockdevs[devpath] = size
968
  return blockdevs
969

    
970

    
971
def GetVolumeList(vg_names):
972
  """Compute list of logical volumes and their size.
973

974
  @type vg_names: list
975
  @param vg_names: the volume groups whose LVs we should list, or
976
      empty for all volume groups
977
  @rtype: dict
978
  @return:
979
      dictionary of all partions (key) with value being a tuple of
980
      their size (in MiB), inactive and online status::
981

982
        {'xenvg/test1': ('20.06', True, True)}
983

984
      in case of errors, a string is returned with the error
985
      details.
986

987
  """
988
  lvs = {}
989
  sep = "|"
990
  if not vg_names:
991
    vg_names = []
992
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
993
                         "--separator=%s" % sep,
994
                         "-ovg_name,lv_name,lv_size,lv_attr"] + vg_names)
995
  if result.failed:
996
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
997

    
998
  for line in result.stdout.splitlines():
999
    line = line.strip()
1000
    match = _LVSLINE_REGEX.match(line)
1001
    if not match:
1002
      logging.error("Invalid line returned from lvs output: '%s'", line)
1003
      continue
1004
    vg_name, name, size, attr = match.groups()
1005
    inactive = attr[4] == "-"
1006
    online = attr[5] == "o"
1007
    virtual = attr[0] == "v"
1008
    if virtual:
1009
      # we don't want to report such volumes as existing, since they
1010
      # don't really hold data
1011
      continue
1012
    lvs[vg_name + "/" + name] = (size, inactive, online)
1013

    
1014
  return lvs
1015

    
1016

    
1017
def ListVolumeGroups():
1018
  """List the volume groups and their size.
1019

1020
  @rtype: dict
1021
  @return: dictionary with keys volume name and values the
1022
      size of the volume
1023

1024
  """
1025
  return utils.ListVolumeGroups()
1026

    
1027

    
1028
def NodeVolumes():
1029
  """List all volumes on this node.
1030

1031
  @rtype: list
1032
  @return:
1033
    A list of dictionaries, each having four keys:
1034
      - name: the logical volume name,
1035
      - size: the size of the logical volume
1036
      - dev: the physical device on which the LV lives
1037
      - vg: the volume group to which it belongs
1038

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

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

1046
  """
1047
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
1048
                         "--separator=|",
1049
                         "--options=lv_name,lv_size,devices,vg_name"])
1050
  if result.failed:
1051
    _Fail("Failed to list logical volumes, lvs output: %s",
1052
          result.output)
1053

    
1054
  def parse_dev(dev):
1055
    return dev.split("(")[0]
1056

    
1057
  def handle_dev(dev):
1058
    return [parse_dev(x) for x in dev.split(",")]
1059

    
1060
  def map_line(line):
1061
    line = [v.strip() for v in line]
1062
    return [{"name": line[0], "size": line[1],
1063
             "dev": dev, "vg": line[3]} for dev in handle_dev(line[2])]
1064

    
1065
  all_devs = []
1066
  for line in result.stdout.splitlines():
1067
    if line.count("|") >= 3:
1068
      all_devs.extend(map_line(line.split("|")))
1069
    else:
1070
      logging.warning("Strange line in the output from lvs: '%s'", line)
1071
  return all_devs
1072

    
1073

    
1074
def BridgesExist(bridges_list):
1075
  """Check if a list of bridges exist on the current node.
1076

1077
  @rtype: boolean
1078
  @return: C{True} if all of them exist, C{False} otherwise
1079

1080
  """
1081
  missing = []
1082
  for bridge in bridges_list:
1083
    if not utils.BridgeExists(bridge):
1084
      missing.append(bridge)
1085

    
1086
  if missing:
1087
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
1088

    
1089

    
1090
def GetInstanceList(hypervisor_list):
1091
  """Provides a list of instances.
1092

1093
  @type hypervisor_list: list
1094
  @param hypervisor_list: the list of hypervisors to query information
1095

1096
  @rtype: list
1097
  @return: a list of all running instances on the current node
1098
    - instance1.example.com
1099
    - instance2.example.com
1100

1101
  """
1102
  results = []
1103
  for hname in hypervisor_list:
1104
    try:
1105
      names = hypervisor.GetHypervisor(hname).ListInstances()
1106
      results.extend(names)
1107
    except errors.HypervisorError, err:
1108
      _Fail("Error enumerating instances (hypervisor %s): %s",
1109
            hname, err, exc=True)
1110

    
1111
  return results
1112

    
1113

    
1114
def GetInstanceInfo(instance, hname):
1115
  """Gives back the information about an instance as a dictionary.
1116

1117
  @type instance: string
1118
  @param instance: the instance name
1119
  @type hname: string
1120
  @param hname: the hypervisor type of the instance
1121

1122
  @rtype: dict
1123
  @return: dictionary with the following keys:
1124
      - memory: memory size of instance (int)
1125
      - state: xen state of instance (string)
1126
      - time: cpu time of instance (float)
1127
      - vcpus: the number of vcpus (int)
1128

1129
  """
1130
  output = {}
1131

    
1132
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
1133
  if iinfo is not None:
1134
    output["memory"] = iinfo[2]
1135
    output["vcpus"] = iinfo[3]
1136
    output["state"] = iinfo[4]
1137
    output["time"] = iinfo[5]
1138

    
1139
  return output
1140

    
1141

    
1142
def GetInstanceMigratable(instance):
1143
  """Gives whether an instance can be migrated.
1144

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

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

1153
  """
1154
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1155
  iname = instance.name
1156
  if iname not in hyper.ListInstances():
1157
    _Fail("Instance %s is not running", iname)
1158

    
1159
  for idx in range(len(instance.disks)):
1160
    link_name = _GetBlockDevSymlinkPath(iname, idx)
1161
    if not os.path.islink(link_name):
1162
      logging.warning("Instance %s is missing symlink %s for disk %d",
1163
                      iname, link_name, idx)
1164

    
1165

    
1166
def GetAllInstancesInfo(hypervisor_list):
1167
  """Gather data about all instances.
1168

1169
  This is the equivalent of L{GetInstanceInfo}, except that it
1170
  computes data for all instances at once, thus being faster if one
1171
  needs data about more than one instance.
1172

1173
  @type hypervisor_list: list
1174
  @param hypervisor_list: list of hypervisors to query for instance data
1175

1176
  @rtype: dict
1177
  @return: dictionary of instance: data, with data having the following keys:
1178
      - memory: memory size of instance (int)
1179
      - state: xen state of instance (string)
1180
      - time: cpu time of instance (float)
1181
      - vcpus: the number of vcpus
1182

1183
  """
1184
  output = {}
1185

    
1186
  for hname in hypervisor_list:
1187
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
1188
    if iinfo:
1189
      for name, _, memory, vcpus, state, times in iinfo:
1190
        value = {
1191
          "memory": memory,
1192
          "vcpus": vcpus,
1193
          "state": state,
1194
          "time": times,
1195
          }
1196
        if name in output:
1197
          # we only check static parameters, like memory and vcpus,
1198
          # and not state and time which can change between the
1199
          # invocations of the different hypervisors
1200
          for key in "memory", "vcpus":
1201
            if value[key] != output[name][key]:
1202
              _Fail("Instance %s is running twice"
1203
                    " with different parameters", name)
1204
        output[name] = value
1205

    
1206
  return output
1207

    
1208

    
1209
def _InstanceLogName(kind, os_name, instance, component):
1210
  """Compute the OS log filename for a given instance and operation.
1211

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

1215
  @type kind: string
1216
  @param kind: the operation type (e.g. add, import, etc.)
1217
  @type os_name: string
1218
  @param os_name: the os name
1219
  @type instance: string
1220
  @param instance: the name of the instance being imported/added/etc.
1221
  @type component: string or None
1222
  @param component: the name of the component of the instance being
1223
      transferred
1224

1225
  """
1226
  # TODO: Use tempfile.mkstemp to create unique filename
1227
  if component:
1228
    assert "/" not in component
1229
    c_msg = "-%s" % component
1230
  else:
1231
    c_msg = ""
1232
  base = ("%s-%s-%s%s-%s.log" %
1233
          (kind, os_name, instance, c_msg, utils.TimestampForFilename()))
1234
  return utils.PathJoin(pathutils.LOG_OS_DIR, base)
1235

    
1236

    
1237
def InstanceOsAdd(instance, reinstall, debug):
1238
  """Add an OS to an instance.
1239

1240
  @type instance: L{objects.Instance}
1241
  @param instance: Instance whose OS is to be installed
1242
  @type reinstall: boolean
1243
  @param reinstall: whether this is an instance reinstall
1244
  @type debug: integer
1245
  @param debug: debug level, passed to the OS scripts
1246
  @rtype: None
1247

1248
  """
1249
  inst_os = OSFromDisk(instance.os)
1250

    
1251
  create_env = OSEnvironment(instance, inst_os, debug)
1252
  if reinstall:
1253
    create_env["INSTANCE_REINSTALL"] = "1"
1254

    
1255
  logfile = _InstanceLogName("add", instance.os, instance.name, None)
1256

    
1257
  result = utils.RunCmd([inst_os.create_script], env=create_env,
1258
                        cwd=inst_os.path, output=logfile, reset_env=True)
1259
  if result.failed:
1260
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
1261
                  " output: %s", result.cmd, result.fail_reason, logfile,
1262
                  result.output)
1263
    lines = [utils.SafeEncode(val)
1264
             for val in utils.TailFile(logfile, lines=20)]
1265
    _Fail("OS create script failed (%s), last lines in the"
1266
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
1267

    
1268

    
1269
def RunRenameInstance(instance, old_name, debug):
1270
  """Run the OS rename script for an instance.
1271

1272
  @type instance: L{objects.Instance}
1273
  @param instance: Instance whose OS is to be installed
1274
  @type old_name: string
1275
  @param old_name: previous instance name
1276
  @type debug: integer
1277
  @param debug: debug level, passed to the OS scripts
1278
  @rtype: boolean
1279
  @return: the success of the operation
1280

1281
  """
1282
  inst_os = OSFromDisk(instance.os)
1283

    
1284
  rename_env = OSEnvironment(instance, inst_os, debug)
1285
  rename_env["OLD_INSTANCE_NAME"] = old_name
1286

    
1287
  logfile = _InstanceLogName("rename", instance.os,
1288
                             "%s-%s" % (old_name, instance.name), None)
1289

    
1290
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
1291
                        cwd=inst_os.path, output=logfile, reset_env=True)
1292

    
1293
  if result.failed:
1294
    logging.error("os create command '%s' returned error: %s output: %s",
1295
                  result.cmd, result.fail_reason, result.output)
1296
    lines = [utils.SafeEncode(val)
1297
             for val in utils.TailFile(logfile, lines=20)]
1298
    _Fail("OS rename script failed (%s), last lines in the"
1299
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
1300

    
1301

    
1302
def _GetBlockDevSymlinkPath(instance_name, idx, _dir=None):
1303
  """Returns symlink path for block device.
1304

1305
  """
1306
  if _dir is None:
1307
    _dir = pathutils.DISK_LINKS_DIR
1308

    
1309
  return utils.PathJoin(_dir,
1310
                        ("%s%s%s" %
1311
                         (instance_name, constants.DISK_SEPARATOR, idx)))
1312

    
1313

    
1314
def _SymlinkBlockDev(instance_name, device_path, idx):
1315
  """Set up symlinks to a instance's block device.
1316

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

1320

1321
  @param instance_name: the name of the target instance
1322
  @param device_path: path of the physical block device, on the node
1323
  @param idx: the disk index
1324
  @return: absolute path to the disk's symlink
1325

1326
  """
1327
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
1328
  try:
1329
    os.symlink(device_path, link_name)
1330
  except OSError, err:
1331
    if err.errno == errno.EEXIST:
1332
      if (not os.path.islink(link_name) or
1333
          os.readlink(link_name) != device_path):
1334
        os.remove(link_name)
1335
        os.symlink(device_path, link_name)
1336
    else:
1337
      raise
1338

    
1339
  return link_name
1340

    
1341

    
1342
def _RemoveBlockDevLinks(instance_name, disks):
1343
  """Remove the block device symlinks belonging to the given instance.
1344

1345
  """
1346
  for idx, _ in enumerate(disks):
1347
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
1348
    if os.path.islink(link_name):
1349
      try:
1350
        os.remove(link_name)
1351
      except OSError:
1352
        logging.exception("Can't remove symlink '%s'", link_name)
1353

    
1354

    
1355
def _GatherAndLinkBlockDevs(instance):
1356
  """Set up an instance's block device(s).
1357

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

1361
  @type instance: L{objects.Instance}
1362
  @param instance: the instance whose disks we shoul assemble
1363
  @rtype: list
1364
  @return: list of (disk_object, device_path)
1365

1366
  """
1367
  block_devices = []
1368
  for idx, disk in enumerate(instance.disks):
1369
    device = _RecursiveFindBD(disk)
1370
    if device is None:
1371
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
1372
                                    str(disk))
1373
    device.Open()
1374
    try:
1375
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
1376
    except OSError, e:
1377
      raise errors.BlockDeviceError("Cannot create block device symlink: %s" %
1378
                                    e.strerror)
1379

    
1380
    block_devices.append((disk, link_name))
1381

    
1382
  return block_devices
1383

    
1384

    
1385
def StartInstance(instance, startup_paused, reason, store_reason=True):
1386
  """Start an instance.
1387

1388
  @type instance: L{objects.Instance}
1389
  @param instance: the instance object
1390
  @type startup_paused: bool
1391
  @param instance: pause instance at startup?
1392
  @type reason: list of reasons
1393
  @param reason: the reason trail for this startup
1394
  @type store_reason: boolean
1395
  @param store_reason: whether to store the shutdown reason trail on file
1396
  @rtype: None
1397

1398
  """
1399
  running_instances = GetInstanceList([instance.hypervisor])
1400

    
1401
  if instance.name in running_instances:
1402
    logging.info("Instance %s already running, not starting", instance.name)
1403
    return
1404

    
1405
  try:
1406
    block_devices = _GatherAndLinkBlockDevs(instance)
1407
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
1408
    hyper.StartInstance(instance, block_devices, startup_paused)
1409
    if store_reason:
1410
      _StoreInstReasonTrail(instance.name, reason)
1411
  except errors.BlockDeviceError, err:
1412
    _Fail("Block device error: %s", err, exc=True)
1413
  except errors.HypervisorError, err:
1414
    _RemoveBlockDevLinks(instance.name, instance.disks)
1415
    _Fail("Hypervisor error: %s", err, exc=True)
1416

    
1417

    
1418
def InstanceShutdown(instance, timeout, reason, store_reason=True):
1419
  """Shut an instance down.
1420

1421
  @note: this functions uses polling with a hardcoded timeout.
1422

1423
  @type instance: L{objects.Instance}
1424
  @param instance: the instance object
1425
  @type timeout: integer
1426
  @param timeout: maximum timeout for soft shutdown
1427
  @type reason: list of reasons
1428
  @param reason: the reason trail for this shutdown
1429
  @type store_reason: boolean
1430
  @param store_reason: whether to store the shutdown reason trail on file
1431
  @rtype: None
1432

1433
  """
1434
  hv_name = instance.hypervisor
1435
  hyper = hypervisor.GetHypervisor(hv_name)
1436
  iname = instance.name
1437

    
1438
  if instance.name not in hyper.ListInstances():
1439
    logging.info("Instance %s not running, doing nothing", iname)
1440
    return
1441

    
1442
  class _TryShutdown:
1443
    def __init__(self):
1444
      self.tried_once = False
1445

    
1446
    def __call__(self):
1447
      if iname not in hyper.ListInstances():
1448
        return
1449

    
1450
      try:
1451
        hyper.StopInstance(instance, retry=self.tried_once)
1452
        if store_reason:
1453
          _StoreInstReasonTrail(instance.name, reason)
1454
      except errors.HypervisorError, err:
1455
        if iname not in hyper.ListInstances():
1456
          # if the instance is no longer existing, consider this a
1457
          # success and go to cleanup
1458
          return
1459

    
1460
        _Fail("Failed to stop instance %s: %s", iname, err)
1461

    
1462
      self.tried_once = True
1463

    
1464
      raise utils.RetryAgain()
1465

    
1466
  try:
1467
    utils.Retry(_TryShutdown(), 5, timeout)
1468
  except utils.RetryTimeout:
1469
    # the shutdown did not succeed
1470
    logging.error("Shutdown of '%s' unsuccessful, forcing", iname)
1471

    
1472
    try:
1473
      hyper.StopInstance(instance, force=True)
1474
    except errors.HypervisorError, err:
1475
      if iname in hyper.ListInstances():
1476
        # only raise an error if the instance still exists, otherwise
1477
        # the error could simply be "instance ... unknown"!
1478
        _Fail("Failed to force stop instance %s: %s", iname, err)
1479

    
1480
    time.sleep(1)
1481

    
1482
    if iname in hyper.ListInstances():
1483
      _Fail("Could not shutdown instance %s even by destroy", iname)
1484

    
1485
  try:
1486
    hyper.CleanupInstance(instance.name)
1487
  except errors.HypervisorError, err:
1488
    logging.warning("Failed to execute post-shutdown cleanup step: %s", err)
1489

    
1490
  _RemoveBlockDevLinks(iname, instance.disks)
1491

    
1492

    
1493
def InstanceReboot(instance, reboot_type, shutdown_timeout, reason):
1494
  """Reboot an instance.
1495

1496
  @type instance: L{objects.Instance}
1497
  @param instance: the instance object to reboot
1498
  @type reboot_type: str
1499
  @param reboot_type: the type of reboot, one the following
1500
    constants:
1501
      - L{constants.INSTANCE_REBOOT_SOFT}: only reboot the
1502
        instance OS, do not recreate the VM
1503
      - L{constants.INSTANCE_REBOOT_HARD}: tear down and
1504
        restart the VM (at the hypervisor level)
1505
      - the other reboot type (L{constants.INSTANCE_REBOOT_FULL}) is
1506
        not accepted here, since that mode is handled differently, in
1507
        cmdlib, and translates into full stop and start of the
1508
        instance (instead of a call_instance_reboot RPC)
1509
  @type shutdown_timeout: integer
1510
  @param shutdown_timeout: maximum timeout for soft shutdown
1511
  @type reason: list of reasons
1512
  @param reason: the reason trail for this reboot
1513
  @rtype: None
1514

1515
  """
1516
  running_instances = GetInstanceList([instance.hypervisor])
1517

    
1518
  if instance.name not in running_instances:
1519
    _Fail("Cannot reboot instance %s that is not running", instance.name)
1520

    
1521
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1522
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
1523
    try:
1524
      hyper.RebootInstance(instance)
1525
    except errors.HypervisorError, err:
1526
      _Fail("Failed to soft reboot instance %s: %s", instance.name, err)
1527
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
1528
    try:
1529
      InstanceShutdown(instance, shutdown_timeout, reason, store_reason=False)
1530
      result = StartInstance(instance, False, reason, store_reason=False)
1531
      _StoreInstReasonTrail(instance.name, reason)
1532
      return result
1533
    except errors.HypervisorError, err:
1534
      _Fail("Failed to hard reboot instance %s: %s", instance.name, err)
1535
  else:
1536
    _Fail("Invalid reboot_type received: %s", reboot_type)
1537

    
1538

    
1539
def InstanceBalloonMemory(instance, memory):
1540
  """Resize an instance's memory.
1541

1542
  @type instance: L{objects.Instance}
1543
  @param instance: the instance object
1544
  @type memory: int
1545
  @param memory: new memory amount in MB
1546
  @rtype: None
1547

1548
  """
1549
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1550
  running = hyper.ListInstances()
1551
  if instance.name not in running:
1552
    logging.info("Instance %s is not running, cannot balloon", instance.name)
1553
    return
1554
  try:
1555
    hyper.BalloonInstanceMemory(instance, memory)
1556
  except errors.HypervisorError, err:
1557
    _Fail("Failed to balloon instance memory: %s", err, exc=True)
1558

    
1559

    
1560
def MigrationInfo(instance):
1561
  """Gather information about an instance to be migrated.
1562

1563
  @type instance: L{objects.Instance}
1564
  @param instance: the instance definition
1565

1566
  """
1567
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1568
  try:
1569
    info = hyper.MigrationInfo(instance)
1570
  except errors.HypervisorError, err:
1571
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1572
  return info
1573

    
1574

    
1575
def AcceptInstance(instance, info, target):
1576
  """Prepare the node to accept an instance.
1577

1578
  @type instance: L{objects.Instance}
1579
  @param instance: the instance definition
1580
  @type info: string/data (opaque)
1581
  @param info: migration information, from the source node
1582
  @type target: string
1583
  @param target: target host (usually ip), on this node
1584

1585
  """
1586
  # TODO: why is this required only for DTS_EXT_MIRROR?
1587
  if instance.disk_template in constants.DTS_EXT_MIRROR:
1588
    # Create the symlinks, as the disks are not active
1589
    # in any way
1590
    try:
1591
      _GatherAndLinkBlockDevs(instance)
1592
    except errors.BlockDeviceError, err:
1593
      _Fail("Block device error: %s", err, exc=True)
1594

    
1595
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1596
  try:
1597
    hyper.AcceptInstance(instance, info, target)
1598
  except errors.HypervisorError, err:
1599
    if instance.disk_template in constants.DTS_EXT_MIRROR:
1600
      _RemoveBlockDevLinks(instance.name, instance.disks)
1601
    _Fail("Failed to accept instance: %s", err, exc=True)
1602

    
1603

    
1604
def FinalizeMigrationDst(instance, info, success):
1605
  """Finalize any preparation to accept an instance.
1606

1607
  @type instance: L{objects.Instance}
1608
  @param instance: the instance definition
1609
  @type info: string/data (opaque)
1610
  @param info: migration information, from the source node
1611
  @type success: boolean
1612
  @param success: whether the migration was a success or a failure
1613

1614
  """
1615
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1616
  try:
1617
    hyper.FinalizeMigrationDst(instance, info, success)
1618
  except errors.HypervisorError, err:
1619
    _Fail("Failed to finalize migration on the target node: %s", err, exc=True)
1620

    
1621

    
1622
def MigrateInstance(instance, target, live):
1623
  """Migrates an instance to another node.
1624

1625
  @type instance: L{objects.Instance}
1626
  @param instance: the instance definition
1627
  @type target: string
1628
  @param target: the target node name
1629
  @type live: boolean
1630
  @param live: whether the migration should be done live or not (the
1631
      interpretation of this parameter is left to the hypervisor)
1632
  @raise RPCFail: if migration fails for some reason
1633

1634
  """
1635
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1636

    
1637
  try:
1638
    hyper.MigrateInstance(instance, target, live)
1639
  except errors.HypervisorError, err:
1640
    _Fail("Failed to migrate instance: %s", err, exc=True)
1641

    
1642

    
1643
def FinalizeMigrationSource(instance, success, live):
1644
  """Finalize the instance migration on the source node.
1645

1646
  @type instance: L{objects.Instance}
1647
  @param instance: the instance definition of the migrated instance
1648
  @type success: bool
1649
  @param success: whether the migration succeeded or not
1650
  @type live: bool
1651
  @param live: whether the user requested a live migration or not
1652
  @raise RPCFail: If the execution fails for some reason
1653

1654
  """
1655
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1656

    
1657
  try:
1658
    hyper.FinalizeMigrationSource(instance, success, live)
1659
  except Exception, err:  # pylint: disable=W0703
1660
    _Fail("Failed to finalize the migration on the source node: %s", err,
1661
          exc=True)
1662

    
1663

    
1664
def GetMigrationStatus(instance):
1665
  """Get the migration status
1666

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

1675
  """
1676
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1677
  try:
1678
    return hyper.GetMigrationStatus(instance)
1679
  except Exception, err:  # pylint: disable=W0703
1680
    _Fail("Failed to get migration status: %s", err, exc=True)
1681

    
1682

    
1683
def BlockdevCreate(disk, size, owner, on_primary, info, excl_stor):
1684
  """Creates a block device for an instance.
1685

1686
  @type disk: L{objects.Disk}
1687
  @param disk: the object describing the disk we should create
1688
  @type size: int
1689
  @param size: the size of the physical underlying device, in MiB
1690
  @type owner: str
1691
  @param owner: the name of the instance for which disk is created,
1692
      used for device cache data
1693
  @type on_primary: boolean
1694
  @param on_primary:  indicates if it is the primary node or not
1695
  @type info: string
1696
  @param info: string that will be sent to the physical device
1697
      creation, used for example to set (LVM) tags on LVs
1698
  @type excl_stor: boolean
1699
  @param excl_stor: Whether exclusive_storage is active
1700

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

1705
  """
1706
  # TODO: remove the obsolete "size" argument
1707
  # pylint: disable=W0613
1708
  clist = []
1709
  if disk.children:
1710
    for child in disk.children:
1711
      try:
1712
        crdev = _RecursiveAssembleBD(child, owner, on_primary)
1713
      except errors.BlockDeviceError, err:
1714
        _Fail("Can't assemble device %s: %s", child, err)
1715
      if on_primary or disk.AssembleOnSecondary():
1716
        # we need the children open in case the device itself has to
1717
        # be assembled
1718
        try:
1719
          # pylint: disable=E1103
1720
          crdev.Open()
1721
        except errors.BlockDeviceError, err:
1722
          _Fail("Can't make child '%s' read-write: %s", child, err)
1723
      clist.append(crdev)
1724

    
1725
  try:
1726
    device = bdev.Create(disk, clist, excl_stor)
1727
  except errors.BlockDeviceError, err:
1728
    _Fail("Can't create block device: %s", err)
1729

    
1730
  if on_primary or disk.AssembleOnSecondary():
1731
    try:
1732
      device.Assemble()
1733
    except errors.BlockDeviceError, err:
1734
      _Fail("Can't assemble device after creation, unusual event: %s", err)
1735
    if on_primary or disk.OpenOnSecondary():
1736
      try:
1737
        device.Open(force=True)
1738
      except errors.BlockDeviceError, err:
1739
        _Fail("Can't make device r/w after creation, unusual event: %s", err)
1740
    DevCacheManager.UpdateCache(device.dev_path, owner,
1741
                                on_primary, disk.iv_name)
1742

    
1743
  device.SetInfo(info)
1744

    
1745
  return device.unique_id
1746

    
1747

    
1748
def _WipeDevice(path, offset, size):
1749
  """This function actually wipes the device.
1750

1751
  @param path: The path to the device to wipe
1752
  @param offset: The offset in MiB in the file
1753
  @param size: The size in MiB to write
1754

1755
  """
1756
  # Internal sizes are always in Mebibytes; if the following "dd" command
1757
  # should use a different block size the offset and size given to this
1758
  # function must be adjusted accordingly before being passed to "dd".
1759
  block_size = 1024 * 1024
1760

    
1761
  cmd = [constants.DD_CMD, "if=/dev/zero", "seek=%d" % offset,
1762
         "bs=%s" % block_size, "oflag=direct", "of=%s" % path,
1763
         "count=%d" % size]
1764
  result = utils.RunCmd(cmd)
1765

    
1766
  if result.failed:
1767
    _Fail("Wipe command '%s' exited with error: %s; output: %s", result.cmd,
1768
          result.fail_reason, result.output)
1769

    
1770

    
1771
def BlockdevWipe(disk, offset, size):
1772
  """Wipes a block device.
1773

1774
  @type disk: L{objects.Disk}
1775
  @param disk: the disk object we want to wipe
1776
  @type offset: int
1777
  @param offset: The offset in MiB in the file
1778
  @type size: int
1779
  @param size: The size in MiB to write
1780

1781
  """
1782
  try:
1783
    rdev = _RecursiveFindBD(disk)
1784
  except errors.BlockDeviceError:
1785
    rdev = None
1786

    
1787
  if not rdev:
1788
    _Fail("Cannot execute wipe for device %s: device not found", disk.iv_name)
1789

    
1790
  # Do cross verify some of the parameters
1791
  if offset < 0:
1792
    _Fail("Negative offset")
1793
  if size < 0:
1794
    _Fail("Negative size")
1795
  if offset > rdev.size:
1796
    _Fail("Offset is bigger than device size")
1797
  if (offset + size) > rdev.size:
1798
    _Fail("The provided offset and size to wipe is bigger than device size")
1799

    
1800
  _WipeDevice(rdev.dev_path, offset, size)
1801

    
1802

    
1803
def BlockdevPauseResumeSync(disks, pause):
1804
  """Pause or resume the sync of the block device.
1805

1806
  @type disks: list of L{objects.Disk}
1807
  @param disks: the disks object we want to pause/resume
1808
  @type pause: bool
1809
  @param pause: Wheater to pause or resume
1810

1811
  """
1812
  success = []
1813
  for disk in disks:
1814
    try:
1815
      rdev = _RecursiveFindBD(disk)
1816
    except errors.BlockDeviceError:
1817
      rdev = None
1818

    
1819
    if not rdev:
1820
      success.append((False, ("Cannot change sync for device %s:"
1821
                              " device not found" % disk.iv_name)))
1822
      continue
1823

    
1824
    result = rdev.PauseResumeSync(pause)
1825

    
1826
    if result:
1827
      success.append((result, None))
1828
    else:
1829
      if pause:
1830
        msg = "Pause"
1831
      else:
1832
        msg = "Resume"
1833
      success.append((result, "%s for device %s failed" % (msg, disk.iv_name)))
1834

    
1835
  return success
1836

    
1837

    
1838
def BlockdevRemove(disk):
1839
  """Remove a block device.
1840

1841
  @note: This is intended to be called recursively.
1842

1843
  @type disk: L{objects.Disk}
1844
  @param disk: the disk object we should remove
1845
  @rtype: boolean
1846
  @return: the success of the operation
1847

1848
  """
1849
  msgs = []
1850
  try:
1851
    rdev = _RecursiveFindBD(disk)
1852
  except errors.BlockDeviceError, err:
1853
    # probably can't attach
1854
    logging.info("Can't attach to device %s in remove", disk)
1855
    rdev = None
1856
  if rdev is not None:
1857
    r_path = rdev.dev_path
1858
    try:
1859
      rdev.Remove()
1860
    except errors.BlockDeviceError, err:
1861
      msgs.append(str(err))
1862
    if not msgs:
1863
      DevCacheManager.RemoveCache(r_path)
1864

    
1865
  if disk.children:
1866
    for child in disk.children:
1867
      try:
1868
        BlockdevRemove(child)
1869
      except RPCFail, err:
1870
        msgs.append(str(err))
1871

    
1872
  if msgs:
1873
    _Fail("; ".join(msgs))
1874

    
1875

    
1876
def _RecursiveAssembleBD(disk, owner, as_primary):
1877
  """Activate a block device for an instance.
1878

1879
  This is run on the primary and secondary nodes for an instance.
1880

1881
  @note: this function is called recursively.
1882

1883
  @type disk: L{objects.Disk}
1884
  @param disk: the disk we try to assemble
1885
  @type owner: str
1886
  @param owner: the name of the instance which owns the disk
1887
  @type as_primary: boolean
1888
  @param as_primary: if we should make the block device
1889
      read/write
1890

1891
  @return: the assembled device or None (in case no device
1892
      was assembled)
1893
  @raise errors.BlockDeviceError: in case there is an error
1894
      during the activation of the children or the device
1895
      itself
1896

1897
  """
1898
  children = []
1899
  if disk.children:
1900
    mcn = disk.ChildrenNeeded()
1901
    if mcn == -1:
1902
      mcn = 0 # max number of Nones allowed
1903
    else:
1904
      mcn = len(disk.children) - mcn # max number of Nones
1905
    for chld_disk in disk.children:
1906
      try:
1907
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
1908
      except errors.BlockDeviceError, err:
1909
        if children.count(None) >= mcn:
1910
          raise
1911
        cdev = None
1912
        logging.error("Error in child activation (but continuing): %s",
1913
                      str(err))
1914
      children.append(cdev)
1915

    
1916
  if as_primary or disk.AssembleOnSecondary():
1917
    r_dev = bdev.Assemble(disk, children)
1918
    result = r_dev
1919
    if as_primary or disk.OpenOnSecondary():
1920
      r_dev.Open()
1921
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
1922
                                as_primary, disk.iv_name)
1923

    
1924
  else:
1925
    result = True
1926
  return result
1927

    
1928

    
1929
def BlockdevAssemble(disk, owner, as_primary, idx):
1930
  """Activate a block device for an instance.
1931

1932
  This is a wrapper over _RecursiveAssembleBD.
1933

1934
  @rtype: str or boolean
1935
  @return: a C{/dev/...} path for primary nodes, and
1936
      C{True} for secondary nodes
1937

1938
  """
1939
  try:
1940
    result = _RecursiveAssembleBD(disk, owner, as_primary)
1941
    if isinstance(result, BlockDev):
1942
      # pylint: disable=E1103
1943
      result = result.dev_path
1944
      if as_primary:
1945
        _SymlinkBlockDev(owner, result, idx)
1946
  except errors.BlockDeviceError, err:
1947
    _Fail("Error while assembling disk: %s", err, exc=True)
1948
  except OSError, err:
1949
    _Fail("Error while symlinking disk: %s", err, exc=True)
1950

    
1951
  return result
1952

    
1953

    
1954
def BlockdevShutdown(disk):
1955
  """Shut down a block device.
1956

1957
  First, if the device is assembled (Attach() is successful), then
1958
  the device is shutdown. Then the children of the device are
1959
  shutdown.
1960

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

1965
  @type disk: L{objects.Disk}
1966
  @param disk: the description of the disk we should
1967
      shutdown
1968
  @rtype: None
1969

1970
  """
1971
  msgs = []
1972
  r_dev = _RecursiveFindBD(disk)
1973
  if r_dev is not None:
1974
    r_path = r_dev.dev_path
1975
    try:
1976
      r_dev.Shutdown()
1977
      DevCacheManager.RemoveCache(r_path)
1978
    except errors.BlockDeviceError, err:
1979
      msgs.append(str(err))
1980

    
1981
  if disk.children:
1982
    for child in disk.children:
1983
      try:
1984
        BlockdevShutdown(child)
1985
      except RPCFail, err:
1986
        msgs.append(str(err))
1987

    
1988
  if msgs:
1989
    _Fail("; ".join(msgs))
1990

    
1991

    
1992
def BlockdevAddchildren(parent_cdev, new_cdevs):
1993
  """Extend a mirrored block device.
1994

1995
  @type parent_cdev: L{objects.Disk}
1996
  @param parent_cdev: the disk to which we should add children
1997
  @type new_cdevs: list of L{objects.Disk}
1998
  @param new_cdevs: the list of children which we should add
1999
  @rtype: None
2000

2001
  """
2002
  parent_bdev = _RecursiveFindBD(parent_cdev)
2003
  if parent_bdev is None:
2004
    _Fail("Can't find parent device '%s' in add children", parent_cdev)
2005
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
2006
  if new_bdevs.count(None) > 0:
2007
    _Fail("Can't find new device(s) to add: %s:%s", new_bdevs, new_cdevs)
2008
  parent_bdev.AddChildren(new_bdevs)
2009

    
2010

    
2011
def BlockdevRemovechildren(parent_cdev, new_cdevs):
2012
  """Shrink a mirrored block device.
2013

2014
  @type parent_cdev: L{objects.Disk}
2015
  @param parent_cdev: the disk from which we should remove children
2016
  @type new_cdevs: list of L{objects.Disk}
2017
  @param new_cdevs: the list of children which we should remove
2018
  @rtype: None
2019

2020
  """
2021
  parent_bdev = _RecursiveFindBD(parent_cdev)
2022
  if parent_bdev is None:
2023
    _Fail("Can't find parent device '%s' in remove children", parent_cdev)
2024
  devs = []
2025
  for disk in new_cdevs:
2026
    rpath = disk.StaticDevPath()
2027
    if rpath is None:
2028
      bd = _RecursiveFindBD(disk)
2029
      if bd is None:
2030
        _Fail("Can't find device %s while removing children", disk)
2031
      else:
2032
        devs.append(bd.dev_path)
2033
    else:
2034
      if not utils.IsNormAbsPath(rpath):
2035
        _Fail("Strange path returned from StaticDevPath: '%s'", rpath)
2036
      devs.append(rpath)
2037
  parent_bdev.RemoveChildren(devs)
2038

    
2039

    
2040
def BlockdevGetmirrorstatus(disks):
2041
  """Get the mirroring status of a list of devices.
2042

2043
  @type disks: list of L{objects.Disk}
2044
  @param disks: the list of disks which we should query
2045
  @rtype: disk
2046
  @return: List of L{objects.BlockDevStatus}, one for each disk
2047
  @raise errors.BlockDeviceError: if any of the disks cannot be
2048
      found
2049

2050
  """
2051
  stats = []
2052
  for dsk in disks:
2053
    rbd = _RecursiveFindBD(dsk)
2054
    if rbd is None:
2055
      _Fail("Can't find device %s", dsk)
2056

    
2057
    stats.append(rbd.CombinedSyncStatus())
2058

    
2059
  return stats
2060

    
2061

    
2062
def BlockdevGetmirrorstatusMulti(disks):
2063
  """Get the mirroring status of a list of devices.
2064

2065
  @type disks: list of L{objects.Disk}
2066
  @param disks: the list of disks which we should query
2067
  @rtype: disk
2068
  @return: List of tuples, (bool, status), one for each disk; bool denotes
2069
    success/failure, status is L{objects.BlockDevStatus} on success, string
2070
    otherwise
2071

2072
  """
2073
  result = []
2074
  for disk in disks:
2075
    try:
2076
      rbd = _RecursiveFindBD(disk)
2077
      if rbd is None:
2078
        result.append((False, "Can't find device %s" % disk))
2079
        continue
2080

    
2081
      status = rbd.CombinedSyncStatus()
2082
    except errors.BlockDeviceError, err:
2083
      logging.exception("Error while getting disk status")
2084
      result.append((False, str(err)))
2085
    else:
2086
      result.append((True, status))
2087

    
2088
  assert len(disks) == len(result)
2089

    
2090
  return result
2091

    
2092

    
2093
def _RecursiveFindBD(disk):
2094
  """Check if a device is activated.
2095

2096
  If so, return information about the real device.
2097

2098
  @type disk: L{objects.Disk}
2099
  @param disk: the disk object we need to find
2100

2101
  @return: None if the device can't be found,
2102
      otherwise the device instance
2103

2104
  """
2105
  children = []
2106
  if disk.children:
2107
    for chdisk in disk.children:
2108
      children.append(_RecursiveFindBD(chdisk))
2109

    
2110
  return bdev.FindDevice(disk, children)
2111

    
2112

    
2113
def _OpenRealBD(disk):
2114
  """Opens the underlying block device of a disk.
2115

2116
  @type disk: L{objects.Disk}
2117
  @param disk: the disk object we want to open
2118

2119
  """
2120
  real_disk = _RecursiveFindBD(disk)
2121
  if real_disk is None:
2122
    _Fail("Block device '%s' is not set up", disk)
2123

    
2124
  real_disk.Open()
2125

    
2126
  return real_disk
2127

    
2128

    
2129
def BlockdevFind(disk):
2130
  """Check if a device is activated.
2131

2132
  If it is, return information about the real device.
2133

2134
  @type disk: L{objects.Disk}
2135
  @param disk: the disk to find
2136
  @rtype: None or objects.BlockDevStatus
2137
  @return: None if the disk cannot be found, otherwise a the current
2138
           information
2139

2140
  """
2141
  try:
2142
    rbd = _RecursiveFindBD(disk)
2143
  except errors.BlockDeviceError, err:
2144
    _Fail("Failed to find device: %s", err, exc=True)
2145

    
2146
  if rbd is None:
2147
    return None
2148

    
2149
  return rbd.GetSyncStatus()
2150

    
2151

    
2152
def BlockdevGetsize(disks):
2153
  """Computes the size of the given disks.
2154

2155
  If a disk is not found, returns None instead.
2156

2157
  @type disks: list of L{objects.Disk}
2158
  @param disks: the list of disk to compute the size for
2159
  @rtype: list
2160
  @return: list with elements None if the disk cannot be found,
2161
      otherwise the size
2162

2163
  """
2164
  result = []
2165
  for cf in disks:
2166
    try:
2167
      rbd = _RecursiveFindBD(cf)
2168
    except errors.BlockDeviceError:
2169
      result.append(None)
2170
      continue
2171
    if rbd is None:
2172
      result.append(None)
2173
    else:
2174
      result.append(rbd.GetActualSize())
2175
  return result
2176

    
2177

    
2178
def BlockdevExport(disk, dest_node, dest_path, cluster_name):
2179
  """Export a block device to a remote node.
2180

2181
  @type disk: L{objects.Disk}
2182
  @param disk: the description of the disk to export
2183
  @type dest_node: str
2184
  @param dest_node: the destination node to export to
2185
  @type dest_path: str
2186
  @param dest_path: the destination path on the target node
2187
  @type cluster_name: str
2188
  @param cluster_name: the cluster name, needed for SSH hostalias
2189
  @rtype: None
2190

2191
  """
2192
  real_disk = _OpenRealBD(disk)
2193

    
2194
  # the block size on the read dd is 1MiB to match our units
2195
  expcmd = utils.BuildShellCmd("set -e; set -o pipefail; "
2196
                               "dd if=%s bs=1048576 count=%s",
2197
                               real_disk.dev_path, str(disk.size))
2198

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

    
2208
  remotecmd = _GetSshRunner(cluster_name).BuildCmd(dest_node,
2209
                                                   constants.SSH_LOGIN_USER,
2210
                                                   destcmd)
2211

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

    
2215
  result = utils.RunCmd(["bash", "-c", command])
2216

    
2217
  if result.failed:
2218
    _Fail("Disk copy command '%s' returned error: %s"
2219
          " output: %s", command, result.fail_reason, result.output)
2220

    
2221

    
2222
def UploadFile(file_name, data, mode, uid, gid, atime, mtime):
2223
  """Write a file to the filesystem.
2224

2225
  This allows the master to overwrite(!) a file. It will only perform
2226
  the operation if the file belongs to a list of configuration files.
2227

2228
  @type file_name: str
2229
  @param file_name: the target file name
2230
  @type data: str
2231
  @param data: the new contents of the file
2232
  @type mode: int
2233
  @param mode: the mode to give the file (can be None)
2234
  @type uid: string
2235
  @param uid: the owner of the file
2236
  @type gid: string
2237
  @param gid: the group of the file
2238
  @type atime: float
2239
  @param atime: the atime to set on the file (can be None)
2240
  @type mtime: float
2241
  @param mtime: the mtime to set on the file (can be None)
2242
  @rtype: None
2243

2244
  """
2245
  file_name = vcluster.LocalizeVirtualPath(file_name)
2246

    
2247
  if not os.path.isabs(file_name):
2248
    _Fail("Filename passed to UploadFile is not absolute: '%s'", file_name)
2249

    
2250
  if file_name not in _ALLOWED_UPLOAD_FILES:
2251
    _Fail("Filename passed to UploadFile not in allowed upload targets: '%s'",
2252
          file_name)
2253

    
2254
  raw_data = _Decompress(data)
2255

    
2256
  if not (isinstance(uid, basestring) and isinstance(gid, basestring)):
2257
    _Fail("Invalid username/groupname type")
2258

    
2259
  getents = runtime.GetEnts()
2260
  uid = getents.LookupUser(uid)
2261
  gid = getents.LookupGroup(gid)
2262

    
2263
  utils.SafeWriteFile(file_name, None,
2264
                      data=raw_data, mode=mode, uid=uid, gid=gid,
2265
                      atime=atime, mtime=mtime)
2266

    
2267

    
2268
def RunOob(oob_program, command, node, timeout):
2269
  """Executes oob_program with given command on given node.
2270

2271
  @param oob_program: The path to the executable oob_program
2272
  @param command: The command to invoke on oob_program
2273
  @param node: The node given as an argument to the program
2274
  @param timeout: Timeout after which we kill the oob program
2275

2276
  @return: stdout
2277
  @raise RPCFail: If execution fails for some reason
2278

2279
  """
2280
  result = utils.RunCmd([oob_program, command, node], timeout=timeout)
2281

    
2282
  if result.failed:
2283
    _Fail("'%s' failed with reason '%s'; output: %s", result.cmd,
2284
          result.fail_reason, result.output)
2285

    
2286
  return result.stdout
2287

    
2288

    
2289
def _OSOndiskAPIVersion(os_dir):
2290
  """Compute and return the API version of a given OS.
2291

2292
  This function will try to read the API version of the OS residing in
2293
  the 'os_dir' directory.
2294

2295
  @type os_dir: str
2296
  @param os_dir: the directory in which we should look for the OS
2297
  @rtype: tuple
2298
  @return: tuple (status, data) with status denoting the validity and
2299
      data holding either the vaid versions or an error message
2300

2301
  """
2302
  api_file = utils.PathJoin(os_dir, constants.OS_API_FILE)
2303

    
2304
  try:
2305
    st = os.stat(api_file)
2306
  except EnvironmentError, err:
2307
    return False, ("Required file '%s' not found under path %s: %s" %
2308
                   (constants.OS_API_FILE, os_dir, utils.ErrnoOrStr(err)))
2309

    
2310
  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
2311
    return False, ("File '%s' in %s is not a regular file" %
2312
                   (constants.OS_API_FILE, os_dir))
2313

    
2314
  try:
2315
    api_versions = utils.ReadFile(api_file).splitlines()
2316
  except EnvironmentError, err:
2317
    return False, ("Error while reading the API version file at %s: %s" %
2318
                   (api_file, utils.ErrnoOrStr(err)))
2319

    
2320
  try:
2321
    api_versions = [int(version.strip()) for version in api_versions]
2322
  except (TypeError, ValueError), err:
2323
    return False, ("API version(s) can't be converted to integer: %s" %
2324
                   str(err))
2325

    
2326
  return True, api_versions
2327

    
2328

    
2329
def DiagnoseOS(top_dirs=None):
2330
  """Compute the validity for all OSes.
2331

2332
  @type top_dirs: list
2333
  @param top_dirs: the list of directories in which to
2334
      search (if not given defaults to
2335
      L{pathutils.OS_SEARCH_PATH})
2336
  @rtype: list of L{objects.OS}
2337
  @return: a list of tuples (name, path, status, diagnose, variants,
2338
      parameters, api_version) for all (potential) OSes under all
2339
      search paths, where:
2340
          - name is the (potential) OS name
2341
          - path is the full path to the OS
2342
          - status True/False is the validity of the OS
2343
          - diagnose is the error message for an invalid OS, otherwise empty
2344
          - variants is a list of supported OS variants, if any
2345
          - parameters is a list of (name, help) parameters, if any
2346
          - api_version is a list of support OS API versions
2347

2348
  """
2349
  if top_dirs is None:
2350
    top_dirs = pathutils.OS_SEARCH_PATH
2351

    
2352
  result = []
2353
  for dir_name in top_dirs:
2354
    if os.path.isdir(dir_name):
2355
      try:
2356
        f_names = utils.ListVisibleFiles(dir_name)
2357
      except EnvironmentError, err:
2358
        logging.exception("Can't list the OS directory %s: %s", dir_name, err)
2359
        break
2360
      for name in f_names:
2361
        os_path = utils.PathJoin(dir_name, name)
2362
        status, os_inst = _TryOSFromDisk(name, base_dir=dir_name)
2363
        if status:
2364
          diagnose = ""
2365
          variants = os_inst.supported_variants
2366
          parameters = os_inst.supported_parameters
2367
          api_versions = os_inst.api_versions
2368
        else:
2369
          diagnose = os_inst
2370
          variants = parameters = api_versions = []
2371
        result.append((name, os_path, status, diagnose, variants,
2372
                       parameters, api_versions))
2373

    
2374
  return result
2375

    
2376

    
2377
def _TryOSFromDisk(name, base_dir=None):
2378
  """Create an OS instance from disk.
2379

2380
  This function will return an OS instance if the given name is a
2381
  valid OS name.
2382

2383
  @type base_dir: string
2384
  @keyword base_dir: Base directory containing OS installations.
2385
                     Defaults to a search in all the OS_SEARCH_PATH dirs.
2386
  @rtype: tuple
2387
  @return: success and either the OS instance if we find a valid one,
2388
      or error message
2389

2390
  """
2391
  if base_dir is None:
2392
    os_dir = utils.FindFile(name, pathutils.OS_SEARCH_PATH, os.path.isdir)
2393
  else:
2394
    os_dir = utils.FindFile(name, [base_dir], os.path.isdir)
2395

    
2396
  if os_dir is None:
2397
    return False, "Directory for OS %s not found in search path" % name
2398

    
2399
  status, api_versions = _OSOndiskAPIVersion(os_dir)
2400
  if not status:
2401
    # push the error up
2402
    return status, api_versions
2403

    
2404
  if not constants.OS_API_VERSIONS.intersection(api_versions):
2405
    return False, ("API version mismatch for path '%s': found %s, want %s." %
2406
                   (os_dir, api_versions, constants.OS_API_VERSIONS))
2407

    
2408
  # OS Files dictionary, we will populate it with the absolute path
2409
  # names; if the value is True, then it is a required file, otherwise
2410
  # an optional one
2411
  os_files = dict.fromkeys(constants.OS_SCRIPTS, True)
2412

    
2413
  if max(api_versions) >= constants.OS_API_V15:
2414
    os_files[constants.OS_VARIANTS_FILE] = False
2415

    
2416
  if max(api_versions) >= constants.OS_API_V20:
2417
    os_files[constants.OS_PARAMETERS_FILE] = True
2418
  else:
2419
    del os_files[constants.OS_SCRIPT_VERIFY]
2420

    
2421
  for (filename, required) in os_files.items():
2422
    os_files[filename] = utils.PathJoin(os_dir, filename)
2423

    
2424
    try:
2425
      st = os.stat(os_files[filename])
2426
    except EnvironmentError, err:
2427
      if err.errno == errno.ENOENT and not required:
2428
        del os_files[filename]
2429
        continue
2430
      return False, ("File '%s' under path '%s' is missing (%s)" %
2431
                     (filename, os_dir, utils.ErrnoOrStr(err)))
2432

    
2433
    if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
2434
      return False, ("File '%s' under path '%s' is not a regular file" %
2435
                     (filename, os_dir))
2436

    
2437
    if filename in constants.OS_SCRIPTS:
2438
      if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR:
2439
        return False, ("File '%s' under path '%s' is not executable" %
2440
                       (filename, os_dir))
2441

    
2442
  variants = []
2443
  if constants.OS_VARIANTS_FILE in os_files:
2444
    variants_file = os_files[constants.OS_VARIANTS_FILE]
2445
    try:
2446
      variants = \
2447
        utils.FilterEmptyLinesAndComments(utils.ReadFile(variants_file))
2448
    except EnvironmentError, err:
2449
      # we accept missing files, but not other errors
2450
      if err.errno != errno.ENOENT:
2451
        return False, ("Error while reading the OS variants file at %s: %s" %
2452
                       (variants_file, utils.ErrnoOrStr(err)))
2453

    
2454
  parameters = []
2455
  if constants.OS_PARAMETERS_FILE in os_files:
2456
    parameters_file = os_files[constants.OS_PARAMETERS_FILE]
2457
    try:
2458
      parameters = utils.ReadFile(parameters_file).splitlines()
2459
    except EnvironmentError, err:
2460
      return False, ("Error while reading the OS parameters file at %s: %s" %
2461
                     (parameters_file, utils.ErrnoOrStr(err)))
2462
    parameters = [v.split(None, 1) for v in parameters]
2463

    
2464
  os_obj = objects.OS(name=name, path=os_dir,
2465
                      create_script=os_files[constants.OS_SCRIPT_CREATE],
2466
                      export_script=os_files[constants.OS_SCRIPT_EXPORT],
2467
                      import_script=os_files[constants.OS_SCRIPT_IMPORT],
2468
                      rename_script=os_files[constants.OS_SCRIPT_RENAME],
2469
                      verify_script=os_files.get(constants.OS_SCRIPT_VERIFY,
2470
                                                 None),
2471
                      supported_variants=variants,
2472
                      supported_parameters=parameters,
2473
                      api_versions=api_versions)
2474
  return True, os_obj
2475

    
2476

    
2477
def OSFromDisk(name, base_dir=None):
2478
  """Create an OS instance from disk.
2479

2480
  This function will return an OS instance if the given name is a
2481
  valid OS name. Otherwise, it will raise an appropriate
2482
  L{RPCFail} exception, detailing why this is not a valid OS.
2483

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

2487
  @type base_dir: string
2488
  @keyword base_dir: Base directory containing OS installations.
2489
                     Defaults to a search in all the OS_SEARCH_PATH dirs.
2490
  @rtype: L{objects.OS}
2491
  @return: the OS instance if we find a valid one
2492
  @raise RPCFail: if we don't find a valid OS
2493

2494
  """
2495
  name_only = objects.OS.GetName(name)
2496
  status, payload = _TryOSFromDisk(name_only, base_dir)
2497

    
2498
  if not status:
2499
    _Fail(payload)
2500

    
2501
  return payload
2502

    
2503

    
2504
def OSCoreEnv(os_name, inst_os, os_params, debug=0):
2505
  """Calculate the basic environment for an os script.
2506

2507
  @type os_name: str
2508
  @param os_name: full operating system name (including variant)
2509
  @type inst_os: L{objects.OS}
2510
  @param inst_os: operating system for which the environment is being built
2511
  @type os_params: dict
2512
  @param os_params: the OS parameters
2513
  @type debug: integer
2514
  @param debug: debug level (0 or 1, for OS Api 10)
2515
  @rtype: dict
2516
  @return: dict of environment variables
2517
  @raise errors.BlockDeviceError: if the block device
2518
      cannot be found
2519

2520
  """
2521
  result = {}
2522
  api_version = \
2523
    max(constants.OS_API_VERSIONS.intersection(inst_os.api_versions))
2524
  result["OS_API_VERSION"] = "%d" % api_version
2525
  result["OS_NAME"] = inst_os.name
2526
  result["DEBUG_LEVEL"] = "%d" % debug
2527

    
2528
  # OS variants
2529
  if api_version >= constants.OS_API_V15 and inst_os.supported_variants:
2530
    variant = objects.OS.GetVariant(os_name)
2531
    if not variant:
2532
      variant = inst_os.supported_variants[0]
2533
  else:
2534
    variant = ""
2535
  result["OS_VARIANT"] = variant
2536

    
2537
  # OS params
2538
  for pname, pvalue in os_params.items():
2539
    result["OSP_%s" % pname.upper()] = pvalue
2540

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

    
2546
  return result
2547

    
2548

    
2549
def OSEnvironment(instance, inst_os, debug=0):
2550
  """Calculate the environment for an os script.
2551

2552
  @type instance: L{objects.Instance}
2553
  @param instance: target instance for the os script run
2554
  @type inst_os: L{objects.OS}
2555
  @param inst_os: operating system for which the environment is being built
2556
  @type debug: integer
2557
  @param debug: debug level (0 or 1, for OS Api 10)
2558
  @rtype: dict
2559
  @return: dict of environment variables
2560
  @raise errors.BlockDeviceError: if the block device
2561
      cannot be found
2562

2563
  """
2564
  result = OSCoreEnv(instance.os, inst_os, instance.osparams, debug=debug)
2565

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

    
2569
  result["HYPERVISOR"] = instance.hypervisor
2570
  result["DISK_COUNT"] = "%d" % len(instance.disks)
2571
  result["NIC_COUNT"] = "%d" % len(instance.nics)
2572
  result["INSTANCE_SECONDARY_NODES"] = \
2573
      ("%s" % " ".join(instance.secondary_nodes))
2574

    
2575
  # Disks
2576
  for idx, disk in enumerate(instance.disks):
2577
    real_disk = _OpenRealBD(disk)
2578
    result["DISK_%d_PATH" % idx] = real_disk.dev_path
2579
    result["DISK_%d_ACCESS" % idx] = disk.mode
2580
    if constants.HV_DISK_TYPE in instance.hvparams:
2581
      result["DISK_%d_FRONTEND_TYPE" % idx] = \
2582
        instance.hvparams[constants.HV_DISK_TYPE]
2583
    if disk.dev_type in constants.LDS_BLOCK:
2584
      result["DISK_%d_BACKEND_TYPE" % idx] = "block"
2585
    elif disk.dev_type == constants.LD_FILE:
2586
      result["DISK_%d_BACKEND_TYPE" % idx] = \
2587
        "file:%s" % disk.physical_id[0]
2588

    
2589
  # NICs
2590
  for idx, nic in enumerate(instance.nics):
2591
    result["NIC_%d_MAC" % idx] = nic.mac
2592
    if nic.ip:
2593
      result["NIC_%d_IP" % idx] = nic.ip
2594
    result["NIC_%d_MODE" % idx] = nic.nicparams[constants.NIC_MODE]
2595
    if nic.nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED:
2596
      result["NIC_%d_BRIDGE" % idx] = nic.nicparams[constants.NIC_LINK]
2597
    if nic.nicparams[constants.NIC_LINK]:
2598
      result["NIC_%d_LINK" % idx] = nic.nicparams[constants.NIC_LINK]
2599
    if nic.netinfo:
2600
      nobj = objects.Network.FromDict(nic.netinfo)
2601
      result.update(nobj.HooksDict("NIC_%d_" % idx))
2602
    if constants.HV_NIC_TYPE in instance.hvparams:
2603
      result["NIC_%d_FRONTEND_TYPE" % idx] = \
2604
        instance.hvparams[constants.HV_NIC_TYPE]
2605

    
2606
  # HV/BE params
2607
  for source, kind in [(instance.beparams, "BE"), (instance.hvparams, "HV")]:
2608
    for key, value in source.items():
2609
      result["INSTANCE_%s_%s" % (kind, key)] = str(value)
2610

    
2611
  return result
2612

    
2613

    
2614
def DiagnoseExtStorage(top_dirs=None):
2615
  """Compute the validity for all ExtStorage Providers.
2616

2617
  @type top_dirs: list
2618
  @param top_dirs: the list of directories in which to
2619
      search (if not given defaults to
2620
      L{pathutils.ES_SEARCH_PATH})
2621
  @rtype: list of L{objects.ExtStorage}
2622
  @return: a list of tuples (name, path, status, diagnose, parameters)
2623
      for all (potential) ExtStorage Providers under all
2624
      search paths, where:
2625
          - name is the (potential) ExtStorage Provider
2626
          - path is the full path to the ExtStorage Provider
2627
          - status True/False is the validity of the ExtStorage Provider
2628
          - diagnose is the error message for an invalid ExtStorage Provider,
2629
            otherwise empty
2630
          - parameters is a list of (name, help) parameters, if any
2631

2632
  """
2633
  if top_dirs is None:
2634
    top_dirs = pathutils.ES_SEARCH_PATH
2635

    
2636
  result = []
2637
  for dir_name in top_dirs:
2638
    if os.path.isdir(dir_name):
2639
      try:
2640
        f_names = utils.ListVisibleFiles(dir_name)
2641
      except EnvironmentError, err:
2642
        logging.exception("Can't list the ExtStorage directory %s: %s",
2643
                          dir_name, err)
2644
        break
2645
      for name in f_names:
2646
        es_path = utils.PathJoin(dir_name, name)
2647
        status, es_inst = bdev.ExtStorageFromDisk(name, base_dir=dir_name)
2648
        if status:
2649
          diagnose = ""
2650
          parameters = es_inst.supported_parameters
2651
        else:
2652
          diagnose = es_inst
2653
          parameters = []
2654
        result.append((name, es_path, status, diagnose, parameters))
2655

    
2656
  return result
2657

    
2658

    
2659
def BlockdevGrow(disk, amount, dryrun, backingstore):
2660
  """Grow a stack of block devices.
2661

2662
  This function is called recursively, with the childrens being the
2663
  first ones to resize.
2664

2665
  @type disk: L{objects.Disk}
2666
  @param disk: the disk to be grown
2667
  @type amount: integer
2668
  @param amount: the amount (in mebibytes) to grow with
2669
  @type dryrun: boolean
2670
  @param dryrun: whether to execute the operation in simulation mode
2671
      only, without actually increasing the size
2672
  @param backingstore: whether to execute the operation on backing storage
2673
      only, or on "logical" storage only; e.g. DRBD is logical storage,
2674
      whereas LVM, file, RBD are backing storage
2675
  @rtype: (status, result)
2676
  @return: a tuple with the status of the operation (True/False), and
2677
      the errors message if status is False
2678

2679
  """
2680
  r_dev = _RecursiveFindBD(disk)
2681
  if r_dev is None:
2682
    _Fail("Cannot find block device %s", disk)
2683

    
2684
  try:
2685
    r_dev.Grow(amount, dryrun, backingstore)
2686
  except errors.BlockDeviceError, err:
2687
    _Fail("Failed to grow block device: %s", err, exc=True)
2688

    
2689

    
2690
def BlockdevSnapshot(disk):
2691
  """Create a snapshot copy of a block device.
2692

2693
  This function is called recursively, and the snapshot is actually created
2694
  just for the leaf lvm backend device.
2695

2696
  @type disk: L{objects.Disk}
2697
  @param disk: the disk to be snapshotted
2698
  @rtype: string
2699
  @return: snapshot disk ID as (vg, lv)
2700

2701
  """
2702
  if disk.dev_type == constants.LD_DRBD8:
2703
    if not disk.children:
2704
      _Fail("DRBD device '%s' without backing storage cannot be snapshotted",
2705
            disk.unique_id)
2706
    return BlockdevSnapshot(disk.children[0])
2707
  elif disk.dev_type == constants.LD_LV:
2708
    r_dev = _RecursiveFindBD(disk)
2709
    if r_dev is not None:
2710
      # FIXME: choose a saner value for the snapshot size
2711
      # let's stay on the safe side and ask for the full size, for now
2712
      return r_dev.Snapshot(disk.size)
2713
    else:
2714
      _Fail("Cannot find block device %s", disk)
2715
  else:
2716
    _Fail("Cannot snapshot non-lvm block device '%s' of type '%s'",
2717
          disk.unique_id, disk.dev_type)
2718

    
2719

    
2720
def BlockdevSetInfo(disk, info):
2721
  """Sets 'metadata' information on block devices.
2722

2723
  This function sets 'info' metadata on block devices. Initial
2724
  information is set at device creation; this function should be used
2725
  for example after renames.
2726

2727
  @type disk: L{objects.Disk}
2728
  @param disk: the disk to be grown
2729
  @type info: string
2730
  @param info: new 'info' metadata
2731
  @rtype: (status, result)
2732
  @return: a tuple with the status of the operation (True/False), and
2733
      the errors message if status is False
2734

2735
  """
2736
  r_dev = _RecursiveFindBD(disk)
2737
  if r_dev is None:
2738
    _Fail("Cannot find block device %s", disk)
2739

    
2740
  try:
2741
    r_dev.SetInfo(info)
2742
  except errors.BlockDeviceError, err:
2743
    _Fail("Failed to set information on block device: %s", err, exc=True)
2744

    
2745

    
2746
def FinalizeExport(instance, snap_disks):
2747
  """Write out the export configuration information.
2748

2749
  @type instance: L{objects.Instance}
2750
  @param instance: the instance which we export, used for
2751
      saving configuration
2752
  @type snap_disks: list of L{objects.Disk}
2753
  @param snap_disks: list of snapshot block devices, which
2754
      will be used to get the actual name of the dump file
2755

2756
  @rtype: None
2757

2758
  """
2759
  destdir = utils.PathJoin(pathutils.EXPORT_DIR, instance.name + ".new")
2760
  finaldestdir = utils.PathJoin(pathutils.EXPORT_DIR, instance.name)
2761

    
2762
  config = objects.SerializableConfigParser()
2763

    
2764
  config.add_section(constants.INISECT_EXP)
2765
  config.set(constants.INISECT_EXP, "version", "0")
2766
  config.set(constants.INISECT_EXP, "timestamp", "%d" % int(time.time()))
2767
  config.set(constants.INISECT_EXP, "source", instance.primary_node)
2768
  config.set(constants.INISECT_EXP, "os", instance.os)
2769
  config.set(constants.INISECT_EXP, "compression", "none")
2770

    
2771
  config.add_section(constants.INISECT_INS)
2772
  config.set(constants.INISECT_INS, "name", instance.name)
2773
  config.set(constants.INISECT_INS, "maxmem", "%d" %
2774
             instance.beparams[constants.BE_MAXMEM])
2775
  config.set(constants.INISECT_INS, "minmem", "%d" %
2776
             instance.beparams[constants.BE_MINMEM])
2777
  # "memory" is deprecated, but useful for exporting to old ganeti versions
2778
  config.set(constants.INISECT_INS, "memory", "%d" %
2779
             instance.beparams[constants.BE_MAXMEM])
2780
  config.set(constants.INISECT_INS, "vcpus", "%d" %
2781
             instance.beparams[constants.BE_VCPUS])
2782
  config.set(constants.INISECT_INS, "disk_template", instance.disk_template)
2783
  config.set(constants.INISECT_INS, "hypervisor", instance.hypervisor)
2784
  config.set(constants.INISECT_INS, "tags", " ".join(instance.GetTags()))
2785

    
2786
  nic_total = 0
2787
  for nic_count, nic in enumerate(instance.nics):
2788
    nic_total += 1
2789
    config.set(constants.INISECT_INS, "nic%d_mac" %
2790
               nic_count, "%s" % nic.mac)
2791
    config.set(constants.INISECT_INS, "nic%d_ip" % nic_count, "%s" % nic.ip)
2792
    config.set(constants.INISECT_INS, "nic%d_network" % nic_count,
2793
               "%s" % nic.network)
2794
    for param in constants.NICS_PARAMETER_TYPES:
2795
      config.set(constants.INISECT_INS, "nic%d_%s" % (nic_count, param),
2796
                 "%s" % nic.nicparams.get(param, None))
2797
  # TODO: redundant: on load can read nics until it doesn't exist
2798
  config.set(constants.INISECT_INS, "nic_count", "%d" % nic_total)
2799

    
2800
  disk_total = 0
2801
  for disk_count, disk in enumerate(snap_disks):
2802
    if disk:
2803
      disk_total += 1
2804
      config.set(constants.INISECT_INS, "disk%d_ivname" % disk_count,
2805
                 ("%s" % disk.iv_name))
2806
      config.set(constants.INISECT_INS, "disk%d_dump" % disk_count,
2807
                 ("%s" % disk.physical_id[1]))
2808
      config.set(constants.INISECT_INS, "disk%d_size" % disk_count,
2809
                 ("%d" % disk.size))
2810

    
2811
  config.set(constants.INISECT_INS, "disk_count", "%d" % disk_total)
2812

    
2813
  # New-style hypervisor/backend parameters
2814

    
2815
  config.add_section(constants.INISECT_HYP)
2816
  for name, value in instance.hvparams.items():
2817
    if name not in constants.HVC_GLOBALS:
2818
      config.set(constants.INISECT_HYP, name, str(value))
2819

    
2820
  config.add_section(constants.INISECT_BEP)
2821
  for name, value in instance.beparams.items():
2822
    config.set(constants.INISECT_BEP, name, str(value))
2823

    
2824
  config.add_section(constants.INISECT_OSP)
2825
  for name, value in instance.osparams.items():
2826
    config.set(constants.INISECT_OSP, name, str(value))
2827

    
2828
  utils.WriteFile(utils.PathJoin(destdir, constants.EXPORT_CONF_FILE),
2829
                  data=config.Dumps())
2830
  shutil.rmtree(finaldestdir, ignore_errors=True)
2831
  shutil.move(destdir, finaldestdir)
2832

    
2833

    
2834
def ExportInfo(dest):
2835
  """Get export configuration information.
2836

2837
  @type dest: str
2838
  @param dest: directory containing the export
2839

2840
  @rtype: L{objects.SerializableConfigParser}
2841
  @return: a serializable config file containing the
2842
      export info
2843

2844
  """
2845
  cff = utils.PathJoin(dest, constants.EXPORT_CONF_FILE)
2846

    
2847
  config = objects.SerializableConfigParser()
2848
  config.read(cff)
2849

    
2850
  if (not config.has_section(constants.INISECT_EXP) or
2851
      not config.has_section(constants.INISECT_INS)):
2852
    _Fail("Export info file doesn't have the required fields")
2853

    
2854
  return config.Dumps()
2855

    
2856

    
2857
def ListExports():
2858
  """Return a list of exports currently available on this machine.
2859

2860
  @rtype: list
2861
  @return: list of the exports
2862

2863
  """
2864
  if os.path.isdir(pathutils.EXPORT_DIR):
2865
    return sorted(utils.ListVisibleFiles(pathutils.EXPORT_DIR))
2866
  else:
2867
    _Fail("No exports directory")
2868

    
2869

    
2870
def RemoveExport(export):
2871
  """Remove an existing export from the node.
2872

2873
  @type export: str
2874
  @param export: the name of the export to remove
2875
  @rtype: None
2876

2877
  """
2878
  target = utils.PathJoin(pathutils.EXPORT_DIR, export)
2879

    
2880
  try:
2881
    shutil.rmtree(target)
2882
  except EnvironmentError, err:
2883
    _Fail("Error while removing the export: %s", err, exc=True)
2884

    
2885

    
2886
def BlockdevRename(devlist):
2887
  """Rename a list of block devices.
2888

2889
  @type devlist: list of tuples
2890
  @param devlist: list of tuples of the form  (disk,
2891
      new_logical_id, new_physical_id); disk is an
2892
      L{objects.Disk} object describing the current disk,
2893
      and new logical_id/physical_id is the name we
2894
      rename it to
2895
  @rtype: boolean
2896
  @return: True if all renames succeeded, False otherwise
2897

2898
  """
2899
  msgs = []
2900
  result = True
2901
  for disk, unique_id in devlist:
2902
    dev = _RecursiveFindBD(disk)
2903
    if dev is None:
2904
      msgs.append("Can't find device %s in rename" % str(disk))
2905
      result = False
2906
      continue
2907
    try:
2908
      old_rpath = dev.dev_path
2909
      dev.Rename(unique_id)
2910
      new_rpath = dev.dev_path
2911
      if old_rpath != new_rpath:
2912
        DevCacheManager.RemoveCache(old_rpath)
2913
        # FIXME: we should add the new cache information here, like:
2914
        # DevCacheManager.UpdateCache(new_rpath, owner, ...)
2915
        # but we don't have the owner here - maybe parse from existing
2916
        # cache? for now, we only lose lvm data when we rename, which
2917
        # is less critical than DRBD or MD
2918
    except errors.BlockDeviceError, err:
2919
      msgs.append("Can't rename device '%s' to '%s': %s" %
2920
                  (dev, unique_id, err))
2921
      logging.exception("Can't rename device '%s' to '%s'", dev, unique_id)
2922
      result = False
2923
  if not result:
2924
    _Fail("; ".join(msgs))
2925

    
2926

    
2927
def _TransformFileStorageDir(fs_dir):
2928
  """Checks whether given file_storage_dir is valid.
2929

2930
  Checks wheter the given fs_dir is within the cluster-wide default
2931
  file_storage_dir or the shared_file_storage_dir, which are stored in
2932
  SimpleStore. Only paths under those directories are allowed.
2933

2934
  @type fs_dir: str
2935
  @param fs_dir: the path to check
2936

2937
  @return: the normalized path if valid, None otherwise
2938

2939
  """
2940
  if not (constants.ENABLE_FILE_STORAGE or
2941
          constants.ENABLE_SHARED_FILE_STORAGE):
2942
    _Fail("File storage disabled at configure time")
2943

    
2944
  bdev.CheckFileStoragePath(fs_dir)
2945

    
2946
  return os.path.normpath(fs_dir)
2947

    
2948

    
2949
def CreateFileStorageDir(file_storage_dir):
2950
  """Create file storage directory.
2951

2952
  @type file_storage_dir: str
2953
  @param file_storage_dir: directory to create
2954

2955
  @rtype: tuple
2956
  @return: tuple with first element a boolean indicating wheter dir
2957
      creation was successful or not
2958

2959
  """
2960
  file_storage_dir = _TransformFileStorageDir(file_storage_dir)
2961
  if os.path.exists(file_storage_dir):
2962
    if not os.path.isdir(file_storage_dir):
2963
      _Fail("Specified storage dir '%s' is not a directory",
2964
            file_storage_dir)
2965
  else:
2966
    try:
2967
      os.makedirs(file_storage_dir, 0750)
2968
    except OSError, err:
2969
      _Fail("Cannot create file storage directory '%s': %s",
2970
            file_storage_dir, err, exc=True)
2971

    
2972

    
2973
def RemoveFileStorageDir(file_storage_dir):
2974
  """Remove file storage directory.
2975

2976
  Remove it only if it's empty. If not log an error and return.
2977

2978
  @type file_storage_dir: str
2979
  @param file_storage_dir: the directory we should cleanup
2980
  @rtype: tuple (success,)
2981
  @return: tuple of one element, C{success}, denoting
2982
      whether the operation was successful
2983

2984
  """
2985
  file_storage_dir = _TransformFileStorageDir(file_storage_dir)
2986
  if os.path.exists(file_storage_dir):
2987
    if not os.path.isdir(file_storage_dir):
2988
      _Fail("Specified Storage directory '%s' is not a directory",
2989
            file_storage_dir)
2990
    # deletes dir only if empty, otherwise we want to fail the rpc call
2991
    try:
2992
      os.rmdir(file_storage_dir)
2993
    except OSError, err:
2994
      _Fail("Cannot remove file storage directory '%s': %s",
2995
            file_storage_dir, err)
2996

    
2997

    
2998
def RenameFileStorageDir(old_file_storage_dir, new_file_storage_dir):
2999
  """Rename the file storage directory.
3000

3001
  @type old_file_storage_dir: str
3002
  @param old_file_storage_dir: the current path
3003
  @type new_file_storage_dir: str
3004
  @param new_file_storage_dir: the name we should rename to
3005
  @rtype: tuple (success,)
3006
  @return: tuple of one element, C{success}, denoting
3007
      whether the operation was successful
3008

3009
  """
3010
  old_file_storage_dir = _TransformFileStorageDir(old_file_storage_dir)
3011
  new_file_storage_dir = _TransformFileStorageDir(new_file_storage_dir)
3012
  if not os.path.exists(new_file_storage_dir):
3013
    if os.path.isdir(old_file_storage_dir):
3014
      try:
3015
        os.rename(old_file_storage_dir, new_file_storage_dir)
3016
      except OSError, err:
3017
        _Fail("Cannot rename '%s' to '%s': %s",
3018
              old_file_storage_dir, new_file_storage_dir, err)
3019
    else:
3020
      _Fail("Specified storage dir '%s' is not a directory",
3021
            old_file_storage_dir)
3022
  else:
3023
    if os.path.exists(old_file_storage_dir):
3024
      _Fail("Cannot rename '%s' to '%s': both locations exist",
3025
            old_file_storage_dir, new_file_storage_dir)
3026

    
3027

    
3028
def _EnsureJobQueueFile(file_name):
3029
  """Checks whether the given filename is in the queue directory.
3030

3031
  @type file_name: str
3032
  @param file_name: the file name we should check
3033
  @rtype: None
3034
  @raises RPCFail: if the file is not valid
3035

3036
  """
3037
  if not utils.IsBelowDir(pathutils.QUEUE_DIR, file_name):
3038
    _Fail("Passed job queue file '%s' does not belong to"
3039
          " the queue directory '%s'", file_name, pathutils.QUEUE_DIR)
3040

    
3041

    
3042
def JobQueueUpdate(file_name, content):
3043
  """Updates a file in the queue directory.
3044

3045
  This is just a wrapper over L{utils.io.WriteFile}, with proper
3046
  checking.
3047

3048
  @type file_name: str
3049
  @param file_name: the job file name
3050
  @type content: str
3051
  @param content: the new job contents
3052
  @rtype: boolean
3053
  @return: the success of the operation
3054

3055
  """
3056
  file_name = vcluster.LocalizeVirtualPath(file_name)
3057

    
3058
  _EnsureJobQueueFile(file_name)
3059
  getents = runtime.GetEnts()
3060

    
3061
  # Write and replace the file atomically
3062
  utils.WriteFile(file_name, data=_Decompress(content), uid=getents.masterd_uid,
3063
                  gid=getents.daemons_gid, mode=constants.JOB_QUEUE_FILES_PERMS)
3064

    
3065

    
3066
def JobQueueRename(old, new):
3067
  """Renames a job queue file.
3068

3069
  This is just a wrapper over os.rename with proper checking.
3070

3071
  @type old: str
3072
  @param old: the old (actual) file name
3073
  @type new: str
3074
  @param new: the desired file name
3075
  @rtype: tuple
3076
  @return: the success of the operation and payload
3077

3078
  """
3079
  old = vcluster.LocalizeVirtualPath(old)
3080
  new = vcluster.LocalizeVirtualPath(new)
3081

    
3082
  _EnsureJobQueueFile(old)
3083
  _EnsureJobQueueFile(new)
3084

    
3085
  getents = runtime.GetEnts()
3086

    
3087
  utils.RenameFile(old, new, mkdir=True, mkdir_mode=0750,
3088
                   dir_uid=getents.masterd_uid, dir_gid=getents.daemons_gid)
3089

    
3090

    
3091
def BlockdevClose(instance_name, disks):
3092
  """Closes the given block devices.
3093

3094
  This means they will be switched to secondary mode (in case of
3095
  DRBD).
3096

3097
  @param instance_name: if the argument is not empty, the symlinks
3098
      of this instance will be removed
3099
  @type disks: list of L{objects.Disk}
3100
  @param disks: the list of disks to be closed
3101
  @rtype: tuple (success, message)
3102
  @return: a tuple of success and message, where success
3103
      indicates the succes of the operation, and message
3104
      which will contain the error details in case we
3105
      failed
3106

3107
  """
3108
  bdevs = []
3109
  for cf in disks:
3110
    rd = _RecursiveFindBD(cf)
3111
    if rd is None:
3112
      _Fail("Can't find device %s", cf)
3113
    bdevs.append(rd)
3114

    
3115
  msg = []
3116
  for rd in bdevs:
3117
    try:
3118
      rd.Close()
3119
    except errors.BlockDeviceError, err:
3120
      msg.append(str(err))
3121
  if msg:
3122
    _Fail("Can't make devices secondary: %s", ",".join(msg))
3123
  else:
3124
    if instance_name:
3125
      _RemoveBlockDevLinks(instance_name, disks)
3126

    
3127

    
3128
def ValidateHVParams(hvname, hvparams):
3129
  """Validates the given hypervisor parameters.
3130

3131
  @type hvname: string
3132
  @param hvname: the hypervisor name
3133
  @type hvparams: dict
3134
  @param hvparams: the hypervisor parameters to be validated
3135
  @rtype: None
3136

3137
  """
3138
  try:
3139
    hv_type = hypervisor.GetHypervisor(hvname)
3140
    hv_type.ValidateParameters(hvparams)
3141
  except errors.HypervisorError, err:
3142
    _Fail(str(err), log=False)
3143

    
3144

    
3145
def _CheckOSPList(os_obj, parameters):
3146
  """Check whether a list of parameters is supported by the OS.
3147

3148
  @type os_obj: L{objects.OS}
3149
  @param os_obj: OS object to check
3150
  @type parameters: list
3151
  @param parameters: the list of parameters to check
3152

3153
  """
3154
  supported = [v[0] for v in os_obj.supported_parameters]
3155
  delta = frozenset(parameters).difference(supported)
3156
  if delta:
3157
    _Fail("The following parameters are not supported"
3158
          " by the OS %s: %s" % (os_obj.name, utils.CommaJoin(delta)))
3159

    
3160

    
3161
def ValidateOS(required, osname, checks, osparams):
3162
  """Validate the given OS' parameters.
3163

3164
  @type required: boolean
3165
  @param required: whether absence of the OS should translate into
3166
      failure or not
3167
  @type osname: string
3168
  @param osname: the OS to be validated
3169
  @type checks: list
3170
  @param checks: list of the checks to run (currently only 'parameters')
3171
  @type osparams: dict
3172
  @param osparams: dictionary with OS parameters
3173
  @rtype: boolean
3174
  @return: True if the validation passed, or False if the OS was not
3175
      found and L{required} was false
3176

3177
  """
3178
  if not constants.OS_VALIDATE_CALLS.issuperset(checks):
3179
    _Fail("Unknown checks required for OS %s: %s", osname,
3180
          set(checks).difference(constants.OS_VALIDATE_CALLS))
3181

    
3182
  name_only = objects.OS.GetName(osname)
3183
  status, tbv = _TryOSFromDisk(name_only, None)
3184

    
3185
  if not status:
3186
    if required:
3187
      _Fail(tbv)
3188
    else:
3189
      return False
3190

    
3191
  if max(tbv.api_versions) < constants.OS_API_V20:
3192
    return True
3193

    
3194
  if constants.OS_VALIDATE_PARAMETERS in checks:
3195
    _CheckOSPList(tbv, osparams.keys())
3196

    
3197
  validate_env = OSCoreEnv(osname, tbv, osparams)
3198
  result = utils.RunCmd([tbv.verify_script] + checks, env=validate_env,
3199
                        cwd=tbv.path, reset_env=True)
3200
  if result.failed:
3201
    logging.error("os validate command '%s' returned error: %s output: %s",
3202
                  result.cmd, result.fail_reason, result.output)
3203
    _Fail("OS validation script failed (%s), output: %s",
3204
          result.fail_reason, result.output, log=False)
3205

    
3206
  return True
3207

    
3208

    
3209
def DemoteFromMC():
3210
  """Demotes the current node from master candidate role.
3211

3212
  """
3213
  # try to ensure we're not the master by mistake
3214
  master, myself = ssconf.GetMasterAndMyself()
3215
  if master == myself:
3216
    _Fail("ssconf status shows I'm the master node, will not demote")
3217

    
3218
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "check", constants.MASTERD])
3219
  if not result.failed:
3220
    _Fail("The master daemon is running, will not demote")
3221

    
3222
  try:
3223
    if os.path.isfile(pathutils.CLUSTER_CONF_FILE):
3224
      utils.CreateBackup(pathutils.CLUSTER_CONF_FILE)
3225
  except EnvironmentError, err:
3226
    if err.errno != errno.ENOENT:
3227
      _Fail("Error while backing up cluster file: %s", err, exc=True)
3228

    
3229
  utils.RemoveFile(pathutils.CLUSTER_CONF_FILE)
3230

    
3231

    
3232
def _GetX509Filenames(cryptodir, name):
3233
  """Returns the full paths for the private key and certificate.
3234

3235
  """
3236
  return (utils.PathJoin(cryptodir, name),
3237
          utils.PathJoin(cryptodir, name, _X509_KEY_FILE),
3238
          utils.PathJoin(cryptodir, name, _X509_CERT_FILE))
3239

    
3240

    
3241
def CreateX509Certificate(validity, cryptodir=pathutils.CRYPTO_KEYS_DIR):
3242
  """Creates a new X509 certificate for SSL/TLS.
3243

3244
  @type validity: int
3245
  @param validity: Validity in seconds
3246
  @rtype: tuple; (string, string)
3247
  @return: Certificate name and public part
3248

3249
  """
3250
  (key_pem, cert_pem) = \
3251
    utils.GenerateSelfSignedX509Cert(netutils.Hostname.GetSysName(),
3252
                                     min(validity, _MAX_SSL_CERT_VALIDITY))
3253

    
3254
  cert_dir = tempfile.mkdtemp(dir=cryptodir,
3255
                              prefix="x509-%s-" % utils.TimestampForFilename())
3256
  try:
3257
    name = os.path.basename(cert_dir)
3258
    assert len(name) > 5
3259

    
3260
    (_, key_file, cert_file) = _GetX509Filenames(cryptodir, name)
3261

    
3262
    utils.WriteFile(key_file, mode=0400, data=key_pem)
3263
    utils.WriteFile(cert_file, mode=0400, data=cert_pem)
3264

    
3265
    # Never return private key as it shouldn't leave the node
3266
    return (name, cert_pem)
3267
  except Exception:
3268
    shutil.rmtree(cert_dir, ignore_errors=True)
3269
    raise
3270

    
3271

    
3272
def RemoveX509Certificate(name, cryptodir=pathutils.CRYPTO_KEYS_DIR):
3273
  """Removes a X509 certificate.
3274

3275
  @type name: string
3276
  @param name: Certificate name
3277

3278
  """
3279
  (cert_dir, key_file, cert_file) = _GetX509Filenames(cryptodir, name)
3280

    
3281
  utils.RemoveFile(key_file)
3282
  utils.RemoveFile(cert_file)
3283

    
3284
  try:
3285
    os.rmdir(cert_dir)
3286
  except EnvironmentError, err:
3287
    _Fail("Cannot remove certificate directory '%s': %s",
3288
          cert_dir, err)
3289

    
3290

    
3291
def _GetImportExportIoCommand(instance, mode, ieio, ieargs):
3292
  """Returns the command for the requested input/output.
3293

3294
  @type instance: L{objects.Instance}
3295
  @param instance: The instance object
3296
  @param mode: Import/export mode
3297
  @param ieio: Input/output type
3298
  @param ieargs: Input/output arguments
3299

3300
  """
3301
  assert mode in (constants.IEM_IMPORT, constants.IEM_EXPORT)
3302

    
3303
  env = None
3304
  prefix = None
3305
  suffix = None
3306
  exp_size = None
3307

    
3308
  if ieio == constants.IEIO_FILE:
3309
    (filename, ) = ieargs
3310

    
3311
    if not utils.IsNormAbsPath(filename):
3312
      _Fail("Path '%s' is not normalized or absolute", filename)
3313

    
3314
    real_filename = os.path.realpath(filename)
3315
    directory = os.path.dirname(real_filename)
3316

    
3317
    if not utils.IsBelowDir(pathutils.EXPORT_DIR, real_filename):
3318
      _Fail("File '%s' is not under exports directory '%s': %s",
3319
            filename, pathutils.EXPORT_DIR, real_filename)
3320

    
3321
    # Create directory
3322
    utils.Makedirs(directory, mode=0750)
3323

    
3324
    quoted_filename = utils.ShellQuote(filename)
3325

    
3326
    if mode == constants.IEM_IMPORT:
3327
      suffix = "> %s" % quoted_filename
3328
    elif mode == constants.IEM_EXPORT:
3329
      suffix = "< %s" % quoted_filename
3330

    
3331
      # Retrieve file size
3332
      try:
3333
        st = os.stat(filename)
3334
      except EnvironmentError, err:
3335
        logging.error("Can't stat(2) %s: %s", filename, err)
3336
      else:
3337
        exp_size = utils.BytesToMebibyte(st.st_size)
3338

    
3339
  elif ieio == constants.IEIO_RAW_DISK:
3340
    (disk, ) = ieargs
3341

    
3342
    real_disk = _OpenRealBD(disk)
3343

    
3344
    if mode == constants.IEM_IMPORT:
3345
      # we set here a smaller block size as, due to transport buffering, more
3346
      # than 64-128k will mostly ignored; we use nocreat to fail if the device
3347
      # is not already there or we pass a wrong path; we use notrunc to no
3348
      # attempt truncate on an LV device; we use oflag=dsync to not buffer too
3349
      # much memory; this means that at best, we flush every 64k, which will
3350
      # not be very fast
3351
      suffix = utils.BuildShellCmd(("| dd of=%s conv=nocreat,notrunc"
3352
                                    " bs=%s oflag=dsync"),
3353
                                    real_disk.dev_path,
3354
                                    str(64 * 1024))
3355

    
3356
    elif mode == constants.IEM_EXPORT:
3357
      # the block size on the read dd is 1MiB to match our units
3358
      prefix = utils.BuildShellCmd("dd if=%s bs=%s count=%s |",
3359
                                   real_disk.dev_path,
3360
                                   str(1024 * 1024), # 1 MB
3361
                                   str(disk.size))
3362
      exp_size = disk.size
3363

    
3364
  elif ieio == constants.IEIO_SCRIPT:
3365
    (disk, disk_index, ) = ieargs
3366

    
3367
    assert isinstance(disk_index, (int, long))
3368

    
3369
    real_disk = _OpenRealBD(disk)
3370

    
3371
    inst_os = OSFromDisk(instance.os)
3372
    env = OSEnvironment(instance, inst_os)
3373

    
3374
    if mode == constants.IEM_IMPORT:
3375
      env["IMPORT_DEVICE"] = env["DISK_%d_PATH" % disk_index]
3376
      env["IMPORT_INDEX"] = str(disk_index)
3377
      script = inst_os.import_script
3378

    
3379
    elif mode == constants.IEM_EXPORT:
3380
      env["EXPORT_DEVICE"] = real_disk.dev_path
3381
      env["EXPORT_INDEX"] = str(disk_index)
3382
      script = inst_os.export_script
3383

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

    
3387
    if mode == constants.IEM_IMPORT:
3388
      suffix = "| %s" % script_cmd
3389

    
3390
    elif mode == constants.IEM_EXPORT:
3391
      prefix = "%s |" % script_cmd
3392

    
3393
    # Let script predict size
3394
    exp_size = constants.IE_CUSTOM_SIZE
3395

    
3396
  else:
3397
    _Fail("Invalid %s I/O mode %r", mode, ieio)
3398

    
3399
  return (env, prefix, suffix, exp_size)
3400

    
3401

    
3402
def _CreateImportExportStatusDir(prefix):
3403
  """Creates status directory for import/export.
3404

3405
  """
3406
  return tempfile.mkdtemp(dir=pathutils.IMPORT_EXPORT_DIR,
3407
                          prefix=("%s-%s-" %
3408
                                  (prefix, utils.TimestampForFilename())))
3409

    
3410

    
3411
def StartImportExportDaemon(mode, opts, host, port, instance, component,
3412
                            ieio, ieioargs):
3413
  """Starts an import or export daemon.
3414

3415
  @param mode: Import/output mode
3416
  @type opts: L{objects.ImportExportOptions}
3417
  @param opts: Daemon options
3418
  @type host: string
3419
  @param host: Remote host for export (None for import)
3420
  @type port: int
3421
  @param port: Remote port for export (None for import)
3422
  @type instance: L{objects.Instance}
3423
  @param instance: Instance object
3424
  @type component: string
3425
  @param component: which part of the instance is transferred now,
3426
      e.g. 'disk/0'
3427
  @param ieio: Input/output type
3428
  @param ieioargs: Input/output arguments
3429

3430
  """
3431
  if mode == constants.IEM_IMPORT:
3432
    prefix = "import"
3433

    
3434
    if not (host is None and port is None):
3435
      _Fail("Can not specify host or port on import")
3436

    
3437
  elif mode == constants.IEM_EXPORT:
3438
    prefix = "export"
3439

    
3440
    if host is None or port is None:
3441
      _Fail("Host and port must be specified for an export")
3442

    
3443
  else:
3444
    _Fail("Invalid mode %r", mode)
3445

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

    
3449
  (cmd_env, cmd_prefix, cmd_suffix, exp_size) = \
3450
    _GetImportExportIoCommand(instance, mode, ieio, ieioargs)
3451

    
3452
  if opts.key_name is None:
3453
    # Use server.pem
3454
    key_path = pathutils.NODED_CERT_FILE
3455
    cert_path = pathutils.NODED_CERT_FILE
3456
    assert opts.ca_pem is None
3457
  else:
3458
    (_, key_path, cert_path) = _GetX509Filenames(pathutils.CRYPTO_KEYS_DIR,
3459
                                                 opts.key_name)
3460
    assert opts.ca_pem is not None
3461

    
3462
  for i in [key_path, cert_path]:
3463
    if not os.path.exists(i):
3464
      _Fail("File '%s' does not exist" % i)
3465

    
3466
  status_dir = _CreateImportExportStatusDir("%s-%s" % (prefix, component))
3467
  try:
3468
    status_file = utils.PathJoin(status_dir, _IES_STATUS_FILE)
3469
    pid_file = utils.PathJoin(status_dir, _IES_PID_FILE)
3470
    ca_file = utils.PathJoin(status_dir, _IES_CA_FILE)
3471

    
3472
    if opts.ca_pem is None:
3473
      # Use server.pem
3474
      ca = utils.ReadFile(pathutils.NODED_CERT_FILE)
3475
    else:
3476
      ca = opts.ca_pem
3477

    
3478
    # Write CA file
3479
    utils.WriteFile(ca_file, data=ca, mode=0400)
3480

    
3481
    cmd = [
3482
      pathutils.IMPORT_EXPORT_DAEMON,
3483
      status_file, mode,
3484
      "--key=%s" % key_path,
3485
      "--cert=%s" % cert_path,
3486
      "--ca=%s" % ca_file,
3487
      ]
3488

    
3489
    if host:
3490
      cmd.append("--host=%s" % host)
3491

    
3492
    if port:
3493
      cmd.append("--port=%s" % port)
3494

    
3495
    if opts.ipv6:
3496
      cmd.append("--ipv6")
3497
    else:
3498
      cmd.append("--ipv4")
3499

    
3500
    if opts.compress:
3501
      cmd.append("--compress=%s" % opts.compress)
3502

    
3503
    if opts.magic:
3504
      cmd.append("--magic=%s" % opts.magic)
3505

    
3506
    if exp_size is not None:
3507
      cmd.append("--expected-size=%s" % exp_size)
3508

    
3509
    if cmd_prefix:
3510
      cmd.append("--cmd-prefix=%s" % cmd_prefix)
3511

    
3512
    if cmd_suffix:
3513
      cmd.append("--cmd-suffix=%s" % cmd_suffix)
3514

    
3515
    if mode == constants.IEM_EXPORT:
3516
      # Retry connection a few times when connecting to remote peer
3517
      cmd.append("--connect-retries=%s" % constants.RIE_CONNECT_RETRIES)
3518
      cmd.append("--connect-timeout=%s" % constants.RIE_CONNECT_ATTEMPT_TIMEOUT)
3519
    elif opts.connect_timeout is not None:
3520
      assert mode == constants.IEM_IMPORT
3521
      # Overall timeout for establishing connection while listening
3522
      cmd.append("--connect-timeout=%s" % opts.connect_timeout)
3523

    
3524
    logfile = _InstanceLogName(prefix, instance.os, instance.name, component)
3525

    
3526
    # TODO: Once _InstanceLogName uses tempfile.mkstemp, StartDaemon has
3527
    # support for receiving a file descriptor for output
3528
    utils.StartDaemon(cmd, env=cmd_env, pidfile=pid_file,
3529
                      output=logfile)
3530

    
3531
    # The import/export name is simply the status directory name
3532
    return os.path.basename(status_dir)
3533

    
3534
  except Exception:
3535
    shutil.rmtree(status_dir, ignore_errors=True)
3536
    raise
3537

    
3538

    
3539
def GetImportExportStatus(names):
3540
  """Returns import/export daemon status.
3541

3542
  @type names: sequence
3543
  @param names: List of names
3544
  @rtype: List of dicts
3545
  @return: Returns a list of the state of each named import/export or None if a
3546
           status couldn't be read
3547

3548
  """
3549
  result = []
3550

    
3551
  for name in names:
3552
    status_file = utils.PathJoin(pathutils.IMPORT_EXPORT_DIR, name,
3553
                                 _IES_STATUS_FILE)
3554

    
3555
    try:
3556
      data = utils.ReadFile(status_file)
3557
    except EnvironmentError, err:
3558
      if err.errno != errno.ENOENT:
3559
        raise
3560
      data = None
3561

    
3562
    if not data:
3563
      result.append(None)
3564
      continue
3565

    
3566
    result.append(serializer.LoadJson(data))
3567

    
3568
  return result
3569

    
3570

    
3571
def AbortImportExport(name):
3572
  """Sends SIGTERM to a running import/export daemon.
3573

3574
  """
3575
  logging.info("Abort import/export %s", name)
3576

    
3577
  status_dir = utils.PathJoin(pathutils.IMPORT_EXPORT_DIR, name)
3578
  pid = utils.ReadLockedPidFile(utils.PathJoin(status_dir, _IES_PID_FILE))
3579

    
3580
  if pid:
3581
    logging.info("Import/export %s is running with PID %s, sending SIGTERM",
3582
                 name, pid)
3583
    utils.IgnoreProcessNotFound(os.kill, pid, signal.SIGTERM)
3584

    
3585

    
3586
def CleanupImportExport(name):
3587
  """Cleanup after an import or export.
3588

3589
  If the import/export daemon is still running it's killed. Afterwards the
3590
  whole status directory is removed.
3591

3592
  """
3593
  logging.info("Finalizing import/export %s", name)
3594

    
3595
  status_dir = utils.PathJoin(pathutils.IMPORT_EXPORT_DIR, name)
3596

    
3597
  pid = utils.ReadLockedPidFile(utils.PathJoin(status_dir, _IES_PID_FILE))
3598

    
3599
  if pid:
3600
    logging.info("Import/export %s is still running with PID %s",
3601
                 name, pid)
3602
    utils.KillProcess(pid, waitpid=False)
3603

    
3604
  shutil.rmtree(status_dir, ignore_errors=True)
3605

    
3606

    
3607
def _FindDisks(nodes_ip, disks):
3608
  """Sets the physical ID on disks and returns the block devices.
3609

3610
  """
3611
  # set the correct physical ID
3612
  my_name = netutils.Hostname.GetSysName()
3613
  for cf in disks:
3614
    cf.SetPhysicalID(my_name, nodes_ip)
3615

    
3616
  bdevs = []
3617

    
3618
  for cf in disks:
3619
    rd = _RecursiveFindBD(cf)
3620
    if rd is None:
3621
      _Fail("Can't find device %s", cf)
3622
    bdevs.append(rd)
3623
  return bdevs
3624

    
3625

    
3626
def DrbdDisconnectNet(nodes_ip, disks):
3627
  """Disconnects the network on a list of drbd devices.
3628

3629
  """
3630
  bdevs = _FindDisks(nodes_ip, disks)
3631

    
3632
  # disconnect disks
3633
  for rd in bdevs:
3634
    try:
3635
      rd.DisconnectNet()
3636
    except errors.BlockDeviceError, err:
3637
      _Fail("Can't change network configuration to standalone mode: %s",
3638
            err, exc=True)
3639

    
3640

    
3641
def DrbdAttachNet(nodes_ip, disks, instance_name, multimaster):
3642
  """Attaches the network on a list of drbd devices.
3643

3644
  """
3645
  bdevs = _FindDisks(nodes_ip, disks)
3646

    
3647
  if multimaster:
3648
    for idx, rd in enumerate(bdevs):
3649
      try:
3650
        _SymlinkBlockDev(instance_name, rd.dev_path, idx)
3651
      except EnvironmentError, err:
3652
        _Fail("Can't create symlink: %s", err)
3653
  # reconnect disks, switch to new master configuration and if
3654
  # needed primary mode
3655
  for rd in bdevs:
3656
    try:
3657
      rd.AttachNet(multimaster)
3658
    except errors.BlockDeviceError, err:
3659
      _Fail("Can't change network configuration: %s", err)
3660

    
3661
  # wait until the disks are connected; we need to retry the re-attach
3662
  # if the device becomes standalone, as this might happen if the one
3663
  # node disconnects and reconnects in a different mode before the
3664
  # other node reconnects; in this case, one or both of the nodes will
3665
  # decide it has wrong configuration and switch to standalone
3666

    
3667
  def _Attach():
3668
    all_connected = True
3669

    
3670
    for rd in bdevs:
3671
      stats = rd.GetProcStatus()
3672

    
3673
      all_connected = (all_connected and
3674
                       (stats.is_connected or stats.is_in_resync))
3675

    
3676
      if stats.is_standalone:
3677
        # peer had different config info and this node became
3678
        # standalone, even though this should not happen with the
3679
        # new staged way of changing disk configs
3680
        try:
3681
          rd.AttachNet(multimaster)
3682
        except errors.BlockDeviceError, err:
3683
          _Fail("Can't change network configuration: %s", err)
3684

    
3685
    if not all_connected:
3686
      raise utils.RetryAgain()
3687

    
3688
  try:
3689
    # Start with a delay of 100 miliseconds and go up to 5 seconds
3690
    utils.Retry(_Attach, (0.1, 1.5, 5.0), 2 * 60)
3691
  except utils.RetryTimeout:
3692
    _Fail("Timeout in disk reconnecting")
3693

    
3694
  if multimaster:
3695
    # change to primary mode
3696
    for rd in bdevs:
3697
      try:
3698
        rd.Open()
3699
      except errors.BlockDeviceError, err:
3700
        _Fail("Can't change to primary mode: %s", err)
3701

    
3702

    
3703
def DrbdWaitSync(nodes_ip, disks):
3704
  """Wait until DRBDs have synchronized.
3705

3706
  """
3707
  def _helper(rd):
3708
    stats = rd.GetProcStatus()
3709
    if not (stats.is_connected or stats.is_in_resync):
3710
      raise utils.RetryAgain()
3711
    return stats
3712

    
3713
  bdevs = _FindDisks(nodes_ip, disks)
3714

    
3715
  min_resync = 100
3716
  alldone = True
3717
  for rd in bdevs:
3718
    try:
3719
      # poll each second for 15 seconds
3720
      stats = utils.Retry(_helper, 1, 15, args=[rd])
3721
    except utils.RetryTimeout:
3722
      stats = rd.GetProcStatus()
3723
      # last check
3724
      if not (stats.is_connected or stats.is_in_resync):
3725
        _Fail("DRBD device %s is not in sync: stats=%s", rd, stats)
3726
    alldone = alldone and (not stats.is_in_resync)
3727
    if stats.sync_percent is not None:
3728
      min_resync = min(min_resync, stats.sync_percent)
3729

    
3730
  return (alldone, min_resync)
3731

    
3732

    
3733
def GetDrbdUsermodeHelper():
3734
  """Returns DRBD usermode helper currently configured.
3735

3736
  """
3737
  try:
3738
    return drbd.DRBD8.GetUsermodeHelper()
3739
  except errors.BlockDeviceError, err:
3740
    _Fail(str(err))
3741

    
3742

    
3743
def PowercycleNode(hypervisor_type):
3744
  """Hard-powercycle the node.
3745

3746
  Because we need to return first, and schedule the powercycle in the
3747
  background, we won't be able to report failures nicely.
3748

3749
  """
3750
  hyper = hypervisor.GetHypervisor(hypervisor_type)
3751
  try:
3752
    pid = os.fork()
3753
  except OSError:
3754
    # if we can't fork, we'll pretend that we're in the child process
3755
    pid = 0
3756
  if pid > 0:
3757
    return "Reboot scheduled in 5 seconds"
3758
  # ensure the child is running on ram
3759
  try:
3760
    utils.Mlockall()
3761
  except Exception: # pylint: disable=W0703
3762
    pass
3763
  time.sleep(5)
3764
  hyper.PowercycleNode()
3765

    
3766

    
3767
def _VerifyRestrictedCmdName(cmd):
3768
  """Verifies a restricted command name.
3769

3770
  @type cmd: string
3771
  @param cmd: Command name
3772
  @rtype: tuple; (boolean, string or None)
3773
  @return: The tuple's first element is the status; if C{False}, the second
3774
    element is an error message string, otherwise it's C{None}
3775

3776
  """
3777
  if not cmd.strip():
3778
    return (False, "Missing command name")
3779

    
3780
  if os.path.basename(cmd) != cmd:
3781
    return (False, "Invalid command name")
3782

    
3783
  if not constants.EXT_PLUGIN_MASK.match(cmd):
3784
    return (False, "Command name contains forbidden characters")
3785

    
3786
  return (True, None)
3787

    
3788

    
3789
def _CommonRestrictedCmdCheck(path, owner):
3790
  """Common checks for restricted command file system directories and files.
3791

3792
  @type path: string
3793
  @param path: Path to check
3794
  @param owner: C{None} or tuple containing UID and GID
3795
  @rtype: tuple; (boolean, string or C{os.stat} result)
3796
  @return: The tuple's first element is the status; if C{False}, the second
3797
    element is an error message string, otherwise it's the result of C{os.stat}
3798

3799
  """
3800
  if owner is None:
3801
    # Default to root as owner
3802
    owner = (0, 0)
3803

    
3804
  try:
3805
    st = os.stat(path)
3806
  except EnvironmentError, err:
3807
    return (False, "Can't stat(2) '%s': %s" % (path, err))
3808

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

    
3812
  if (st.st_uid, st.st_gid) != owner:
3813
    (owner_uid, owner_gid) = owner
3814
    return (False, "'%s' is not owned by %s:%s" % (path, owner_uid, owner_gid))
3815

    
3816
  return (True, st)
3817

    
3818

    
3819
def _VerifyRestrictedCmdDirectory(path, _owner=None):
3820
  """Verifies restricted command directory.
3821

3822
  @type path: string
3823
  @param path: Path to check
3824
  @rtype: tuple; (boolean, string or None)
3825
  @return: The tuple's first element is the status; if C{False}, the second
3826
    element is an error message string, otherwise it's C{None}
3827

3828
  """
3829
  (status, value) = _CommonRestrictedCmdCheck(path, _owner)
3830

    
3831
  if not status:
3832
    return (False, value)
3833

    
3834
  if not stat.S_ISDIR(value.st_mode):
3835
    return (False, "Path '%s' is not a directory" % path)
3836

    
3837
  return (True, None)
3838

    
3839

    
3840
def _VerifyRestrictedCmd(path, cmd, _owner=None):
3841
  """Verifies a whole restricted command and returns its executable filename.
3842

3843
  @type path: string
3844
  @param path: Directory containing restricted commands
3845
  @type cmd: string
3846
  @param cmd: Command name
3847
  @rtype: tuple; (boolean, string)
3848
  @return: The tuple's first element is the status; if C{False}, the second
3849
    element is an error message string, otherwise the second element is the
3850
    absolute path to the executable
3851

3852
  """
3853
  executable = utils.PathJoin(path, cmd)
3854

    
3855
  (status, msg) = _CommonRestrictedCmdCheck(executable, _owner)
3856

    
3857
  if not status:
3858
    return (False, msg)
3859

    
3860
  if not utils.IsExecutable(executable):
3861
    return (False, "access(2) thinks '%s' can't be executed" % executable)
3862

    
3863
  return (True, executable)
3864

    
3865

    
3866
def _PrepareRestrictedCmd(path, cmd,
3867
                          _verify_dir=_VerifyRestrictedCmdDirectory,
3868
                          _verify_name=_VerifyRestrictedCmdName,
3869
                          _verify_cmd=_VerifyRestrictedCmd):
3870
  """Performs a number of tests on a restricted command.
3871

3872
  @type path: string
3873
  @param path: Directory containing restricted commands
3874
  @type cmd: string
3875
  @param cmd: Command name
3876
  @return: Same as L{_VerifyRestrictedCmd}
3877

3878
  """
3879
  # Verify the directory first
3880
  (status, msg) = _verify_dir(path)
3881
  if status:
3882
    # Check command if everything was alright
3883
    (status, msg) = _verify_name(cmd)
3884

    
3885
  if not status:
3886
    return (False, msg)
3887

    
3888
  # Check actual executable
3889
  return _verify_cmd(path, cmd)
3890

    
3891

    
3892
def RunRestrictedCmd(cmd,
3893
                     _lock_timeout=_RCMD_LOCK_TIMEOUT,
3894
                     _lock_file=pathutils.RESTRICTED_COMMANDS_LOCK_FILE,
3895
                     _path=pathutils.RESTRICTED_COMMANDS_DIR,
3896
                     _sleep_fn=time.sleep,
3897
                     _prepare_fn=_PrepareRestrictedCmd,
3898
                     _runcmd_fn=utils.RunCmd,
3899
                     _enabled=constants.ENABLE_RESTRICTED_COMMANDS):
3900
  """Executes a restricted command after performing strict tests.
3901

3902
  @type cmd: string
3903
  @param cmd: Command name
3904
  @rtype: string
3905
  @return: Command output
3906
  @raise RPCFail: In case of an error
3907

3908
  """
3909
  logging.info("Preparing to run restricted command '%s'", cmd)
3910

    
3911
  if not _enabled:
3912
    _Fail("Restricted commands disabled at configure time")
3913

    
3914
  lock = None
3915
  try:
3916
    cmdresult = None
3917
    try:
3918
      lock = utils.FileLock.Open(_lock_file)
3919
      lock.Exclusive(blocking=True, timeout=_lock_timeout)
3920

    
3921
      (status, value) = _prepare_fn(_path, cmd)
3922

    
3923
      if status:
3924
        cmdresult = _runcmd_fn([value], env={}, reset_env=True,
3925
                               postfork_fn=lambda _: lock.Unlock())
3926
      else:
3927
        logging.error(value)
3928
    except Exception: # pylint: disable=W0703
3929
      # Keep original error in log
3930
      logging.exception("Caught exception")
3931

    
3932
    if cmdresult is None:
3933
      logging.info("Sleeping for %0.1f seconds before returning",
3934
                   _RCMD_INVALID_DELAY)
3935
      _sleep_fn(_RCMD_INVALID_DELAY)
3936

    
3937
      # Do not include original error message in returned error
3938
      _Fail("Executing command '%s' failed" % cmd)
3939
    elif cmdresult.failed or cmdresult.fail_reason:
3940
      _Fail("Restricted command '%s' failed: %s; output: %s",
3941
            cmd, cmdresult.fail_reason, cmdresult.output)
3942
    else:
3943
      return cmdresult.output
3944
  finally:
3945
    if lock is not None:
3946
      # Release lock at last
3947
      lock.Close()
3948
      lock = None
3949

    
3950

    
3951
def SetWatcherPause(until, _filename=pathutils.WATCHER_PAUSEFILE):
3952
  """Creates or removes the watcher pause file.
3953

3954
  @type until: None or number
3955
  @param until: Unix timestamp saying until when the watcher shouldn't run
3956

3957
  """
3958
  if until is None:
3959
    logging.info("Received request to no longer pause watcher")
3960
    utils.RemoveFile(_filename)
3961
  else:
3962
    logging.info("Received request to pause watcher until %s", until)
3963

    
3964
    if not ht.TNumber(until):
3965
      _Fail("Duration must be numeric")
3966

    
3967
    utils.WriteFile(_filename, data="%d\n" % (until, ), mode=0644)
3968

    
3969

    
3970
class HooksRunner(object):
3971
  """Hook runner.
3972

3973
  This class is instantiated on the node side (ganeti-noded) and not
3974
  on the master side.
3975

3976
  """
3977
  def __init__(self, hooks_base_dir=None):
3978
    """Constructor for hooks runner.
3979

3980
    @type hooks_base_dir: str or None
3981
    @param hooks_base_dir: if not None, this overrides the
3982
        L{pathutils.HOOKS_BASE_DIR} (useful for unittests)
3983

3984
    """
3985
    if hooks_base_dir is None:
3986
      hooks_base_dir = pathutils.HOOKS_BASE_DIR
3987
    # yeah, _BASE_DIR is not valid for attributes, we use it like a
3988
    # constant
3989
    self._BASE_DIR = hooks_base_dir # pylint: disable=C0103
3990

    
3991
  def RunLocalHooks(self, node_list, hpath, phase, env):
3992
    """Check that the hooks will be run only locally and then run them.
3993

3994
    """
3995
    assert len(node_list) == 1
3996
    node = node_list[0]
3997
    _, myself = ssconf.GetMasterAndMyself()
3998
    assert node == myself
3999

    
4000
    results = self.RunHooks(hpath, phase, env)
4001

    
4002
    # Return values in the form expected by HooksMaster
4003
    return {node: (None, False, results)}
4004

    
4005
  def RunHooks(self, hpath, phase, env):
4006
    """Run the scripts in the hooks directory.
4007

4008
    @type hpath: str
4009
    @param hpath: the path to the hooks directory which
4010
        holds the scripts
4011
    @type phase: str
4012
    @param phase: either L{constants.HOOKS_PHASE_PRE} or
4013
        L{constants.HOOKS_PHASE_POST}
4014
    @type env: dict
4015
    @param env: dictionary with the environment for the hook
4016
    @rtype: list
4017
    @return: list of 3-element tuples:
4018
      - script path
4019
      - script result, either L{constants.HKR_SUCCESS} or
4020
        L{constants.HKR_FAIL}
4021
      - output of the script
4022

4023
    @raise errors.ProgrammerError: for invalid input
4024
        parameters
4025

4026
    """
4027
    if phase == constants.HOOKS_PHASE_PRE:
4028
      suffix = "pre"
4029
    elif phase == constants.HOOKS_PHASE_POST:
4030
      suffix = "post"
4031
    else:
4032
      _Fail("Unknown hooks phase '%s'", phase)
4033

    
4034
    subdir = "%s-%s.d" % (hpath, suffix)
4035
    dir_name = utils.PathJoin(self._BASE_DIR, subdir)
4036

    
4037
    results = []
4038

    
4039
    if not os.path.isdir(dir_name):
4040
      # for non-existing/non-dirs, we simply exit instead of logging a
4041
      # warning at every operation
4042
      return results
4043

    
4044
    runparts_results = utils.RunParts(dir_name, env=env, reset_env=True)
4045

    
4046
    for (relname, relstatus, runresult) in runparts_results:
4047
      if relstatus == constants.RUNPARTS_SKIP:
4048
        rrval = constants.HKR_SKIP
4049
        output = ""
4050
      elif relstatus == constants.RUNPARTS_ERR:
4051
        rrval = constants.HKR_FAIL
4052
        output = "Hook script execution error: %s" % runresult
4053
      elif relstatus == constants.RUNPARTS_RUN:
4054
        if runresult.failed:
4055
          rrval = constants.HKR_FAIL
4056
        else:
4057
          rrval = constants.HKR_SUCCESS
4058
        output = utils.SafeEncode(runresult.output.strip())
4059
      results.append(("%s/%s" % (subdir, relname), rrval, output))
4060

    
4061
    return results
4062

    
4063

    
4064
class IAllocatorRunner(object):
4065
  """IAllocator runner.
4066

4067
  This class is instantiated on the node side (ganeti-noded) and not on
4068
  the master side.
4069

4070
  """
4071
  @staticmethod
4072
  def Run(name, idata):
4073
    """Run an iallocator script.
4074

4075
    @type name: str
4076
    @param name: the iallocator script name
4077
    @type idata: str
4078
    @param idata: the allocator input data
4079

4080
    @rtype: tuple
4081
    @return: two element tuple of:
4082
       - status
4083
       - either error message or stdout of allocator (for success)
4084

4085
    """
4086
    alloc_script = utils.FindFile(name, constants.IALLOCATOR_SEARCH_PATH,
4087
                                  os.path.isfile)
4088
    if alloc_script is None:
4089
      _Fail("iallocator module '%s' not found in the search path", name)
4090

    
4091
    fd, fin_name = tempfile.mkstemp(prefix="ganeti-iallocator.")
4092
    try:
4093
      os.write(fd, idata)
4094
      os.close(fd)
4095
      result = utils.RunCmd([alloc_script, fin_name])
4096
      if result.failed:
4097
        _Fail("iallocator module '%s' failed: %s, output '%s'",
4098
              name, result.fail_reason, result.output)
4099
    finally:
4100
      os.unlink(fin_name)
4101

    
4102
    return result.stdout
4103

    
4104

    
4105
class DevCacheManager(object):
4106
  """Simple class for managing a cache of block device information.
4107

4108
  """
4109
  _DEV_PREFIX = "/dev/"
4110
  _ROOT_DIR = pathutils.BDEV_CACHE_DIR
4111

    
4112
  @classmethod
4113
  def _ConvertPath(cls, dev_path):
4114
    """Converts a /dev/name path to the cache file name.
4115

4116
    This replaces slashes with underscores and strips the /dev
4117
    prefix. It then returns the full path to the cache file.
4118

4119
    @type dev_path: str
4120
    @param dev_path: the C{/dev/} path name
4121
    @rtype: str
412