cmdlib.py 359 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
from ganeti import masterd
52
from ganeti import netutils
53 54

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


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

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

  """
  return []


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

  """
  return {}


Iustin Pop's avatar
Iustin Pop committed
74 75 76 77 78 79 80 81
#: The without-default default value
_NoDefault = object()


#: The no-type (value to complex to check it in the type system)
_NoType = object()


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 167 168 169 170 171 172 173 174
# 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

Iustin Pop's avatar
Iustin Pop committed
175
#: a non-empty string
176
_TNonEmptyString = _TAnd(_TString, _TTrue)
177 178


Iustin Pop's avatar
Iustin Pop committed
179 180 181 182 183 184 185 186 187
#: a maybe non-empty string
_TMaybeString = _TOr(_TNonEmptyString, _TNone)


#: a maybe boolean (bool or none)
_TMaybeBool = _TOr(_TBool, _TNone)


#: a positive integer
188
_TPositiveInt = _TAnd(_TInt, lambda v: v >= 0)
189

Iustin Pop's avatar
Iustin Pop committed
190 191 192
#: a strictly positive integer
_TStrictPositiveInt = _TAnd(_TInt, lambda v: v > 0)

193 194 195 196 197 198

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

  """
  return _TAnd(_TList,
199
               lambda lst: compat.all(my_type(v) for v in lst))
200 201 202 203 204 205 206


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

  """
  return _TAnd(_TDict,
207 208 209
               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())))
210 211


Iustin Pop's avatar
Iustin Pop committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
# Common opcode attributes

#: output fields for a query operation
_POutputFields = ("output_fields", _NoDefault, _TListOf(_TNonEmptyString))


#: the shutdown timeout
_PShutdownTimeout = ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
                     _TPositiveInt)

#: the force parameter
_PForce = ("force", False, _TBool)

#: a required instance name (for single-instance LUs)
_PInstanceName = ("instance_name", _NoDefault, _TNonEmptyString)


#: a required node name (for single-node LUs)
_PNodeName = ("node_name", _NoDefault, _TNonEmptyString)


233
# End types
Iustin Pop's avatar
Iustin Pop committed
234
class LogicalUnit(object):
235
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
236 237

  Subclasses must follow these rules:
238
    - implement ExpandNames
239 240
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
241 242
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
243
    - optionally redefine their run requirements:
244
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
245 246

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

248 249
  @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)
Iustin Pop's avatar
Iustin Pop committed
250 251
  @cvar _OP_PARAMS: a list of opcode attributes, their defaults values
      they should get if not already defined, and types they must match
252

Iustin Pop's avatar
Iustin Pop committed
253 254 255
  """
  HPATH = None
  HTYPE = None
Iustin Pop's avatar
Iustin Pop committed
256
  _OP_PARAMS = []
257
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
258

Iustin Pop's avatar
Iustin Pop committed
259
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
260 261
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
262
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
263 264 265
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
266
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
267
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
268 269
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
270
    self.rpc = rpc
271
    # Dicts used to declare locking needs to mcpu
272
    self.needed_locks = None
273
    self.acquired_locks = {}
274
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
275 276
    self.add_locks = {}
    self.remove_locks = {}
277 278
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
279
    self.__ssh = None
280
    # logging
281
    self.Log = processor.Log # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
282 283
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
284
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
285 286
    # support for dry-run
    self.dry_run_result = None
287 288 289 290
    # 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
291

292
    # Tasklets
293
    self.tasklets = None
294

Iustin Pop's avatar
Iustin Pop committed
295 296 297
    # The new kind-of-type-system
    op_id = self.op.OP_ID
    for attr_name, aval, test in self._OP_PARAMS:
298
      if not hasattr(op, attr_name):
Iustin Pop's avatar
Iustin Pop committed
299 300 301 302 303 304 305 306 307 308 309 310 311
        if aval == _NoDefault:
          raise errors.OpPrereqError("Required parameter '%s.%s' missing" %
                                     (op_id, attr_name), errors.ECODE_INVAL)
        else:
          if callable(aval):
            dval = aval()
          else:
            dval = aval
          setattr(self.op, attr_name, dval)
      attr_val = getattr(op, attr_name)
      if test == _NoType:
        # no tests here
        continue
312
      if not callable(test):
Iustin Pop's avatar
Iustin Pop committed
313
        raise errors.ProgrammerError("Validation for parameter '%s.%s' failed,"
314
                                     " given type is not a proper type (%s)" %
Iustin Pop's avatar
Iustin Pop committed
315
                                     (op_id, attr_name, test))
316
      if not test(attr_val):
317 318
        logging.error("OpCode %s, parameter %s, has invalid type %s/value %s",
                      self.op.OP_ID, attr_name, type(attr_val), attr_val)
Iustin Pop's avatar
Iustin Pop committed
319 320
        raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
                                   (op_id, attr_name), errors.ECODE_INVAL)
321

322
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
323

324 325 326 327 328
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
329
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
330 331 332 333
    return self.__ssh

  ssh = property(fget=__GetSSH)

334 335 336 337 338 339 340 341 342
  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
343
      - CheckPrereq is run after we have acquired locks (and possible
344 345 346 347 348 349 350 351
        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

352 353 354 355 356 357 358 359 360 361 362
  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:
363 364 365 366 367

      - 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
368

Guido Trotter's avatar
Guido Trotter committed
369 370 371 372
    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.

373 374 375 376
    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.

377 378 379 380 381
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
382
        locking.LEVEL_INSTANCE: ['instance1.example.com'],
383 384 385
      }
      # Acquire just two nodes
      self.needed_locks = {
386
        locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
387 388 389
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
390 391 392 393 394 395 396 397 398 399

    """
    # 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
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
  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
418 419 420 421 422 423 424 425 426 427 428 429
  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
430
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
431 432

    """
433
    if self.tasklets is not None:
434
      for (idx, tl) in enumerate(self.tasklets):
435 436
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
437 438
        tl.CheckPrereq()
    else:
439
      pass
Iustin Pop's avatar
Iustin Pop committed
440 441 442 443 444 445 446 447 448

  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.

    """
449
    if self.tasklets is not None:
450
      for (idx, tl) in enumerate(self.tasklets):
451
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
452 453 454
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469

  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.

470
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
471 472 473 474 475 476 477

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

    """
    raise NotImplementedError

478 479 480 481 482 483 484 485 486
  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.

487 488 489 490 491 492 493 494
    @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
495 496

    """
497 498 499
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
500 501
    return lu_result

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
  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"
517 518 519
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
520

521
  def _LockInstancesNodes(self, primary_only=False):
522 523 524 525 526 527 528 529 530 531 532 533 534
    """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.

535
    If should be called in DeclareLocks in a way similar to::
536

537 538
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
539

540 541 542
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

543 544 545 546 547 548 549 550 551 552
    """
    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 = []
553
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
554 555
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
556 557
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
558 559 560 561 562

    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)
563 564 565

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
566

Iustin Pop's avatar
Iustin Pop committed
567
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
568 569 570 571 572 573 574 575 576
  """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

577 578 579 580 581 582 583 584
  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
585

586 587 588 589 590 591 592 593 594 595 596 597
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

  """
598 599 600 601 602 603 604
  def __init__(self, lu):
    self.lu = lu

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

605 606 607 608 609 610 611 612 613 614 615 616 617 618
  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.

    """
619
    pass
620 621 622 623 624 625 626 627 628 629 630 631

  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


632
def _GetWantedNodes(lu, nodes):
633
  """Returns list of checked and expanded node names.
634

635 636 637 638 639 640
  @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
641
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
642 643

  """
644 645 646
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
647

Iustin Pop's avatar
Iustin Pop committed
648
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
649
  return utils.NiceSort(wanted)
650 651 652


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

655 656 657 658 659 660 661 662
  @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
663 664 665

  """
  if instances:
666
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
667
  else:
668 669
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
670 671


672 673
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
674 675 676 677 678 679 680 681
  """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
682 683 684 685 686 687
  @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
688 689 690 691 692 693
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
694 695
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
696 697 698 699 700 701 702 703 704
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


705
def _CheckOutputFields(static, dynamic, selected):
706 707
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
708
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
709
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
710
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
711
  @param dynamic: dynamic fields set
712 713

  """
Iustin Pop's avatar
Iustin Pop committed
714
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
715 716
  f.Extend(static)
  f.Extend(dynamic)
717

Iustin Pop's avatar
Iustin Pop committed
718 719
  delta = f.NonMatching(selected)
  if delta:
720
    raise errors.OpPrereqError("Unknown output fields selected: %s"
721
                               % ",".join(delta), errors.ECODE_INVAL)
722 723


724 725 726 727 728 729 730 731 732 733 734
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"
735
           " cluster level: %s" % utils.CommaJoin(used_globals))
736 737 738
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


739 740 741 742 743
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
744
  @raise errors.OpPrereqError: if the node is offline
745 746 747

  """
  if lu.cfg.GetNodeInfo(node).offline:
748 749
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
750 751


752 753 754 755 756 757 758 759 760
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:
761 762
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
763 764


Iustin Pop's avatar
Iustin Pop committed
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
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)


783 784 785 786 787 788 789 790 791 792 793
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)


794 795 796 797 798 799 800 801
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)
802 803
  if template == constants.DT_FILE:
    _RequireFileStorage()
804
  return True
805 806 807 808 809 810 811 812


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,
813
                               errors.ECODE_INVAL)
814 815
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()
816
  return True
817

818

819 820 821 822 823 824 825
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

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

826

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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)


843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
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")


870
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
871
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
872
                          bep, hvp, hypervisor_name):
873 874 875 876 877 878 879 880 881 882 883 884
  """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
885 886
  @type status: boolean
  @param status: the should_run status of the instance
887 888 889 890 891
  @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
892 893
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
894
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
895
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
896 897
  @type disks: list
  @param disks: the list of (size, mode) pairs
898 899 900 901
  @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
902 903
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
904 905
  @rtype: dict
  @return: the hook environment for this instance
906

907
  """
908 909 910 911
  if status:
    str_status = "up"
  else:
    str_status = "down"
912
  env = {
913
    "OP_TARGET": name,
914 915 916
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
917
    "INSTANCE_OS_TYPE": os_type,
918
    "INSTANCE_STATUS": str_status,
919 920
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
921
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
922
    "INSTANCE_HYPERVISOR": hypervisor_name,
923 924 925 926
  }

  if nics:
    nic_count = len(nics)
927
    for idx, (ip, mac, mode, link) in enumerate(nics):
928 929 930
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
931
      env["INSTANCE_NIC%d_MAC" % idx] = mac
932 933 934 935
      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
936 937 938 939 940
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
941 942 943 944 945 946 947 948 949 950
  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

951 952 953 954
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

955 956
  return env

957

958
def _NICListToTuple(lu, nics):
959 960
  """Build a list of nic information tuples.

961 962
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
963 964 965 966 967 968 969 970

  @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 = []
971
  cluster = lu.cfg.GetClusterInfo()
972 973 974
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
975
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
976 977 978 979
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
980

981

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

985 986 987 988 989 990 991 992 993 994 995
  @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

996
  """
997 998 999
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
1000 1001 1002 1003
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
1004
    'os_type': instance.os,
1005
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
1006 1007
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
1008
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
1009 1010
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
1011 1012
    'bep': bep,
    'hvp': hvp,
1013
    'hypervisor_name': instance.hypervisor,
1014 1015 1016
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
1017
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
1018 1019


Guido Trotter's avatar
Guido Trotter committed
1020
def _AdjustCandidatePool(lu, exceptions):
1021 1022 1023
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
1024
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
1025 1026
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
1027
               utils.CommaJoin(node.name for node in mod_list))
1028 1029
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
1030
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
1031 1032 1033 1034 1035
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
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


1047
def _CheckNicsBridgesExist(lu, target_nics, target_node):
1048 1049 1050
  """Check that the brigdes needed by a list of nics exist.

  """
1051 1052
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
1053 1054 1055 1056
  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)
1057
    result.Raise("Error checking bridges on destination node '%s'" %
1058
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
1059 1060 1061


def _CheckInstanceBridgesExist(lu, instance, node=None):
1062 1063 1064
  """Check that the brigdes needed by an instance exist.

  """
1065
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
1066
    node = instance.primary_node
1067
  _CheckNicsBridgesExist(lu, instance.nics, node)
1068 1069


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

Iustin Pop's avatar
Iustin Pop committed
1073 1074
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
1075 1076 1077 1078
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
1079
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
1080 1081 1082 1083
    return
  try:
    variant = name.split("+", 1)[1]
  except IndexError:
1084 1085
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1086

Iustin Pop's avatar
Iustin Pop committed
1087
  if variant not in os_obj.supported_variants:
1088
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1089 1090


1091 1092 1093 1094
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


1095 1096 1097 1098 1099 1100 1101 1102
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)


1103 1104 1105 1106
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
1107 1108
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
1109 1110


1111 1112 1113 1114
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
1115 1116
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
1117 1118


1119 1120 1121 1122 1123 1124
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
1125 1126
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
1127 1128 1129 1130

  return []


1131 1132 1133 1134 1135 1136 1137 1138
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,
1139
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
1140 1141 1142 1143 1144 1145 1146 1147

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

  return faulty


1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
def _CheckIAllocatorOrNode(lu, iallocator_slot, node_slot):
  """Check the sanity of iallocator and node arguments and use the
  cluster-wide iallocator if appropriate.

  Check that at most one of (iallocator, node) is specified. If none is
  specified, then the LU's opcode's iallocator slot is filled with the
  cluster-wide default iallocator.

  @type iallocator_slot: string
  @param iallocator_slot: the name of the opcode iallocator slot
  @type node_slot: string
  @param node_slot: the name of the opcode target node slot

  """
  node = getattr(lu.op, node_slot, None)
  iallocator = getattr(lu.op, iallocator_slot, None)

  if node is not None and iallocator is not None:
    raise errors.OpPrereqError("Do not specify both, iallocator and node.",
                               errors.ECODE_INVAL)
  elif node is None and iallocator is None:
    default_iallocator = lu.cfg.GetDefaultIAllocator()
    if default_iallocator:
      setattr(lu.op, iallocator_slot, default_iallocator)
    else:
      raise errors.OpPrereqError("No iallocator or node given and no"
                                 " cluster-wide default iallocator found."
                                 " Please specify either an iallocator or a"
                                 " node, or set a cluster-wide default"
                                 " iallocator.")


1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
class LUPostInitCluster(LogicalUnit):
  """Logical unit for running hooks after cluster initialization.

  """
  HPATH = "cluster-init"
  HTYPE = constants.HTYPE_CLUSTER

  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


1202
class LUDestroyCluster(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1203 1204 1205
  """Logical unit for destroying the cluster.

  """
1206 1207
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
1208

1209 1210 1211 1212 1213 1214 1215
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
1216 1217 1218 1219 1220
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
1221
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
1222 1223

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1224
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
1225 1226

    nodelist = self.cfg.GetNodeList()
1227
    if len(nodelist) != 1 or nodelist[0] != master:
1228
      raise errors.OpPrereqError("There are still %d node(s) in"
1229 1230
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
1231 1232
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
1233
      raise errors.OpPrereqError("There are still %d instance(s) in"
1234 1235
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
1236 1237 1238 1239 1240

  def Exec(self, feedback_fn):
    """Destroys the cluster.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1241
    master = self.cfg.GetMasterNode()
1242
    modify_ssh_setup = self.cfg.GetClusterInfo().modify_ssh_setup
Luca Bigliardi's avatar
Luca Bigliardi committed
1243 1244 1245 1246 1247 1248

    # Run post hooks on master node before it's removed
    hm = self.proc.hmclass(self.rpc.call_hooks_runner, self)
    try:
      hm.RunPhase(constants.HOOKS_PHASE_POST, [master])
    except:
Iustin Pop's avatar
Iustin Pop committed
1249
      # pylint: disable-msg=W0702
Luca Bigliardi's avatar
Luca Bigliardi committed
1250 1251
      self.LogWarning("Errors occurred running hooks on %s" % master)

1252
    result = self.rpc.call_node_stop_master(master, False)