cmdlib.py 353 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2 3
#

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


22
"""Module implementing the master-side code."""
Iustin Pop's avatar
Iustin Pop committed
23

Iustin Pop's avatar
Iustin Pop committed
24
# pylint: disable-msg=W0201,C0302
25 26 27

# W0201 since most LU attributes are defined in CheckPrereq or similar
# functions
Iustin Pop's avatar
Iustin Pop committed
28

Iustin Pop's avatar
Iustin Pop committed
29 30
# C0302: since we have waaaay to many lines in this module

Iustin Pop's avatar
Iustin Pop committed
31 32 33 34 35
import os
import os.path
import time
import re
import platform
36
import logging
37
import copy
38
import OpenSSL
Iustin Pop's avatar
Iustin Pop committed
39 40 41 42 43

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
44
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
45 46
from ganeti import constants
from ganeti import objects
47
from ganeti import serializer
48
from ganeti import ssconf
49
from ganeti import uidpool
50
from ganeti import compat
51 52 53
from ganeti import masterd

import ganeti.masterd.instance # pylint: disable-msg=W0611
54 55


56 57
# Modifiable default values; need to define these here before the
# actual LUs
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

def _EmptyList():
  """Returns an empty list.

  """
  return []


def _EmptyDict():
  """Returns an empty dict.

  """
  return {}


73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
# Some basic types
def _TNotNone(val):
  """Checks if the given value is not None.

  """
  return val is not None


def _TNone(val):
  """Checks if the given value is None.

  """
  return val is None


def _TBool(val):
  """Checks if the given value is a boolean.

  """
  return isinstance(val, bool)


def _TInt(val):
  """Checks if the given value is an integer.

  """
  return isinstance(val, int)


def _TFloat(val):
  """Checks if the given value is a float.

  """
  return isinstance(val, float)


def _TString(val):
  """Checks if the given value is a string.

  """
  return isinstance(val, basestring)


def _TTrue(val):
  """Checks if a given value evaluates to a boolean True value.

  """
  return bool(val)


def _TElemOf(target_list):
  """Builds a function that checks if a given value is a member of a list.

  """
  return lambda val: val in target_list


# Container types
def _TList(val):
  """Checks if the given value is a list.

  """
  return isinstance(val, list)


def _TDict(val):
  """Checks if the given value is a dictionary.

  """
  return isinstance(val, dict)


# Combinator types
def _TAnd(*args):
  """Combine multiple functions using an AND operation.

  """
  def fn(val):
    return compat.all(t(val) for t in args)
  return fn


def _TOr(*args):
  """Combine multiple functions using an AND operation.

  """
  def fn(val):
    return compat.any(t(val) for t in args)
  return fn


# Type aliases

# non-empty string
167
_TNonEmptyString = _TAnd(_TString, _TTrue)
168 169 170


# positive integer
171
_TPositiveInt = _TAnd(_TInt, lambda v: v >= 0)
172 173 174 175 176 177 178


def _TListOf(my_type):
  """Checks if a given value is a list with all elements of the same type.

  """
  return _TAnd(_TList,
179
               lambda lst: compat.all(my_type(v) for v in lst))
180 181 182 183 184 185 186


def _TDictOf(key_type, val_type):
  """Checks a dict type for the type of its key/values.

  """
  return _TAnd(_TDict,
187 188 189
               lambda my_dict: (compat.all(key_type(v) for v in my_dict.keys())
                                and compat.all(val_type(v)
                                               for v in my_dict.values())))
190 191 192


# End types
Iustin Pop's avatar
Iustin Pop committed
193
class LogicalUnit(object):
194
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
195 196

  Subclasses must follow these rules:
197
    - implement ExpandNames
198 199
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
200 201
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
202
    - optionally redefine their run requirements:
203
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
204 205

  Note that all commands require root permissions.
Iustin Pop's avatar
Iustin Pop committed
206

207 208
  @ivar dry_run_result: the value (if any) that will be returned to the caller
      in dry-run mode (signalled by opcode dry_run parameter)
209 210
  @cvar _OP_DEFS: a list of opcode attributes and the defaults values
      they should get if not already existing
211

Iustin Pop's avatar
Iustin Pop committed
212 213 214 215
  """
  HPATH = None
  HTYPE = None
  _OP_REQP = []
216
  _OP_DEFS = []
217
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
218

Iustin Pop's avatar
Iustin Pop committed
219
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
220 221
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
222
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
223 224 225
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
226
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
227
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
228 229
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
230
    self.rpc = rpc
231
    # Dicts used to declare locking needs to mcpu
232
    self.needed_locks = None
233
    self.acquired_locks = {}
234
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
235 236
    self.add_locks = {}
    self.remove_locks = {}
237 238
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
239
    self.__ssh = None
240
    # logging
Iustin Pop's avatar
Iustin Pop committed
241 242
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
243
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
244 245
    # support for dry-run
    self.dry_run_result = None
246 247 248 249
    # support for generic debug attribute
    if (not hasattr(self.op, "debug_level") or
        not isinstance(self.op.debug_level, int)):
      self.op.debug_level = 0
250

251
    # Tasklets
252
    self.tasklets = None
253

254 255 256 257 258 259 260 261
    for aname, aval in self._OP_DEFS:
      if not hasattr(self.op, aname):
        if callable(aval):
          dval = aval()
        else:
          dval = aval
        setattr(self.op, aname, dval)

262 263
    for attr_name, test in self._OP_REQP:
      if not hasattr(op, attr_name):
264
        raise errors.OpPrereqError("Required parameter '%s' missing" %
265
                                   attr_name, errors.ECODE_INVAL)
266 267 268 269 270 271
      attr_val = getattr(op, attr_name, None)
      if not callable(test):
        raise errors.ProgrammerError("Validation for parameter '%s' failed,"
                                     " given type is not a proper type (%s)" %
                                     (attr_name, test))
      if not test(attr_val):
272 273
        logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
                      self.op.OP_ID, attr_name, type(attr_val), attr_val)
274 275
        raise errors.OpPrereqError("Parameter '%s' has invalid type" %
                                   attr_name, errors.ECODE_INVAL)
276

277
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
278

279 280 281 282 283
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
284
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
285 286 287 288
    return self.__ssh

  ssh = property(fget=__GetSSH)

289 290 291 292 293 294 295 296 297
  def CheckArguments(self):
    """Check syntactic validity for the opcode arguments.

    This method is for doing a simple syntactic check and ensure
    validity of opcode parameters, without any cluster-related
    checks. While the same can be accomplished in ExpandNames and/or
    CheckPrereq, doing these separate is better because:

      - ExpandNames is left as as purely a lock-related function
Michael Hanselmann's avatar
Michael Hanselmann committed
298
      - CheckPrereq is run after we have acquired locks (and possible
299 300 301 302 303 304 305 306
        waited for them)

    The function is allowed to change the self.op attribute so that
    later methods can no longer worry about missing parameters.

    """
    pass

307 308 309 310 311 312 313 314 315 316 317
  def ExpandNames(self):
    """Expand names for this LU.

    This method is called before starting to execute the opcode, and it should
    update all the parameters of the opcode to their canonical form (e.g. a
    short node name must be fully expanded after this method has successfully
    completed). This way locking, hooks, logging, ecc. can work correctly.

    LUs which implement this method must also populate the self.needed_locks
    member, as a dict with lock levels as keys, and a list of needed lock names
    as values. Rules:
318 319 320 321 322

      - use an empty dict if you don't need any lock
      - if you don't need any lock at a particular level omit that level
      - don't put anything for the BGL level
      - if you want all locks at a level use locking.ALL_SET as a value
323

Guido Trotter's avatar
Guido Trotter committed
324 325 326 327
    If you need to share locks (rather than acquire them exclusively) at one
    level you can modify self.share_locks, setting a true value (usually 1) for
    that level. By default locks are not shared.

328 329 330 331
    This function can also define a list of tasklets, which then will be
    executed in order instead of the usual LU-level CheckPrereq and Exec
    functions, if those are not defined by the LU.

332 333 334 335 336 337 338 339 340 341 342 343 344
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
        locking.LEVEL_INSTANCE: ['instance1.example.tld'],
      }
      # Acquire just two nodes
      self.needed_locks = {
        locking.LEVEL_NODE: ['node1.example.tld', 'node2.example.tld'],
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
345 346 347 348 349 350 351 352 353 354

    """
    # The implementation of this method is mandatory only if the new LU is
    # concurrent, so that old LUs don't need to be changed all at the same
    # time.
    if self.REQ_BGL:
      self.needed_locks = {} # Exclusive LUs don't need locks.
    else:
      raise NotImplementedError

Guido Trotter's avatar
Guido Trotter committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
  def DeclareLocks(self, level):
    """Declare LU locking needs for a level

    While most LUs can just declare their locking needs at ExpandNames time,
    sometimes there's the need to calculate some locks after having acquired
    the ones before. This function is called just before acquiring locks at a
    particular level, but after acquiring the ones at lower levels, and permits
    such calculations. It can be used to modify self.needed_locks, and by
    default it does nothing.

    This function is only called if you have something already set in
    self.needed_locks for the level.

    @param level: Locking level which is going to be locked
    @type level: member of ganeti.locking.LEVELS

    """

Iustin Pop's avatar
Iustin Pop committed
373 374 375 376 377 378 379 380 381 382 383 384
  def CheckPrereq(self):
    """Check prerequisites for this LU.

    This method should check that the prerequisites for the execution
    of this LU are fulfilled. It can do internode communication, but
    it should be idempotent - no cluster or system changes are
    allowed.

    The method should raise errors.OpPrereqError in case something is
    not fulfilled. Its return value is ignored.

    This method should also update all the parameters of the opcode to
385
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
386 387

    """
388
    if self.tasklets is not None:
389
      for (idx, tl) in enumerate(self.tasklets):
390 391
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
392 393
        tl.CheckPrereq()
    else:
394
      pass
Iustin Pop's avatar
Iustin Pop committed
395 396 397 398 399 400 401 402 403

  def Exec(self, feedback_fn):
    """Execute the LU.

    This method should implement the actual work. It should raise
    errors.OpExecError for failures that are somewhat dealt with in
    code, or expected.

    """
404
    if self.tasklets is not None:
405
      for (idx, tl) in enumerate(self.tasklets):
406
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
407 408 409
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424

  def BuildHooksEnv(self):
    """Build hooks environment for this LU.

    This method should return a three-node tuple consisting of: a dict
    containing the environment that will be used for running the
    specific hook for this LU, a list of node names on which the hook
    should run before the execution, and a list of node names on which
    the hook should run after the execution.

    The keys of the dict must not have 'GANETI_' prefixed as this will
    be handled in the hooks runner. Also note additional keys will be
    added by the hooks runner. If the LU doesn't define any
    environment, an empty dict (and not None) should be returned.

425
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
426 427 428 429 430 431 432

    Note that if the HPATH for a LU class is None, this function will
    not be called.

    """
    raise NotImplementedError

433 434 435 436 437 438 439 440 441
  def HooksCallBack(self, phase, hook_results, feedback_fn, lu_result):
    """Notify the LU about the results of its hooks.

    This method is called every time a hooks phase is executed, and notifies
    the Logical Unit about the hooks' result. The LU can then use it to alter
    its result based on the hooks.  By default the method does nothing and the
    previous result is passed back unchanged but any LU can define it if it
    wants to use the local cluster hook-scripts somehow.

442 443 444 445 446 447 448 449
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
    @param hook_results: the results of the multi-node hooks rpc call
    @param feedback_fn: function used send feedback back to the caller
    @param lu_result: the previous Exec result this LU had, or None
        in the PRE phase
    @return: the new Exec result, based on the previous result
        and hook results
450 451

    """
452 453 454
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
455 456
    return lu_result

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
  def _ExpandAndLockInstance(self):
    """Helper function to expand and lock an instance.

    Many LUs that work on an instance take its name in self.op.instance_name
    and need to expand it and then declare the expanded name for locking. This
    function does it, and then updates self.op.instance_name to the expanded
    name. It also initializes needed_locks as a dict, if this hasn't been done
    before.

    """
    if self.needed_locks is None:
      self.needed_locks = {}
    else:
      assert locking.LEVEL_INSTANCE not in self.needed_locks, \
        "_ExpandAndLockInstance called with instance-level locks set"
472 473 474
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
475

476
  def _LockInstancesNodes(self, primary_only=False):
477 478 479 480 481 482 483 484 485 486 487 488 489
    """Helper function to declare instances' nodes for locking.

    This function should be called after locking one or more instances to lock
    their nodes. Its effect is populating self.needed_locks[locking.LEVEL_NODE]
    with all primary or secondary nodes for instances already locked and
    present in self.needed_locks[locking.LEVEL_INSTANCE].

    It should be called from DeclareLocks, and for safety only works if
    self.recalculate_locks[locking.LEVEL_NODE] is set.

    In the future it may grow parameters to just lock some instance's nodes, or
    to just lock primaries or secondary nodes, if needed.

490
    If should be called in DeclareLocks in a way similar to::
491

492 493
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
494

495 496 497
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

498 499 500 501 502 503 504 505 506 507
    """
    assert locking.LEVEL_NODE in self.recalculate_locks, \
      "_LockInstancesNodes helper function called with no nodes to recalculate"

    # TODO: check if we're really been called with the instance locks held

    # For now we'll replace self.needed_locks[locking.LEVEL_NODE], but in the
    # future we might want to have different behaviors depending on the value
    # of self.recalculate_locks[locking.LEVEL_NODE]
    wanted_nodes = []
508
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
509 510
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
511 512
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
513 514 515 516 517

    if self.recalculate_locks[locking.LEVEL_NODE] == constants.LOCKS_REPLACE:
      self.needed_locks[locking.LEVEL_NODE] = wanted_nodes
    elif self.recalculate_locks[locking.LEVEL_NODE] == constants.LOCKS_APPEND:
      self.needed_locks[locking.LEVEL_NODE].extend(wanted_nodes)
518 519 520

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
521

Iustin Pop's avatar
Iustin Pop committed
522
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
523 524 525 526 527 528 529 530 531
  """Simple LU which runs no hooks.

  This LU is intended as a parent for other LogicalUnits which will
  run no hooks, in order to reduce duplicate code.

  """
  HPATH = None
  HTYPE = None

532 533 534 535 536 537 538 539
  def BuildHooksEnv(self):
    """Empty BuildHooksEnv for NoHooksLu.

    This just raises an error.

    """
    assert False, "BuildHooksEnv called for NoHooksLUs"

Iustin Pop's avatar
Iustin Pop committed
540

541 542 543 544 545 546 547 548 549 550 551 552
class Tasklet:
  """Tasklet base class.

  Tasklets are subcomponents for LUs. LUs can consist entirely of tasklets or
  they can mix legacy code with tasklets. Locking needs to be done in the LU,
  tasklets know nothing about locks.

  Subclasses must follow these rules:
    - Implement CheckPrereq
    - Implement Exec

  """
553 554 555 556 557 558 559
  def __init__(self, lu):
    self.lu = lu

    # Shortcuts
    self.cfg = lu.cfg
    self.rpc = lu.rpc

560 561 562 563 564 565 566 567 568 569 570 571 572 573
  def CheckPrereq(self):
    """Check prerequisites for this tasklets.

    This method should check whether the prerequisites for the execution of
    this tasklet are fulfilled. It can do internode communication, but it
    should be idempotent - no cluster or system changes are allowed.

    The method should raise errors.OpPrereqError in case something is not
    fulfilled. Its return value is ignored.

    This method should also update all parameters to their canonical form if it
    hasn't been done before.

    """
574
    pass
575 576 577 578 579 580 581 582 583 584 585 586

  def Exec(self, feedback_fn):
    """Execute the tasklet.

    This method should implement the actual work. It should raise
    errors.OpExecError for failures that are somewhat dealt with in code, or
    expected.

    """
    raise NotImplementedError


587
def _GetWantedNodes(lu, nodes):
588
  """Returns list of checked and expanded node names.
589

590 591 592 593 594 595
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type nodes: list
  @param nodes: list of node names or None for all nodes
  @rtype: list
  @return: the list of nodes, sorted
Iustin Pop's avatar
Iustin Pop committed
596
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
597 598

  """
599 600 601
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
602

Iustin Pop's avatar
Iustin Pop committed
603
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
604
  return utils.NiceSort(wanted)
605 606 607


def _GetWantedInstances(lu, instances):
608
  """Returns list of checked and expanded instance names.
609

610 611 612 613 614 615 616 617
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type instances: list
  @param instances: list of instance names or None for all instances
  @rtype: list
  @return: the list of instances, sorted
  @raise errors.OpPrereqError: if the instances parameter is wrong type
  @raise errors.OpPrereqError: if any of the passed instances is not found
618 619 620

  """
  if instances:
621
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
622
  else:
623 624
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
625 626


627 628
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
629 630 631 632 633 634 635 636
  """Return the new version of a parameter dictionary.

  @type old_params: dict
  @param old_params: old parameters
  @type update_dict: dict
  @param update_dict: dict containing new parameter values, or
      constants.VALUE_DEFAULT to reset the parameter to its default
      value
637 638 639 640 641 642
  @param use_default: boolean
  @type use_default: whether to recognise L{constants.VALUE_DEFAULT}
      values as 'to be deleted' values
  @param use_none: boolean
  @type use_none: whether to recognise C{None} values as 'to be
      deleted' values
643 644 645 646 647 648
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
649 650
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
651 652 653 654 655 656 657 658 659
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


660
def _CheckOutputFields(static, dynamic, selected):
661 662
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
663
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
664
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
665
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
666
  @param dynamic: dynamic fields set
667 668

  """
Iustin Pop's avatar
Iustin Pop committed
669
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
670 671
  f.Extend(static)
  f.Extend(dynamic)
672

Iustin Pop's avatar
Iustin Pop committed
673 674
  delta = f.NonMatching(selected)
  if delta:
675
    raise errors.OpPrereqError("Unknown output fields selected: %s"
676
                               % ",".join(delta), errors.ECODE_INVAL)
677 678


679 680 681 682 683 684 685 686 687 688
def _CheckBooleanOpField(op, name):
  """Validates boolean opcode parameters.

  This will ensure that an opcode parameter is either a boolean value,
  or None (but that it always exists).

  """
  val = getattr(op, name, None)
  if not (val is None or isinstance(val, bool)):
    raise errors.OpPrereqError("Invalid boolean parameter '%s' (%s)" %
689
                               (name, str(val)), errors.ECODE_INVAL)
690 691 692
  setattr(op, name, val)


693 694 695 696 697 698 699 700 701 702 703
def _CheckGlobalHvParams(params):
  """Validates that given hypervisor params are not global ones.

  This will ensure that instances don't get customised versions of
  global params.

  """
  used_globals = constants.HVC_GLOBALS.intersection(params)
  if used_globals:
    msg = ("The following hypervisor parameters are global and cannot"
           " be customized at instance level, please modify them at"
704
           " cluster level: %s" % utils.CommaJoin(used_globals))
705 706 707
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


708 709 710 711 712
def _CheckNodeOnline(lu, node):
  """Ensure that a given node is online.

  @param lu: the LU on behalf of which we make the check
  @param node: the node to check
713
  @raise errors.OpPrereqError: if the node is offline
714 715 716

  """
  if lu.cfg.GetNodeInfo(node).offline:
717 718
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
719 720


721 722 723 724 725 726 727 728 729
def _CheckNodeNotDrained(lu, node):
  """Ensure that a given node is not drained.

  @param lu: the LU on behalf of which we make the check
  @param node: the node to check
  @raise errors.OpPrereqError: if the node is drained

  """
  if lu.cfg.GetNodeInfo(node).drained:
730 731
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
732 733


Iustin Pop's avatar
Iustin Pop committed
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
def _CheckNodeHasOS(lu, node, os_name, force_variant):
  """Ensure that a node supports a given OS.

  @param lu: the LU on behalf of which we make the check
  @param node: the node to check
  @param os_name: the OS to query about
  @param force_variant: whether to ignore variant errors
  @raise errors.OpPrereqError: if the node is not supporting the OS

  """
  result = lu.rpc.call_os_get(node, os_name)
  result.Raise("OS '%s' not in supported OS list for node %s" %
               (os_name, node),
               prereq=True, ecode=errors.ECODE_INVAL)
  if not force_variant:
    _CheckOSVariant(result.payload, os_name)


752 753 754 755 756 757 758 759 760 761 762
def _RequireFileStorage():
  """Checks that file storage is enabled.

  @raise errors.OpPrereqError: when file storage is disabled

  """
  if not constants.ENABLE_FILE_STORAGE:
    raise errors.OpPrereqError("File storage disabled at configure time",
                               errors.ECODE_INVAL)


763 764 765 766 767 768 769 770
def _CheckDiskTemplate(template):
  """Ensure a given disk template is valid.

  """
  if template not in constants.DISK_TEMPLATES:
    msg = ("Invalid disk template name '%s', valid templates are: %s" %
           (template, utils.CommaJoin(constants.DISK_TEMPLATES)))
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)
771 772 773 774 775 776 777 778 779 780
  if template == constants.DT_FILE:
    _RequireFileStorage()


def _CheckStorageType(storage_type):
  """Ensure a given storage type is valid.

  """
  if storage_type not in constants.VALID_STORAGE_TYPES:
    raise errors.OpPrereqError("Unknown storage type: %s" % storage_type,
781
                               errors.ECODE_INVAL)
782 783
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()
784
  return True
785

786

787 788 789 790 791 792 793
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

  """
  return utils.ReadOneLineFile(constants.CLUSTER_DOMAIN_SECRET_FILE,
                               strict=True)

794

795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
def _CheckInstanceDown(lu, instance, reason):
  """Ensure that an instance is not running."""
  if instance.admin_up:
    raise errors.OpPrereqError("Instance %s is marked to be up, %s" %
                               (instance.name, reason), errors.ECODE_STATE)

  pnode = instance.primary_node
  ins_l = lu.rpc.call_instance_list([pnode], [instance.hypervisor])[pnode]
  ins_l.Raise("Can't contact node %s for instance information" % pnode,
              prereq=True, ecode=errors.ECODE_ENVIRON)

  if instance.name in ins_l.payload:
    raise errors.OpPrereqError("Instance %s is running, %s" %
                               (instance.name, reason), errors.ECODE_STATE)


811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
def _ExpandItemName(fn, name, kind):
  """Expand an item name.

  @param fn: the function to use for expansion
  @param name: requested item name
  @param kind: text description ('Node' or 'Instance')
  @return: the resolved (full) name
  @raise errors.OpPrereqError: if the item is not found

  """
  full_name = fn(name)
  if full_name is None:
    raise errors.OpPrereqError("%s '%s' not known" % (kind, name),
                               errors.ECODE_NOENT)
  return full_name


def _ExpandNodeName(cfg, name):
  """Wrapper over L{_ExpandItemName} for nodes."""
  return _ExpandItemName(cfg.ExpandNodeName, name, "Node")


def _ExpandInstanceName(cfg, name):
  """Wrapper over L{_ExpandItemName} for instance."""
  return _ExpandItemName(cfg.ExpandInstanceName, name, "Instance")


838
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
839
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
840
                          bep, hvp, hypervisor_name):
841 842 843 844 845 846 847 848 849 850 851 852
  """Builds instance related env variables for hooks

  This builds the hook environment from individual variables.

  @type name: string
  @param name: the name of the instance
  @type primary_node: string
  @param primary_node: the name of the instance's primary node
  @type secondary_nodes: list
  @param secondary_nodes: list of secondary nodes as strings
  @type os_type: string
  @param os_type: the name of the instance's OS
853 854
  @type status: boolean
  @param status: the should_run status of the instance
855 856 857 858 859
  @type memory: string
  @param memory: the memory size of the instance
  @type vcpus: string
  @param vcpus: the count of VCPUs the instance has
  @type nics: list
860 861
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
862
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
863
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
864 865
  @type disks: list
  @param disks: the list of (size, mode) pairs
866 867 868 869
  @type bep: dict
  @param bep: the backend parameters for the instance
  @type hvp: dict
  @param hvp: the hypervisor parameters for the instance
Michael Hanselmann's avatar
Michael Hanselmann committed
870 871
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
872 873
  @rtype: dict
  @return: the hook environment for this instance
874

875
  """
876 877 878 879
  if status:
    str_status = "up"
  else:
    str_status = "down"
880
  env = {
881
    "OP_TARGET": name,
882 883 884
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
885
    "INSTANCE_OS_TYPE": os_type,
886
    "INSTANCE_STATUS": str_status,
887 888
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
889
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
890
    "INSTANCE_HYPERVISOR": hypervisor_name,
891 892 893 894
  }

  if nics:
    nic_count = len(nics)
895
    for idx, (ip, mac, mode, link) in enumerate(nics):
896 897 898
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
899
      env["INSTANCE_NIC%d_MAC" % idx] = mac
900 901 902 903
      env["INSTANCE_NIC%d_MODE" % idx] = mode
      env["INSTANCE_NIC%d_LINK" % idx] = link
      if mode == constants.NIC_MODE_BRIDGED:
        env["INSTANCE_NIC%d_BRIDGE" % idx] = link
904 905 906 907 908
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
909 910 911 912 913 914 915 916 917 918
  if disks:
    disk_count = len(disks)
    for idx, (size, mode) in enumerate(disks):
      env["INSTANCE_DISK%d_SIZE" % idx] = size
      env["INSTANCE_DISK%d_MODE" % idx] = mode
  else:
    disk_count = 0

  env["INSTANCE_DISK_COUNT"] = disk_count

919 920 921 922
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

923 924
  return env

925

926
def _NICListToTuple(lu, nics):
927 928
  """Build a list of nic information tuples.

929 930
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
931 932 933 934 935 936 937 938

  @type lu:  L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type nics: list of L{objects.NIC}
  @param nics: list of nics to convert to hooks tuples

  """
  hooks_nics = []
939
  cluster = lu.cfg.GetClusterInfo()
940 941 942
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
943
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
944 945 946 947
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
948

949

Iustin Pop's avatar
Iustin Pop committed
950
def _BuildInstanceHookEnvByObject(lu, instance, override=None):
951 952
  """Builds instance related env variables for hooks from an object.

953 954 955 956 957 958 959 960 961 962 963
  @type lu: L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type instance: L{objects.Instance}
  @param instance: the instance for which we should build the
      environment
  @type override: dict
  @param override: dictionary with key/values that will override
      our values
  @rtype: dict
  @return: the hook environment dictionary

964
  """
965 966 967
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
968 969 970 971
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
972
    'os_type': instance.os,
973
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
974 975
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
976
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
977 978
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
979 980
    'bep': bep,
    'hvp': hvp,
981
    'hypervisor_name': instance.hypervisor,
982 983 984
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
985
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
986 987


Guido Trotter's avatar
Guido Trotter committed
988
def _AdjustCandidatePool(lu, exceptions):
989 990 991
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
992
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
993 994
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
995
               utils.CommaJoin(node.name for node in mod_list))
996 997
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
998
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
999 1000 1001 1002 1003
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
def _DecideSelfPromotion(lu, exceptions=None):
  """Decide whether I should promote myself as a master candidate.

  """
  cp_size = lu.cfg.GetClusterInfo().candidate_pool_size
  mc_now, mc_should, _ = lu.cfg.GetMasterCandidateStats(exceptions)
  # the new node will increase mc_max with one, so:
  mc_should = min(mc_should + 1, cp_size)
  return mc_now < mc_should


1015
def _CheckNicsBridgesExist(lu, target_nics, target_node):
1016 1017 1018
  """Check that the brigdes needed by a list of nics exist.

  """
1019 1020
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
1021 1022 1023 1024
  brlist = [params[constants.NIC_LINK] for params in paramslist
            if params[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED]
  if brlist:
    result = lu.rpc.call_bridges_exist(target_node, brlist)
1025
    result.Raise("Error checking bridges on destination node '%s'" %
1026
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
1027 1028 1029


def _CheckInstanceBridgesExist(lu, instance, node=None):
1030 1031 1032
  """Check that the brigdes needed by an instance exist.

  """
1033
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
1034
    node = instance.primary_node
1035
  _CheckNicsBridgesExist(lu, instance.nics, node)
1036 1037


Iustin Pop's avatar
Iustin Pop committed
1038
def _CheckOSVariant(os_obj, name):
Guido Trotter's avatar
Guido Trotter committed
1039 1040
  """Check whether an OS name conforms to the os variants specification.

Iustin Pop's avatar
Iustin Pop committed
1041 1042
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
1043 1044 1045 1046
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
1047
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
1048 1049 1050 1051
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
1052 1053
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1054

Iustin Pop's avatar
Iustin Pop committed
1055
  if variant not in os_obj.supported_variants:
1056
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1057 1058


1059 1060 1061 1062
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


1063 1064 1065 1066 1067 1068 1069 1070
def _GetNodeInstances(cfg, node_name):
  """Returns a list of all primary and secondary instances on a node.

  """

  return _GetNodeInstancesInner(cfg, lambda inst: node_name in inst.all_nodes)


1071 1072 1073 1074
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
1075 1076
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
1077 1078


1079 1080 1081 1082
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
1083 1084
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
1085 1086


1087 1088 1089 1090 1091 1092
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
1093 1094
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
1095 1096 1097 1098

  return []


1099 1100 1101 1102 1103 1104 1105 1106
def _FindFaultyInstanceDisks(cfg, rpc, instance, node_name, prereq):
  faulty = []

  for dev in instance.disks:
    cfg.SetDiskID(dev, node_name)

  result = rpc.call_blockdev_getmirrorstatus(node_name, instance.disks)
  result.Raise("Failed to get disk status from node %s" % node_name,
1107
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
1108 1109 1110 1111 1112 1113 1114 1115

  for idx, bdev_status in enumerate(result.payload):
    if bdev_status and bdev_status.ldisk_status == constants.LDS_FAULTY:
      faulty.append(idx)

  return faulty


1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
class LUPostInitCluster(LogicalUnit):
  """Logical unit for running hooks after cluster initialization.

  """
  HPATH = "cluster-init"
  HTYPE = constants.HTYPE_CLUSTER
  _OP_REQP = []

  def BuildHooksEnv(self):
    """Build hooks env.

    """
    env = {"OP_TARGET": self.cfg.GetClusterName()}
    mn = self.cfg.GetMasterNode()
    return env, [], [mn]

  def Exec(self, feedback_fn):
    """Nothing to do.

    """
    return True


1139
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1140 1141 1142
  """Logical unit for destroying the cluster.

  """
1143 1144
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
1145 1146
  _OP_REQP = []

1147 1148 1149 1150 1151 1152 1153
  def BuildHooksEnv(self):
    """Build hooks env.

    """
    env = {"OP_TARGET": self.cfg.GetClusterName()}
    return env, [], []

Iustin Pop's avatar
Iustin Pop committed
1154 1155 1156 1157 1158
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.