cmdlib.py 389 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
from ganeti import ht
57 58
from ganeti import query
from ganeti import qlang
59 60

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

Iustin Pop's avatar
Iustin Pop committed
62 63 64
# Common opcode attributes

#: output fields for a query operation
65
_POutputFields = ("output_fields", ht.NoDefault, ht.TListOf(ht.TNonEmptyString))
Iustin Pop's avatar
Iustin Pop committed
66 67 68 69


#: the shutdown timeout
_PShutdownTimeout = ("shutdown_timeout", constants.DEFAULT_SHUTDOWN_TIMEOUT,
70
                     ht.TPositiveInt)
Iustin Pop's avatar
Iustin Pop committed
71 72

#: the force parameter
73
_PForce = ("force", False, ht.TBool)
Iustin Pop's avatar
Iustin Pop committed
74 75

#: a required instance name (for single-instance LUs)
76
_PInstanceName = ("instance_name", ht.NoDefault, ht.TNonEmptyString)
Iustin Pop's avatar
Iustin Pop committed
77

78 79
#: Whether to ignore offline nodes
_PIgnoreOfflineNodes = ("ignore_offline_nodes", False, ht.TBool)
Iustin Pop's avatar
Iustin Pop committed
80 81

#: a required node name (for single-node LUs)
82
_PNodeName = ("node_name", ht.NoDefault, ht.TNonEmptyString)
Iustin Pop's avatar
Iustin Pop committed
83

84
#: the migration type (live/non-live)
85 86
_PMigrationMode = ("mode", None,
                   ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)))
87

88
#: the obsolete 'live' mode (boolean)
89
_PMigrationLive = ("live", None, ht.TMaybeBool)
90

Iustin Pop's avatar
Iustin Pop committed
91

92
# End types
Iustin Pop's avatar
Iustin Pop committed
93
class LogicalUnit(object):
94
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
95 96

  Subclasses must follow these rules:
97
    - implement ExpandNames
98 99
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
100 101
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
102
    - optionally redefine their run requirements:
103
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
104 105

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

107 108
  @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
109 110
  @cvar _OP_PARAMS: a list of opcode attributes, their defaults values
      they should get if not already defined, and types they must match
111

Iustin Pop's avatar
Iustin Pop committed
112 113 114
  """
  HPATH = None
  HTYPE = None
Iustin Pop's avatar
Iustin Pop committed
115
  _OP_PARAMS = []
116
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
117

Iustin Pop's avatar
Iustin Pop committed
118
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
119 120
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
121
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
122 123 124
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
125
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
126
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
127 128
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
129
    self.rpc = rpc
130
    # Dicts used to declare locking needs to mcpu
131
    self.needed_locks = None
132
    self.acquired_locks = {}
133
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
134 135
    self.add_locks = {}
    self.remove_locks = {}
136 137
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
138
    self.__ssh = None
139
    # logging
140
    self.Log = processor.Log # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
141 142
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
143
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
144 145
    # support for dry-run
    self.dry_run_result = None
146 147 148 149
    # 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
150

151
    # Tasklets
152
    self.tasklets = None
153

Iustin Pop's avatar
Iustin Pop committed
154 155 156
    # The new kind-of-type-system
    op_id = self.op.OP_ID
    for attr_name, aval, test in self._OP_PARAMS:
157
      if not hasattr(op, attr_name):
158
        if aval == ht.NoDefault:
Iustin Pop's avatar
Iustin Pop committed
159 160 161 162 163 164 165 166 167
          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)
168
      if test == ht.NoType:
Iustin Pop's avatar
Iustin Pop committed
169 170
        # no tests here
        continue
171
      if not callable(test):
Iustin Pop's avatar
Iustin Pop committed
172
        raise errors.ProgrammerError("Validation for parameter '%s.%s' failed,"
173
                                     " given type is not a proper type (%s)" %
Iustin Pop's avatar
Iustin Pop committed
174
                                     (op_id, attr_name, test))
175
      if not test(attr_val):
176 177
        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
178 179
        raise errors.OpPrereqError("Parameter '%s.%s' fails validation" %
                                   (op_id, attr_name), errors.ECODE_INVAL)
180

181
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
182

183 184 185 186 187
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
188
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
189 190 191 192
    return self.__ssh

  ssh = property(fget=__GetSSH)

193 194 195 196 197 198 199 200 201
  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
202
      - CheckPrereq is run after we have acquired locks (and possible
203 204 205 206 207 208 209 210
        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

211 212 213 214 215 216 217 218 219 220 221
  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:
222 223 224 225 226

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

Guido Trotter's avatar
Guido Trotter committed
228 229 230 231
    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.

232 233 234 235
    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.

236 237 238 239 240
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
241
        locking.LEVEL_INSTANCE: ['instance1.example.com'],
242 243 244
      }
      # Acquire just two nodes
      self.needed_locks = {
245
        locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
246 247 248
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
249 250 251 252 253 254 255 256 257 258

    """
    # 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
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
  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
277 278 279 280 281 282 283 284 285 286 287 288
  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
289
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
290 291

    """
292
    if self.tasklets is not None:
293
      for (idx, tl) in enumerate(self.tasklets):
294 295
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
296 297
        tl.CheckPrereq()
    else:
298
      pass
Iustin Pop's avatar
Iustin Pop committed
299 300 301 302 303 304 305 306 307

  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.

    """
308
    if self.tasklets is not None:
309
      for (idx, tl) in enumerate(self.tasklets):
310
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
311 312 313
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328

  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.

329
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
330 331 332 333 334 335 336

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

    """
    raise NotImplementedError

337 338 339 340 341 342 343 344 345
  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.

346 347 348 349 350 351 352 353
    @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
354 355

    """
356 357 358
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
359 360
    return lu_result

361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
  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"
376 377 378
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
379

380
  def _LockInstancesNodes(self, primary_only=False):
381 382 383 384 385 386 387 388 389 390 391 392 393
    """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.

394
    If should be called in DeclareLocks in a way similar to::
395

396 397
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
398

399 400 401
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

402 403 404 405 406 407 408 409 410 411
    """
    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 = []
412
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
413 414
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
415 416
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
417 418 419 420 421

    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)
422 423 424

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
425

Iustin Pop's avatar
Iustin Pop committed
426
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
427 428 429 430 431 432 433 434 435
  """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

436 437 438 439 440 441 442 443
  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
444

445 446 447 448 449 450 451 452 453 454 455 456
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

  """
457 458 459 460 461 462 463
  def __init__(self, lu):
    self.lu = lu

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

464 465 466 467 468 469 470 471 472 473 474 475 476 477
  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.

    """
478
    pass
479 480 481 482 483 484 485 486 487 488 489 490

  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


491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
class _QueryBase:
  """Base for query utility classes.

  """
  #: Attribute holding field definitions
  FIELDS = None

  def __init__(self, names, fields, use_locking):
    """Initializes this class.

    """
    self.names = names
    self.use_locking = use_locking

    self.query = query.Query(self.FIELDS, fields)
    self.requested_data = self.query.RequestedData()

  @classmethod
  def FieldsQuery(cls, fields):
    """Returns list of available fields.

    @return: List of L{objects.QueryFieldDefinition}

    """
    if fields is None:
      # Client requests all fields
      fdefs = query.GetAllFields(cls.FIELDS.values())
    else:
      fdefs = query.Query(cls.FIELDS, fields).GetFields()

    return {
      "fields": [fdef.ToDict() for fdef in fdefs],
      }

  def ExpandNames(self, lu):
    """Expand names for this query.

    See L{LogicalUnit.ExpandNames}.

    """
    raise NotImplementedError()

  def DeclareLocks(self, level):
    """Declare locks for this query.

    See L{LogicalUnit.DeclareLocks}.

    """
    raise NotImplementedError()

  def _GetQueryData(self, lu):
    """Collects all data for this query.

    @return: Query data object

    """
    raise NotImplementedError()

  def NewStyleQuery(self, lu):
    """Collect data and execute query.

    """
    data = self._GetQueryData(lu)

    return {
      "data": self.query.Query(data),
      "fields": [fdef.ToDict()
                 for fdef in self.query.GetFields()],
      }

  def OldStyleQuery(self, lu):
    """Collect data and execute query.

    """
    return self.query.OldStyleQuery(self._GetQueryData(lu))


568
def _GetWantedNodes(lu, nodes):
569
  """Returns list of checked and expanded node names.
570

571 572 573 574 575 576
  @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
577
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
578 579

  """
580 581 582
  if not nodes:
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
      " non-empty list of nodes whose name is to be expanded.")
583

Iustin Pop's avatar
Iustin Pop committed
584
  wanted = [_ExpandNodeName(lu.cfg, name) for name in nodes]
585
  return utils.NiceSort(wanted)
586 587 588


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

591 592 593 594 595 596 597 598
  @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
599 600 601

  """
  if instances:
602
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
603
  else:
604 605
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
606 607


608 609
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
610 611 612 613 614 615 616 617
  """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
618 619 620 621 622 623
  @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
624 625 626 627 628 629
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
630 631
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
632 633 634 635 636 637 638 639 640
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


641
def _CheckOutputFields(static, dynamic, selected):
642 643
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
644
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
645
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
646
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
647
  @param dynamic: dynamic fields set
648 649

  """
Iustin Pop's avatar
Iustin Pop committed
650
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
651 652
  f.Extend(static)
  f.Extend(dynamic)
653

Iustin Pop's avatar
Iustin Pop committed
654 655
  delta = f.NonMatching(selected)
  if delta:
656
    raise errors.OpPrereqError("Unknown output fields selected: %s"
657
                               % ",".join(delta), errors.ECODE_INVAL)
658 659


660 661 662 663 664 665 666 667 668 669 670
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"
671
           " cluster level: %s" % utils.CommaJoin(used_globals))
672 673 674
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


675
def _CheckNodeOnline(lu, node, msg=None):
676 677 678 679
  """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
680
  @param msg: if passed, should be a message to replace the default one
681
  @raise errors.OpPrereqError: if the node is offline
682 683

  """
684 685
  if msg is None:
    msg = "Can't use offline node"
686
  if lu.cfg.GetNodeInfo(node).offline:
687
    raise errors.OpPrereqError("%s: %s" % (msg, node), errors.ECODE_STATE)
688 689


690 691 692 693 694 695 696 697 698
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:
699
    raise errors.OpPrereqError("Can't use drained node %s" % node,
700 701 702 703 704 705 706 707 708 709 710 711 712 713
                               errors.ECODE_STATE)


def _CheckNodeVmCapable(lu, node):
  """Ensure that a given node is vm capable.

  @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 not vm capable

  """
  if not lu.cfg.GetNodeInfo(node).vm_capable:
    raise errors.OpPrereqError("Can't use non-vm_capable node %s" % node,
                               errors.ECODE_STATE)
714 715


Iustin Pop's avatar
Iustin Pop committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
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)


734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
def _CheckNodeHasSecondaryIP(lu, node, secondary_ip, prereq):
  """Ensure that a node has the given secondary ip.

  @type lu: L{LogicalUnit}
  @param lu: the LU on behalf of which we make the check
  @type node: string
  @param node: the node to check
  @type secondary_ip: string
  @param secondary_ip: the ip to check
  @type prereq: boolean
  @param prereq: whether to throw a prerequisite or an execute error
  @raise errors.OpPrereqError: if the node doesn't have the ip, and prereq=True
  @raise errors.OpExecError: if the node doesn't have the ip, and prereq=False

  """
  result = lu.rpc.call_node_has_ip_address(node, secondary_ip)
  result.Raise("Failure checking secondary ip on node %s" % node,
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
  if not result.payload:
    msg = ("Node claims it doesn't have the secondary ip you gave (%s),"
           " please fix and re-run this command" % secondary_ip)
    if prereq:
      raise errors.OpPrereqError(msg, errors.ECODE_ENVIRON)
    else:
      raise errors.OpExecError(msg)


761 762 763 764 765 766 767 768 769 770 771
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)


772 773 774 775 776 777 778 779
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)
780 781
  if template == constants.DT_FILE:
    _RequireFileStorage()
782
  return True
783 784 785 786 787 788 789 790


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,
791
                               errors.ECODE_INVAL)
792 793
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()
794
  return True
795

796

797 798 799 800 801 802 803
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

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

804

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


821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
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")


848
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
849
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
850
                          bep, hvp, hypervisor_name):
851 852 853 854 855 856 857 858 859 860 861 862
  """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
863 864
  @type status: boolean
  @param status: the should_run status of the instance
865 866 867 868 869
  @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
870 871
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
872
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
873
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
874 875
  @type disks: list
  @param disks: the list of (size, mode) pairs
876 877 878 879
  @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
880 881
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
882 883
  @rtype: dict
  @return: the hook environment for this instance
884

885
  """
886 887 888 889
  if status:
    str_status = "up"
  else:
    str_status = "down"
890
  env = {
891
    "OP_TARGET": name,
892 893 894
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
895
    "INSTANCE_OS_TYPE": os_type,
896
    "INSTANCE_STATUS": str_status,
897 898
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
899
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
900
    "INSTANCE_HYPERVISOR": hypervisor_name,
901 902 903 904
  }

  if nics:
    nic_count = len(nics)
905
    for idx, (ip, mac, mode, link) in enumerate(nics):
906 907 908
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
909
      env["INSTANCE_NIC%d_MAC" % idx] = mac
910 911 912 913
      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
914 915 916 917 918
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
919 920 921 922 923 924 925 926 927 928
  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

929 930 931 932
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

933 934
  return env

935

936
def _NICListToTuple(lu, nics):
937 938
  """Build a list of nic information tuples.

939 940
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
941 942 943 944 945 946 947 948

  @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 = []
949
  cluster = lu.cfg.GetClusterInfo()
950 951 952
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
953
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
954 955 956 957
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
958

959

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

963 964 965 966 967 968 969 970 971 972 973
  @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

974
  """
975 976 977
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
978 979 980 981
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
982
    'os_type': instance.os,
983
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
984 985
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
986
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
987 988
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
989 990
    'bep': bep,
    'hvp': hvp,
991
    'hypervisor_name': instance.hypervisor,
992 993 994
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
995
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
996 997


Guido Trotter's avatar
Guido Trotter committed
998
def _AdjustCandidatePool(lu, exceptions):
999 1000 1001
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
1002
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
1003 1004
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
1005
               utils.CommaJoin(node.name for node in mod_list))
1006 1007
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
1008
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
1009 1010 1011 1012 1013
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
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


1025
def _CheckNicsBridgesExist(lu, target_nics, target_node):
1026 1027 1028
  """Check that the brigdes needed by a list of nics exist.

  """
1029 1030
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
1031 1032 1033 1034
  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)
1035
    result.Raise("Error checking bridges on destination node '%s'" %
1036
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
1037 1038 1039


def _CheckInstanceBridgesExist(lu, instance, node=None):
1040 1041 1042
  """Check that the brigdes needed by an instance exist.

  """
1043
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
1044
    node = instance.primary_node
1045
  _CheckNicsBridgesExist(lu, instance.nics, node)
1046 1047


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

Iustin Pop's avatar
Iustin Pop committed
1051 1052
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
1053 1054 1055 1056
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
1057
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
1058
    return
1059 1060
  variant = objects.OS.GetVariant(name)
  if not variant:
1061 1062
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1063

Iustin Pop's avatar
Iustin Pop committed
1064
  if variant not in os_obj.supported_variants:
1065
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1066 1067


1068 1069 1070 1071
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


1072 1073 1074 1075 1076 1077 1078 1079
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)


1080 1081 1082 1083
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
1084 1085
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
1086 1087