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

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


22
"""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
39 40 41
import socket
import tempfile
import shutil
Iustin Pop's avatar
Iustin Pop committed
42 43 44 45 46

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
47
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
48 49
from ganeti import constants
from ganeti import objects
50
from ganeti import serializer
51
from ganeti import ssconf
52
from ganeti import uidpool
53
from ganeti import compat
54
from ganeti import masterd
55
from ganeti import netutils
56 57

import ganeti.masterd.instance # pylint: disable-msg=W0611
58 59


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

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

  """
  return []


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

  """
  return {}


Iustin Pop's avatar
Iustin Pop committed
77 78 79 80 81 82 83 84
#: The without-default default value
_NoDefault = object()


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


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
# 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)


Iustin Pop's avatar
Iustin Pop committed
157 158 159 160 161 162 163
def _TIsLength(size):
  """Check is the given container is of the given size.

  """
  return lambda container: len(container) == size


164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
# 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


Iustin Pop's avatar
Iustin Pop committed
183 184 185 186 187 188 189
def _TMap(fn, test):
  """Checks that a modified version of the argument passes the given test.

  """
  return lambda val: test(fn(val))


190 191
# Type aliases

Iustin Pop's avatar
Iustin Pop committed
192
#: a non-empty string
193
_TNonEmptyString = _TAnd(_TString, _TTrue)
194 195


Iustin Pop's avatar
Iustin Pop committed
196 197 198 199 200 201 202 203 204
#: a maybe non-empty string
_TMaybeString = _TOr(_TNonEmptyString, _TNone)


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


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

Iustin Pop's avatar
Iustin Pop committed
207 208 209
#: a strictly positive integer
_TStrictPositiveInt = _TAnd(_TInt, lambda v: v > 0)

210 211 212 213 214 215

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

  """
  return _TAnd(_TList,
216
               lambda lst: compat.all(my_type(v) for v in lst))
217 218 219 220 221 222 223


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

  """
  return _TAnd(_TDict,
224 225 226
               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())))
227 228


Iustin Pop's avatar
Iustin Pop committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
# 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)

249
#: the migration type (live/non-live)
250
_PMigrationMode = ("mode", None, _TOr(_TNone,
251
                                      _TElemOf(constants.HT_MIGRATION_MODES)))
252

253 254 255
#: the obsolete 'live' mode (boolean)
_PMigrationLive = ("live", None, _TMaybeBool)

Iustin Pop's avatar
Iustin Pop committed
256

257
# End types
Iustin Pop's avatar
Iustin Pop committed
258
class LogicalUnit(object):
259
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
260 261

  Subclasses must follow these rules:
262
    - implement ExpandNames
263 264
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
265 266
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
267
    - optionally redefine their run requirements:
268
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
269 270

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

272 273
  @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
274 275
  @cvar _OP_PARAMS: a list of opcode attributes, their defaults values
      they should get if not already defined, and types they must match
276

Iustin Pop's avatar
Iustin Pop committed
277 278 279
  """
  HPATH = None
  HTYPE = None
Iustin Pop's avatar
Iustin Pop committed
280
  _OP_PARAMS = []
281
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
282

Iustin Pop's avatar
Iustin Pop committed
283
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
284 285
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
286
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
287 288 289
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
290
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
291
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
292 293
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
294
    self.rpc = rpc
295
    # Dicts used to declare locking needs to mcpu
296
    self.needed_locks = None
297
    self.acquired_locks = {}
298
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
299 300
    self.add_locks = {}
    self.remove_locks = {}
301 302
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
303
    self.__ssh = None
304
    # logging
305
    self.Log = processor.Log # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
306 307
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
308
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
309 310
    # support for dry-run
    self.dry_run_result = None
311 312 313 314
    # 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
315

316
    # Tasklets
317
    self.tasklets = None
318

Iustin Pop's avatar
Iustin Pop committed
319 320 321
    # The new kind-of-type-system
    op_id = self.op.OP_ID
    for attr_name, aval, test in self._OP_PARAMS:
322
      if not hasattr(op, attr_name):
Iustin Pop's avatar
Iustin Pop committed
323 324 325 326 327 328 329 330 331 332 333 334 335
        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
336
      if not callable(test):
Iustin Pop's avatar
Iustin Pop committed
337
        raise errors.ProgrammerError("Validation for parameter '%s.%s' failed,"
338
                                     " given type is not a proper type (%s)" %
Iustin Pop's avatar
Iustin Pop committed
339
                                     (op_id, attr_name, test))
340
      if not test(attr_val):
341 342
        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
343 344
        raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
                                   (op_id, attr_name), errors.ECODE_INVAL)
345

346
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
347

348 349 350 351 352
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
353
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
354 355 356 357
    return self.__ssh

  ssh = property(fget=__GetSSH)

358 359 360 361 362 363 364 365 366
  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
367
      - CheckPrereq is run after we have acquired locks (and possible
368 369 370 371 372 373 374 375
        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

376 377 378 379 380 381 382 383 384 385 386
  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:
387 388 389 390 391

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

Guido Trotter's avatar
Guido Trotter committed
393 394 395 396
    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.

397 398 399 400
    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.

401 402 403 404 405
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
406
        locking.LEVEL_INSTANCE: ['instance1.example.com'],
407 408 409
      }
      # Acquire just two nodes
      self.needed_locks = {
410
        locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
411 412 413
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
414 415 416 417 418 419 420 421 422 423

    """
    # 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
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
  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
442 443 444 445 446 447 448 449 450 451 452 453
  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
454
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
455 456

    """
457
    if self.tasklets is not None:
458
      for (idx, tl) in enumerate(self.tasklets):
459 460
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
461 462
        tl.CheckPrereq()
    else:
463
      pass
Iustin Pop's avatar
Iustin Pop committed
464 465 466 467 468 469 470 471 472

  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.

    """
473
    if self.tasklets is not None:
474
      for (idx, tl) in enumerate(self.tasklets):
475
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
476 477 478
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493

  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.

494
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
495 496 497 498 499 500 501

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

    """
    raise NotImplementedError

502 503 504 505 506 507 508 509 510
  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.

511 512 513 514 515 516 517 518
    @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
519 520

    """
521 522 523
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
524 525
    return lu_result

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  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"
541 542 543
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
544

545
  def _LockInstancesNodes(self, primary_only=False):
546 547 548 549 550 551 552 553 554 555 556 557 558
    """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.

559
    If should be called in DeclareLocks in a way similar to::
560

561 562
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
563

564 565 566
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

567 568 569 570 571 572 573 574 575 576
    """
    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 = []
577
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
578 579
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
580 581
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
582 583 584 585 586

    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)
587 588 589

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
590

Iustin Pop's avatar
Iustin Pop committed
591
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
592 593 594 595 596 597 598 599 600
  """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

601 602 603 604 605 606 607 608
  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
609

610 611 612 613 614 615 616 617 618 619 620 621
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

  """
622 623 624 625 626 627 628
  def __init__(self, lu):
    self.lu = lu

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

629 630 631 632 633 634 635 636 637 638 639 640 641 642
  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.

    """
643
    pass
644 645 646 647 648 649 650 651 652 653 654 655

  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


656
def _GetWantedNodes(lu, nodes):
657
  """Returns list of checked and expanded node names.
658

659 660 661 662 663 664
  @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
665
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
666 667

  """
668 669 670
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
671

Iustin Pop's avatar
Iustin Pop committed
672
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
673
  return utils.NiceSort(wanted)
674 675 676


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

679 680 681 682 683 684 685 686
  @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
687 688 689

  """
  if instances:
690
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
691
  else:
692 693
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
694 695


696 697
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
698 699 700 701 702 703 704 705
  """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
706 707 708 709 710 711
  @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
712 713 714 715 716 717
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
718 719
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
720 721 722 723 724 725 726 727 728
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


729
def _CheckOutputFields(static, dynamic, selected):
730 731
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
732
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
733
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
734
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
735
  @param dynamic: dynamic fields set
736 737

  """
Iustin Pop's avatar
Iustin Pop committed
738
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
739 740
  f.Extend(static)
  f.Extend(dynamic)
741

Iustin Pop's avatar
Iustin Pop committed
742 743
  delta = f.NonMatching(selected)
  if delta:
744
    raise errors.OpPrereqError("Unknown output fields selected: %s"
745
                               % ",".join(delta), errors.ECODE_INVAL)
746 747


748 749 750 751 752 753 754 755 756 757 758
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"
759
           " cluster level: %s" % utils.CommaJoin(used_globals))
760 761 762
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


763 764 765 766 767
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
768
  @raise errors.OpPrereqError: if the node is offline
769 770 771

  """
  if lu.cfg.GetNodeInfo(node).offline:
772 773
    raise errors.OpPrereqError("Can't use offline node %s" % node,
                               errors.ECODE_INVAL)
774 775


776 777 778 779 780 781 782 783 784
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:
785 786
    raise errors.OpPrereqError("Can't use drained node %s" % node,
                               errors.ECODE_INVAL)
787 788


Iustin Pop's avatar
Iustin Pop committed
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
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)


807 808 809 810 811 812 813 814 815 816 817
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)


818 819 820 821 822 823 824 825
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)
826 827
  if template == constants.DT_FILE:
    _RequireFileStorage()
828
  return True
829 830 831 832 833 834 835 836


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,
837
                               errors.ECODE_INVAL)
838 839
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()
840
  return True
841

842

843 844 845 846 847 848 849
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

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

850

851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
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)


867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
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")


894
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
895
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
896
                          bep, hvp, hypervisor_name):
897 898 899 900 901 902 903 904 905 906 907 908
  """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
909 910
  @type status: boolean
  @param status: the should_run status of the instance
911 912 913 914 915
  @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
916 917
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
918
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
919
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
920 921
  @type disks: list
  @param disks: the list of (size, mode) pairs
922 923 924 925
  @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
926 927
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
928 929
  @rtype: dict
  @return: the hook environment for this instance
930

931
  """
932 933 934 935
  if status:
    str_status = "up"
  else:
    str_status = "down"
936
  env = {
937
    "OP_TARGET": name,
938 939 940
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
941
    "INSTANCE_OS_TYPE": os_type,
942
    "INSTANCE_STATUS": str_status,
943 944
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
945
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
946
    "INSTANCE_HYPERVISOR": hypervisor_name,
947 948 949 950
  }

  if nics:
    nic_count = len(nics)
951
    for idx, (ip, mac, mode, link) in enumerate(nics):
952 953 954
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
955
      env["INSTANCE_NIC%d_MAC" % idx] = mac
956 957 958 959
      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
960 961 962 963 964
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
965 966 967 968 969 970 971 972 973 974
  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

975 976 977 978
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

979 980
  return env

981

982
def _NICListToTuple(lu, nics):
983 984
  """Build a list of nic information tuples.

985 986
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
987 988 989 990 991 992 993 994

  @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 = []
995
  cluster = lu.cfg.GetClusterInfo()
996 997 998
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
999
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
1000 1001 1002 1003
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
1004

1005

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

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
  @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

1020
  """
1021 1022 1023
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
1024 1025 1026 1027
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
1028
    'os_type': instance.os,
1029
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
1030 1031
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
1032
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
1033 1034
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
1035 1036
    'bep': bep,
    'hvp': hvp,
1037
    'hypervisor_name': instance.hypervisor,
1038 1039 1040
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
1041
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
1042 1043


Guido Trotter's avatar
Guido Trotter committed
1044
def _AdjustCandidatePool(lu, exceptions):
1045 1046 1047
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
1048
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
1049 1050
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
1051
               utils.CommaJoin(node.name for node in mod_list))
1052 1053
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
1054
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
1055 1056 1057 1058 1059
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
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


1071
def _CheckNicsBridgesExist(lu, target_nics, target_node):
1072 1073 1074
  """Check that the brigdes needed by a list of nics exist.

  """
1075 1076
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
1077 1078 1079 1080
  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)
1081
    result.Raise("Error checking bridges on destination node '%s'" %
1082
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
1083 1084 1085


def _CheckInstanceBridgesExist(lu, instance, node=None):
1086 1087 1088
  """Check that the brigdes needed by an instance exist.

  """
1089
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
1090
    node = instance.primary_node
1091
  _CheckNicsBridgesExist(lu, instance.nics, node)
1092 1093


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

Iustin Pop's avatar
Iustin Pop committed
1097 1098
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
1099 1100 1101 1102
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
1103
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
1104
    return
1105 1106
  variant = objects.OS.GetVariant(name)
  if not variant:
1107 1108
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1109

Iustin Pop's avatar
Iustin Pop committed
1110
  if variant not in os_obj.supported_variants:
1111
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1112 1113


1114 1115 1116 1117
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


1118 1119 1120 1121 1122 1123 1124 1125
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)


1126