cmdlib.py 398 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
42
import operator
43
import itertools
Iustin Pop's avatar
Iustin Pop committed
44 45 46 47 48

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
49
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
50 51
from ganeti import constants
from ganeti import objects
52
from ganeti import serializer
53
from ganeti import ssconf
54
from ganeti import uidpool
55
from ganeti import compat
56
from ganeti import masterd
57
from ganeti import netutils
58
from ganeti import ht
59 60
from ganeti import query
from ganeti import qlang
61 62

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

Iustin Pop's avatar
Iustin Pop committed
64 65 66
# Common opcode attributes

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


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

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

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

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

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

86 87 88
#: a required node group name (for single-group LUs)
_PGroupName = ("group_name", ht.NoDefault, ht.TNonEmptyString)

89
#: the migration type (live/non-live)
90 91
_PMigrationMode = ("mode", None,
                   ht.TOr(ht.TNone, ht.TElemOf(constants.HT_MIGRATION_MODES)))
92

93
#: the obsolete 'live' mode (boolean)
94
_PMigrationLive = ("live", None, ht.TMaybeBool)
95

Iustin Pop's avatar
Iustin Pop committed
96

97
# End types
Iustin Pop's avatar
Iustin Pop committed
98
class LogicalUnit(object):
99
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
100 101

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

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

112 113
  @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)
114
  @cvar _OP_PARAMS: a list of opcode attributes, the default values
Iustin Pop's avatar
Iustin Pop committed
115
      they should get if not already defined, and types they must match
116

Iustin Pop's avatar
Iustin Pop committed
117 118 119
  """
  HPATH = None
  HTYPE = None
Iustin Pop's avatar
Iustin Pop committed
120
  _OP_PARAMS = []
121
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
122

Iustin Pop's avatar
Iustin Pop committed
123
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
124 125
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
126
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
127 128 129
    validity.

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

156
    # Tasklets
157
    self.tasklets = None
158

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

186
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
187

188 189 190 191 192
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
193
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
194 195 196 197
    return self.__ssh

  ssh = property(fget=__GetSSH)

198 199 200 201 202 203 204 205 206
  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
207
      - CheckPrereq is run after we have acquired locks (and possible
208 209 210 211 212 213 214 215
        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

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
Adeodato Simo's avatar
Adeodato Simo committed
222
    completed). This way locking, hooks, logging, etc. can work correctly.
223 224 225 226

    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:
227 228 229 230 231

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

Guido Trotter's avatar
Guido Trotter committed
233 234 235 236
    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.

237 238 239 240
    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.

241 242 243 244 245
    Examples::

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

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

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

  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.

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

  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.

334
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
335 336 337 338 339 340 341

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

    """
    raise NotImplementedError

342 343 344 345 346 347 348 349 350
  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.

351 352 353 354 355 356 357 358
    @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
359 360

    """
361 362 363
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
364 365
    return lu_result

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
  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"
381 382 383
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
384

385
  def _LockInstancesNodes(self, primary_only=False):
386 387 388 389 390 391 392 393 394 395 396 397 398
    """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.

399
    If should be called in DeclareLocks in a way similar to::
400

401 402
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
403

404 405 406
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

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

    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)
427 428 429

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
430

Iustin Pop's avatar
Iustin Pop committed
431
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
432 433 434 435 436 437 438 439 440
  """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

441 442 443 444 445 446 447 448
  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
449

450 451 452 453 454 455 456 457 458 459 460 461
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

  """
462 463 464 465 466 467 468
  def __init__(self, lu):
    self.lu = lu

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

469 470 471 472 473 474 475 476 477 478 479 480 481 482
  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.

    """
483
    pass
484 485 486 487 488 489 490 491 492 493 494 495

  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


496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
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()

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
    self.do_locking = None
    self.wanted = None

  def _GetNames(self, lu, all_names, lock_level):
    """Helper function to determine names asked for in the query.

    """
    if self.do_locking:
      names = lu.acquired_locks[lock_level]
    else:
      names = all_names

    if self.wanted == locking.ALL_SET:
      assert not self.names
      # caller didn't specify names, so ordering is not important
      return utils.NiceSort(names)

    # caller specified names and we must keep the same order
    assert self.names
    assert not self.do_locking or lu.acquired_locks[lock_level]

    missing = set(self.wanted).difference(names)
    if missing:
      raise errors.OpExecError("Some items were removed before retrieving"
                               " their data: %s" % missing)

    # Return expanded names
    return self.wanted

542 543 544 545 546 547 548 549
  @classmethod
  def FieldsQuery(cls, fields):
    """Returns list of available fields.

    @return: List of L{objects.QueryFieldDefinition}

    """
    if fields is None:
550 551 552
      # Client requests all fields, sort by name
      fdefs = sorted(query.GetAllFields(cls.FIELDS.values()),
                     key=operator.attrgetter("name"))
553
    else:
554
      # Keep order as requested by client
555 556
      fdefs = query.Query(cls.FIELDS, fields).GetFields()

557
    return objects.QueryFieldsResponse(fields=fdefs).ToDict()
558 559 560 561 562 563 564 565 566

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

    See L{LogicalUnit.ExpandNames}.

    """
    raise NotImplementedError()

567
  def DeclareLocks(self, lu, level):
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
    """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)

589 590
    return objects.QueryResponse(data=self.query.Query(data),
                                 fields=self.query.GetFields()).ToDict()
591 592 593 594 595 596 597 598

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

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


599
def _GetWantedNodes(lu, nodes):
600
  """Returns list of checked and expanded node names.
601

602 603 604 605 606 607
  @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
608
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
609 610

  """
611 612
  if nodes:
    return [_ExpandNodeName(lu.cfg, name) for name in nodes]
613

614
  return utils.NiceSort(lu.cfg.GetNodeList())
615 616 617


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

620 621 622 623 624 625 626 627
  @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
628 629 630

  """
  if instances:
631
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
632
  else:
633 634
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
635 636


637 638
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
639 640 641 642 643 644 645 646
  """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
647 648 649 650 651 652
  @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
653 654 655 656 657 658
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
659 660
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
661 662 663 664 665 666 667 668 669
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


670
def _CheckOutputFields(static, dynamic, selected):
671 672
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
673
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
674
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
675
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
676
  @param dynamic: dynamic fields set
677 678

  """
Iustin Pop's avatar
Iustin Pop committed
679
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
680 681
  f.Extend(static)
  f.Extend(dynamic)
682

Iustin Pop's avatar
Iustin Pop committed
683 684
  delta = f.NonMatching(selected)
  if delta:
685
    raise errors.OpPrereqError("Unknown output fields selected: %s"
686
                               % ",".join(delta), errors.ECODE_INVAL)
687 688


689 690 691 692 693 694 695 696 697 698 699
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"
700
           " cluster level: %s" % utils.CommaJoin(used_globals))
701 702 703
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


704
def _CheckNodeOnline(lu, node, msg=None):
705 706 707 708
  """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
709
  @param msg: if passed, should be a message to replace the default one
710
  @raise errors.OpPrereqError: if the node is offline
711 712

  """
713 714
  if msg is None:
    msg = "Can't use offline node"
715
  if lu.cfg.GetNodeInfo(node).offline:
716
    raise errors.OpPrereqError("%s: %s" % (msg, node), errors.ECODE_STATE)
717 718


719 720 721 722 723 724 725 726 727
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:
728
    raise errors.OpPrereqError("Can't use drained node %s" % node,
729 730 731 732 733 734 735 736 737 738 739 740 741 742
                               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)
743 744


Iustin Pop's avatar
Iustin Pop committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
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)


763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
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)


790 791 792 793 794 795 796 797 798 799 800
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)


801 802 803 804 805 806 807 808
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)
809 810
  if template == constants.DT_FILE:
    _RequireFileStorage()
811
  return True
812 813 814 815 816 817 818 819


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,
820
                               errors.ECODE_INVAL)
821 822
  if storage_type == constants.ST_FILE:
    _RequireFileStorage()
823
  return True
824

825

826 827 828 829 830 831 832
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

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

833

834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
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)


850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
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")


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

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

  if nics:
    nic_count = len(nics)
934
    for idx, (ip, mac, mode, link) in enumerate(nics):
935 936 937
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
938
      env["INSTANCE_NIC%d_MAC" % idx] = mac
939 940 941 942
      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
943 944 945 946 947
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
948 949 950 951 952 953 954 955 956 957
  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

958 959 960 961
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

962 963
  return env

964

965
def _NICListToTuple(lu, nics):
966 967
  """Build a list of nic information tuples.

968 969
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
  value in LUQueryInstanceData.
970 971 972 973 974 975 976 977

  @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 = []
978
  cluster = lu.cfg.GetClusterInfo()
979 980 981
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
982
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
983 984 985 986
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
987

988

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

992 993 994 995 996 997 998 999 1000 1001 1002
  @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

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


Guido Trotter's avatar
Guido Trotter committed
1027
def _AdjustCandidatePool(lu, exceptions):
1028 1029 1030
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
1031
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
1032 1033
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
1034
               utils.CommaJoin(node.name for node in mod_list))
1035 1036
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
1037
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
1038 1039 1040 1041 1042
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
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


1054
def _CheckNicsBridgesExist(lu, target_nics, target_node):
1055 1056 1057
  """Check that the brigdes needed by a list of nics exist.

  """
1058 1059
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
1060 1061 1062 1063
  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)
1064
    result.Raise("Error checking bridges on destination node '%s'" %
1065
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
1066 1067 1068


def _CheckInstanceBridgesExist(lu, instance, node=None):
1069 1070 1071
  """Check that the brigdes needed by an instance exist.

  """
1072
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
1073
    node = instance.primary_node
1074
  _CheckNicsBridgesExist(lu, instance.nics, node)
1075 1076


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

Iustin Pop's avatar
Iustin Pop committed
1080 1081
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
1082 1083 1084 1085
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
1086
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
1087
    return
1088 1089
  variant = objects.OS.GetVariant(name)
  if not variant:
1090 1091
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1092

Iustin Pop's avatar
Iustin Pop committed
1093
  if variant not in os_obj.supported_variants:
1094
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1095 1096


1097 1098 1099 1100
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


1101 1102 1103 1104 1105 1106 1107 1108
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)


1109 1110 1111 1112
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
1113 1114
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
1115 1116


1117 1118 1119 1120
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
1121 1122
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
1123 1124


1125 1126 1127 1128 1129 1130
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
1131 1132
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
1133 1134 1135 1136

  return []


1137 1138 1139 1140 1141 1142 1143 1144
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,
1145
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
1146 1147 1148 1149 1150 1151 1152 1153

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

  return faulty


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 1180 1181 1182 1183 1184 1185
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.")


1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200