cmdlib.py 590 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, 2011, 2012 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

24
# pylint: disable=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

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

Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
import os
import os.path
import time
import re
35
import logging
36
import copy
37
import OpenSSL
38
39
40
import socket
import tempfile
import shutil
41
import itertools
42
import operator
Iustin Pop's avatar
Iustin Pop committed
43
44
45
46
47

from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import hypervisor
Guido Trotter's avatar
Guido Trotter committed
48
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
49
50
from ganeti import constants
from ganeti import objects
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
from ganeti import query
from ganeti import qlang
58
from ganeti import opcodes
59
from ganeti import ht
60
from ganeti import rpc
61
from ganeti import runtime
62
from ganeti import pathutils
63
from ganeti import vcluster
64
from ganeti import network
65
from ganeti.masterd import iallocator
66

67
import ganeti.masterd.instance # pylint: disable=W0611
68

Iustin Pop's avatar
Iustin Pop committed
69

70
# States of instance
71
INSTANCE_DOWN = [constants.ADMINST_DOWN]
72
73
74
INSTANCE_ONLINE = [constants.ADMINST_DOWN, constants.ADMINST_UP]
INSTANCE_NOT_RUNNING = [constants.ADMINST_DOWN, constants.ADMINST_OFFLINE]

75
#: Instance status in which an instance can be marked as offline/online
76
CAN_CHANGE_INSTANCE_OFFLINE = (frozenset(INSTANCE_DOWN) | frozenset([
77
  constants.ADMINST_OFFLINE,
78
  ]))
79

80

81
82
83
84
class ResultWithJobs:
  """Data container for LU results with jobs.

  Instances of this class returned from L{LogicalUnit.Exec} will be recognized
85
  by L{mcpu._ProcessResult}. The latter will then submit the jobs
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
  contained in the C{jobs} attribute and include the job IDs in the opcode
  result.

  """
  def __init__(self, jobs, **kwargs):
    """Initializes this class.

    Additional return values can be specified as keyword arguments.

    @type jobs: list of lists of L{opcode.OpCode}
    @param jobs: A list of lists of opcode objects

    """
    self.jobs = jobs
    self.other = kwargs


Iustin Pop's avatar
Iustin Pop committed
103
class LogicalUnit(object):
104
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
105
106

  Subclasses must follow these rules:
107
    - implement ExpandNames
108
109
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
110
    - implement BuildHooksEnv
111
    - implement BuildHooksNodes
Iustin Pop's avatar
Iustin Pop committed
112
    - redefine HPATH and HTYPE
113
    - optionally redefine their run requirements:
114
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
115
116

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

118
119
120
  @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
121
122
123
  """
  HPATH = None
  HTYPE = None
124
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
125

126
  def __init__(self, processor, op, context, rpc_runner):
Iustin Pop's avatar
Iustin Pop committed
127
128
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
129
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
130
131
132
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
133
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
134
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
135
    self.cfg = context.cfg
136
    self.glm = context.glm
Iustin Pop's avatar
Iustin Pop committed
137
138
    # readability alias
    self.owned_locks = context.glm.list_owned
Guido Trotter's avatar
Guido Trotter committed
139
    self.context = context
140
    self.rpc = rpc_runner
141
142

    # Dictionaries used to declare locking needs to mcpu
143
    self.needed_locks = None
144
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
145
146
    self.opportunistic_locks = dict.fromkeys(locking.LEVELS, False)

147
148
    self.add_locks = {}
    self.remove_locks = {}
149

150
151
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
152

153
    # logging
154
155
156
157
    self.Log = processor.Log # pylint: disable=C0103
    self.LogWarning = processor.LogWarning # pylint: disable=C0103
    self.LogInfo = processor.LogInfo # pylint: disable=C0103
    self.LogStep = processor.LogStep # pylint: disable=C0103
158
159
    # support for dry-run
    self.dry_run_result = None
160
161
162
163
    # 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
164

165
    # Tasklets
166
    self.tasklets = None
167

168
169
    # Validate opcode parameters and set defaults
    self.op.Validate(True)
170

171
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
172

173
174
175
176
177
178
179
180
181
  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
182
      - CheckPrereq is run after we have acquired locks (and possible
183
184
185
186
187
188
189
190
        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

191
192
193
194
195
196
  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
197
    completed). This way locking, hooks, logging, etc. can work correctly.
198
199
200
201

    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:
202
203

      - use an empty dict if you don't need any lock
204
205
206
207
208
209
210
      - if you don't need any lock at a particular level omit that
        level (note that in this case C{DeclareLocks} won't be called
        at all for that level)
      - if you need locks at a level, but you can't calculate it in
        this function, initialise that level with an empty list and do
        further processing in L{LogicalUnit.DeclareLocks} (see that
        function's docstring)
211
      - don't put anything for the BGL level
212
      - if you want all locks at a level use L{locking.ALL_SET} as a value
213

Guido Trotter's avatar
Guido Trotter committed
214
215
216
217
    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.

218
219
220
221
    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.

222
223
224
225
226
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
227
        locking.LEVEL_INSTANCE: ['instance1.example.com'],
228
229
230
      }
      # Acquire just two nodes
      self.needed_locks = {
231
        locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
232
233
234
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
235
236
237
238
239
240
241
242
243
244

    """
    # 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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
  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
259
    @type level: member of L{ganeti.locking.LEVELS}
Guido Trotter's avatar
Guido Trotter committed
260
261
262

    """

Iustin Pop's avatar
Iustin Pop committed
263
264
265
266
267
268
269
270
271
272
273
274
  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
275
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
276
277

    """
278
    if self.tasklets is not None:
279
      for (idx, tl) in enumerate(self.tasklets):
280
281
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
282
283
        tl.CheckPrereq()
    else:
284
      pass
Iustin Pop's avatar
Iustin Pop committed
285
286
287
288
289
290
291
292
293

  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.

    """
294
    if self.tasklets is not None:
295
      for (idx, tl) in enumerate(self.tasklets):
296
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
297
298
299
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
300
301
302
303

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

304
305
306
307
308
309
310
311
    @rtype: dict
    @return: Dictionary containing the environment that will be used for
      running the hooks for this LU. The keys of the dict must not be prefixed
      with "GANETI_"--that'll be added by the hooks runner. The hooks runner
      will extend the environment with additional variables. If no environment
      should be defined, an empty dictionary should be returned (not C{None}).
    @note: If the C{HPATH} attribute of the LU class is C{None}, this function
      will not be called.
Iustin Pop's avatar
Iustin Pop committed
312

313
314
    """
    raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
315

316
317
  def BuildHooksNodes(self):
    """Build list of nodes to run LU's hooks.
Iustin Pop's avatar
Iustin Pop committed
318

319
320
321
322
323
324
325
    @rtype: tuple; (list, list)
    @return: Tuple containing 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. No nodes should be returned as an
      empty list (and not None).
    @note: If the C{HPATH} attribute of the LU class is C{None}, this function
      will not be called.
Iustin Pop's avatar
Iustin Pop committed
326
327
328
329

    """
    raise NotImplementedError

330
331
332
333
334
335
336
337
338
  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.

339
340
341
342
343
344
345
346
    @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
347
348

    """
349
350
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
351
    # pylint: disable=W0613,R0201
352
353
    return lu_result

354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
  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"
369
370
371
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
372

373
374
  def _LockInstancesNodes(self, primary_only=False,
                          level=locking.LEVEL_NODE):
375
376
377
378
379
380
381
382
383
384
385
386
387
    """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.

388
    If should be called in DeclareLocks in a way similar to::
389

390
391
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
392

393
394
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances
395
    @param level: Which lock level to use for locking nodes
396

397
    """
398
    assert level in self.recalculate_locks, \
399
400
401
402
403
404
405
406
      "_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 = []
Iustin Pop's avatar
Iustin Pop committed
407
    locked_i = self.owned_locks(locking.LEVEL_INSTANCE)
408
    for _, instance in self.cfg.GetMultiInstanceInfo(locked_i):
409
      wanted_nodes.append(instance.primary_node)
410
411
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
412

413
414
415
416
417
418
    if self.recalculate_locks[level] == constants.LOCKS_REPLACE:
      self.needed_locks[level] = wanted_nodes
    elif self.recalculate_locks[level] == constants.LOCKS_APPEND:
      self.needed_locks[level].extend(wanted_nodes)
    else:
      raise errors.ProgrammerError("Unknown recalculation mode")
419

420
    del self.recalculate_locks[level]
421

Iustin Pop's avatar
Iustin Pop committed
422

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

433
434
435
436
437
438
  def BuildHooksEnv(self):
    """Empty BuildHooksEnv for NoHooksLu.

    This just raises an error.

    """
439
440
441
442
443
444
445
    raise AssertionError("BuildHooksEnv called for NoHooksLUs")

  def BuildHooksNodes(self):
    """Empty BuildHooksNodes for NoHooksLU.

    """
    raise AssertionError("BuildHooksNodes called for NoHooksLU")
446

Iustin Pop's avatar
Iustin Pop committed
447

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

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

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

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

    """
481
    pass
482
483
484
485
486
487
488
489
490
491
492
493

  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


494
495
496
497
498
499
500
class _QueryBase:
  """Base for query utility classes.

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

501
502
503
  #: Field to sort by
  SORT_FIELD = "name"

504
  def __init__(self, qfilter, fields, use_locking):
505
506
507
508
509
    """Initializes this class.

    """
    self.use_locking = use_locking

510
    self.query = query.Query(self.FIELDS, fields, qfilter=qfilter,
511
                             namefield=self.SORT_FIELD)
512
    self.requested_data = self.query.RequestedData()
513
    self.names = self.query.RequestedNames()
514

515
516
517
    # Sort only if no names were requested
    self.sort_by_name = not self.names

518
519
520
521
522
523
524
525
    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:
Iustin Pop's avatar
Iustin Pop committed
526
      names = lu.owned_locks(lock_level)
527
528
529
530
531
532
533
534
535
536
    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
537
    assert not self.do_locking or lu.glm.is_owned(lock_level)
538
539
540
541
542
543
544
545
546

    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

547
548
549
550
551
552
553
554
  def ExpandNames(self, lu):
    """Expand names for this query.

    See L{LogicalUnit.ExpandNames}.

    """
    raise NotImplementedError()

555
  def DeclareLocks(self, lu, level):
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
    """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.

    """
575
576
    return query.GetQueryResponse(self.query, self._GetQueryData(lu),
                                  sort_by_name=self.sort_by_name)
577
578
579
580
581

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

    """
582
583
    return self.query.OldStyleQuery(self._GetQueryData(lu),
                                    sort_by_name=self.sort_by_name)
584
585


586
587
588
589
590
591
592
def _ShareAll():
  """Returns a dict declaring all lock levels shared.

  """
  return dict.fromkeys(locking.LEVELS, 1)


593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
def _AnnotateDiskParams(instance, devs, cfg):
  """Little helper wrapper to the rpc annotation method.

  @param instance: The instance object
  @type devs: List of L{objects.Disk}
  @param devs: The root devices (not any of its children!)
  @param cfg: The config object
  @returns The annotated disk copies
  @see L{rpc.AnnotateDiskParams}

  """
  return rpc.AnnotateDiskParams(instance.disk_template, devs,
                                cfg.GetInstanceDiskParams(instance))


608
609
610
611
612
613
614
615
616
617
618
619
620
def _CheckInstancesNodeGroups(cfg, instances, owned_groups, owned_nodes,
                              cur_group_uuid):
  """Checks if node groups for locked instances are still correct.

  @type cfg: L{config.ConfigWriter}
  @param cfg: Cluster configuration
  @type instances: dict; string as key, L{objects.Instance} as value
  @param instances: Dictionary, instance name as key, instance object as value
  @type owned_groups: iterable of string
  @param owned_groups: List of owned groups
  @type owned_nodes: iterable of string
  @param owned_nodes: List of owned nodes
  @type cur_group_uuid: string or None
Iustin Pop's avatar
Iustin Pop committed
621
  @param cur_group_uuid: Optional group UUID to check against instance's groups
622
623
624
625
626
627
628
629
630
631
632
633

  """
  for (name, inst) in instances.items():
    assert owned_nodes.issuperset(inst.all_nodes), \
      "Instance %s's nodes changed while we kept the lock" % name

    inst_groups = _CheckInstanceNodeGroups(cfg, name, owned_groups)

    assert cur_group_uuid is None or cur_group_uuid in inst_groups, \
      "Instance %s has no node in group %s" % (name, cur_group_uuid)


634
635
def _CheckInstanceNodeGroups(cfg, instance_name, owned_groups,
                             primary_only=False):
636
637
638
639
640
641
642
643
  """Checks if the owned node groups are still correct for an instance.

  @type cfg: L{config.ConfigWriter}
  @param cfg: The cluster configuration
  @type instance_name: string
  @param instance_name: Instance name
  @type owned_groups: set or frozenset
  @param owned_groups: List of currently owned node groups
644
645
  @type primary_only: boolean
  @param primary_only: Whether to check node groups for only the primary node
646
647

  """
648
  inst_groups = cfg.GetInstanceNodeGroups(instance_name, primary_only)
649
650
651
652
653
654
655
656
657
658
659
660
661
662

  if not owned_groups.issuperset(inst_groups):
    raise errors.OpPrereqError("Instance %s's node groups changed since"
                               " locks were acquired, current groups are"
                               " are '%s', owning groups '%s'; retry the"
                               " operation" %
                               (instance_name,
                                utils.CommaJoin(inst_groups),
                                utils.CommaJoin(owned_groups)),
                               errors.ECODE_STATE)

  return inst_groups


663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
def _CheckNodeGroupInstances(cfg, group_uuid, owned_instances):
  """Checks if the instances in a node group are still correct.

  @type cfg: L{config.ConfigWriter}
  @param cfg: The cluster configuration
  @type group_uuid: string
  @param group_uuid: Node group UUID
  @type owned_instances: set or frozenset
  @param owned_instances: List of currently owned instances

  """
  wanted_instances = cfg.GetNodeGroupInstances(group_uuid)
  if owned_instances != wanted_instances:
    raise errors.OpPrereqError("Instances in node group '%s' changed since"
                               " locks were acquired, wanted '%s', have '%s';"
                               " retry the operation" %
                               (group_uuid,
                                utils.CommaJoin(wanted_instances),
                                utils.CommaJoin(owned_instances)),
                               errors.ECODE_STATE)

  return wanted_instances


687
688
689
690
691
692
693
694
695
696
697
698
699
def _SupportsOob(cfg, node):
  """Tells if node supports OOB.

  @type cfg: L{config.ConfigWriter}
  @param cfg: The cluster configuration
  @type node: L{objects.Node}
  @param node: The node
  @return: The OOB script if supported or an empty string otherwise

  """
  return cfg.GetNdParams(node)[constants.ND_OOB_PROGRAM]


700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
def _IsExclusiveStorageEnabledNode(cfg, node):
  """Whether exclusive_storage is in effect for the given node.

  @type cfg: L{config.ConfigWriter}
  @param cfg: The cluster configuration
  @type node: L{objects.Node}
  @param node: The node
  @rtype: bool
  @return: The effective value of exclusive_storage

  """
  return cfg.GetNdParams(node)[constants.ND_EXCLUSIVE_STORAGE]


def _IsExclusiveStorageEnabledNodeName(cfg, nodename):
  """Whether exclusive_storage is in effect for the given node.

  @type cfg: L{config.ConfigWriter}
  @param cfg: The cluster configuration
  @type nodename: string
  @param nodename: The node
  @rtype: bool
  @return: The effective value of exclusive_storage
  @raise errors.OpPrereqError: if no node exists with the given name

  """
  ni = cfg.GetNodeInfo(nodename)
  if ni is None:
    raise errors.OpPrereqError("Invalid node name %s" % nodename,
                               errors.ECODE_NOENT)
  return _IsExclusiveStorageEnabledNode(cfg, ni)


733
734
735
736
737
738
739
740
741
742
743
744
def _CopyLockList(names):
  """Makes a copy of a list of lock names.

  Handles L{locking.ALL_SET} correctly.

  """
  if names == locking.ALL_SET:
    return locking.ALL_SET
  else:
    return names[:]


745
def _GetWantedNodes(lu, nodes):
746
  """Returns list of checked and expanded node names.
747

748
749
750
751
752
753
  @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
754
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
755
756

  """
757
758
  if nodes:
    return [_ExpandNodeName(lu.cfg, name) for name in nodes]
759

760
  return utils.NiceSort(lu.cfg.GetNodeList())
761
762
763


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

766
767
768
769
770
771
772
773
  @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
774
775
776

  """
  if instances:
777
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
778
  else:
779
780
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
781
782


783
784
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
785
786
787
788
789
790
791
792
  """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
793
794
795
796
797
798
  @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
799
800
801
802
803
804
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
805
806
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
807
808
809
810
811
812
813
814
815
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


816
817
818
819
820
821
822
823
824
825
def _GetUpdatedIPolicy(old_ipolicy, new_ipolicy, group_policy=False):
  """Return the new version of a instance policy.

  @param group_policy: whether this policy applies to a group and thus
    we should support removal of policy entries

  """
  use_none = use_default = group_policy
  ipolicy = copy.deepcopy(old_ipolicy)
  for key, value in new_ipolicy.items():
826
827
828
    if key not in constants.IPOLICY_ALL_KEYS:
      raise errors.OpPrereqError("Invalid key in new ipolicy: %s" % key,
                                 errors.ECODE_INVAL)
829
    if key in constants.IPOLICY_ISPECS:
830
831
832
833
834
      utils.ForceDictType(value, constants.ISPECS_PARAMETER_TYPES)
      ipolicy[key] = _GetUpdatedParams(old_ipolicy.get(key, {}), value,
                                       use_none=use_none,
                                       use_default=use_default)
    else:
835
836
      if (not value or value == [constants.VALUE_DEFAULT] or
          value == constants.VALUE_DEFAULT):
837
838
839
840
841
842
843
        if group_policy:
          del ipolicy[key]
        else:
          raise errors.OpPrereqError("Can't unset ipolicy attribute '%s'"
                                     " on the cluster'" % key,
                                     errors.ECODE_INVAL)
      else:
844
845
846
847
848
849
850
851
852
853
854
855
        if key in constants.IPOLICY_PARAMETERS:
          # FIXME: we assume all such values are float
          try:
            ipolicy[key] = float(value)
          except (TypeError, ValueError), err:
            raise errors.OpPrereqError("Invalid value for attribute"
                                       " '%s': '%s', error: %s" %
                                       (key, value, err), errors.ECODE_INVAL)
        else:
          # FIXME: we assume all others are lists; this should be redone
          # in a nicer way
          ipolicy[key] = list(value)
856
  try:
857
    objects.InstancePolicy.CheckParameterSyntax(ipolicy, not group_policy)
858
859
860
861
862
863
  except errors.ConfigurationError, err:
    raise errors.OpPrereqError("Invalid instance policy: %s" % err,
                               errors.ECODE_INVAL)
  return ipolicy


864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
def _UpdateAndVerifySubDict(base, updates, type_check):
  """Updates and verifies a dict with sub dicts of the same type.

  @param base: The dict with the old data
  @param updates: The dict with the new data
  @param type_check: Dict suitable to ForceDictType to verify correct types
  @returns: A new dict with updated and verified values

  """
  def fn(old, value):
    new = _GetUpdatedParams(old, value)
    utils.ForceDictType(new, type_check)
    return new

  ret = copy.deepcopy(base)
  ret.update(dict((key, fn(base.get(key, {}), value))
                  for key, value in updates.items()))
  return ret


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
def _MergeAndVerifyHvState(op_input, obj_input):
  """Combines the hv state from an opcode with the one of the object

  @param op_input: The input dict from the opcode
  @param obj_input: The input dict from the objects
  @return: The verified and updated dict

  """
  if op_input:
    invalid_hvs = set(op_input) - constants.HYPER_TYPES
    if invalid_hvs:
      raise errors.OpPrereqError("Invalid hypervisor(s) in hypervisor state:"
                                 " %s" % utils.CommaJoin(invalid_hvs),
                                 errors.ECODE_INVAL)
    if obj_input is None:
      obj_input = {}
    type_check = constants.HVSTS_PARAMETER_TYPES
    return _UpdateAndVerifySubDict(obj_input, op_input, type_check)

  return None


def _MergeAndVerifyDiskState(op_input, obj_input):
  """Combines the disk state from an opcode with the one of the object

  @param op_input: The input dict from the opcode
  @param obj_input: The input dict from the objects
  @return: The verified and updated dict
  """
  if op_input:
    invalid_dst = set(op_input) - constants.DS_VALID_TYPES
    if invalid_dst:
      raise errors.OpPrereqError("Invalid storage type(s) in disk state: %s" %
                                 utils.CommaJoin(invalid_dst),
                                 errors.ECODE_INVAL)
    type_check = constants.DSS_PARAMETER_TYPES
    if obj_input is None:
      obj_input = {}
    return dict((key, _UpdateAndVerifySubDict(obj_input.get(key, {}), value,
                                              type_check))
                for key, value in op_input.items())

  return None


929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
def _ReleaseLocks(lu, level, names=None, keep=None):
  """Releases locks owned by an LU.

  @type lu: L{LogicalUnit}
  @param level: Lock level
  @type names: list or None
  @param names: Names of locks to release
  @type keep: list or None
  @param keep: Names of locks to retain

  """
  assert not (keep is not None and names is not None), \
         "Only one of the 'names' and the 'keep' parameters can be given"

  if names is not None:
    should_release = names.__contains__
  elif keep:
    should_release = lambda name: name not in keep
  else:
    should_release = None

950
951
952
953
954
955
  owned = lu.owned_locks(level)
  if not owned:
    # Not owning any lock at this level, do nothing
    pass

  elif should_release:
956
957
958
959
    retain = []
    release = []

    # Determine which locks to release
960
    for name in owned:
961
962
963
964
965
      if should_release(name):
        release.append(name)
      else:
        retain.append(name)

Iustin Pop's avatar
Iustin Pop committed
966
    assert len(lu.owned_locks(level)) == (len(retain) + len(release))
967
968

    # Release just some locks
969
    lu.glm.release(level, names=release)
970

Iustin Pop's avatar
Iustin Pop committed
971
    assert frozenset(lu.owned_locks(level)) == frozenset(retain)
972
973
  else:
    # Release everything
974
    lu.glm.release(level)
975

976
    assert not lu.glm.is_owned(level), "No locks should be owned"
977
978


979
980
981
982
983
984
985
986
987
988
989
990
991
def _MapInstanceDisksToNodes(instances):
  """Creates a map from (node, volume) to instance name.

  @type instances: list of L{objects.Instance}
  @rtype: dict; tuple of (node name, volume name) as key, instance name as value

  """
  return dict(((node, vol), inst.name)
              for inst in instances
              for (node, vols) in inst.MapLVsByNode().items()
              for vol in vols)


992
993
994
995
def _RunPostHook(lu, node_name):
  """Runs the post-hook for an opcode on a single node.

  """
Andrea Spadaccini's avatar
Andrea Spadaccini committed
996
  hm = lu.proc.BuildHooksManager(lu)
997
998
  try:
    hm.RunPhase(constants.HOOKS_PHASE_POST, nodes=[node_name])
999
  except Exception, err: # pylint: disable=W0703
1000
1001
    lu.LogWarning("Errors occurred running hooks on %s: %s",
                  node_name, err)
1002
1003


1004
def _CheckOutputFields(static, dynamic, selected):
1005
1006
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
1007
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
1008
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
1009
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
1010
  @param dynamic: dynamic fields set
1011
1012

  """
Iustin Pop's avatar
Iustin Pop committed
1013
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
1014
1015
  f.Extend(static)
  f.Extend(dynamic)
1016

Iustin Pop's avatar
Iustin Pop committed
1017
1018
  delta = f.NonMatching(selected)
  if delta:
1019
    raise errors.OpPrereqError("Unknown output fields selected: %s"
1020
                               % ",".join(delta), errors.ECODE_INVAL)
1021
1022


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
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"
1034
           " cluster level: %s" % utils.CommaJoin(used_globals))
1035
1036
1037
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


1038
def _CheckNodeOnline(lu, node, msg=None):
1039
1040
1041
1042
  """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
1043
  @param msg: if passed, should be a message to replace the default one
1044
  @raise errors.OpPrereqError: if the node is offline
1045
1046

  """
1047
1048
  if msg is None:
    msg = "Can't use offline node"
1049
  if lu.cfg.GetNodeInfo(node).offline:
1050
    raise errors.OpPrereqError("%s: %s" % (msg, node), errors.ECODE_STATE)
1051
1052


1053
1054
1055
1056
1057
1058
1059
1060
1061
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:
1062
    raise errors.OpPrereqError("Can't use drained node %s" % node,
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
                               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)
1077
1078


Iustin Pop's avatar
Iustin Pop committed
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
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)


1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
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)


1124
1125
1126
1127
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

  """
1128
  return utils.ReadOneLineFile(pathutils.CLUSTER_DOMAIN_SECRET_FILE,
1129
1130
                               strict=True)

1131

1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
def _CheckInstanceState(lu, instance, req_states, msg=None):
  """Ensure that an instance is in one of the required states.

  @param lu: the LU on behalf of which we make the check
  @param instance: the instance to check
  @param msg: if passed, should be a message to replace the default one
  @raise errors.OpPrereqError: if the instance is not in the required state

  """
  if msg is None:
1142
1143
    msg = ("can't use instance from outside %s states" %
           utils.CommaJoin(req_states))
1144
  if instance.admin_state not in req_states:
1145
1146
    raise errors.OpPrereqError("Instance '%s' is marked to be %s, %s" %
                               (instance.name, instance.admin_state, msg),
1147
                               errors.ECODE_STATE)
1148

1149
1150
  if constants.ADMINST_UP not in req_states:
    pnode = instance.primary_node
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
    if not lu.cfg.GetNodeInfo(pnode).offline:
      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, msg), errors.ECODE_STATE)
    else:
      lu.LogWarning("Primary node offline, ignoring check that instance"
                     " is down")
1161
1162


1163
def _ComputeMinMaxSpec(name, qualifier, ipolicy, value):
1164
  """Computes if value is in the desired range.
1165
1166

  @param name: name of the parameter for which we perform the check
1167
1168
  @param qualifier: a qualifier used in the error message (e.g. 'disk/1',
      not just 'disk')
1169
1170
1171
1172
1173
1174
1175
1176
  @param ipolicy: dictionary containing min, max and std values
  @param value: actual value that we want to use
  @return: None or element not meeting the criteria


  """
  if value in [None, constants.VALUE_AUTO]:
    return None
1177
1178
  max_v = ipolicy[constants.ISPECS_MAX].get(name, value)
  min_v = ipolicy[constants.ISPECS_MIN].get(name, value)
1179
  if value > max_v or min_v > value:
1180
1181
1182
1183
    if qualifier:
      fqn = "%s/%s" % (name, qualifier)
    else:
      fqn = name
1184
    return ("%s value %s is not in range [%s, %s]" %
1185
            (fqn, value, min_v, max_v))
1186
1187
1188
  return None


1189
def _ComputeIPolicySpecViolation(ipolicy, mem_size, cpu_count, disk_count,
1190
                                 nic_count, disk_sizes, spindle_use,
1191
                                 _compute_fn=_ComputeMinMaxSpec):
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
  """Verifies ipolicy against provided specs.

  @type ipolicy: dict
  @param ipolicy: The ipolicy
  @type mem_size: int
  @param mem_size: The memory size
  @type cpu_count: int
  @param cpu_count: Used cpu cores
  @type disk_count: int
  @param disk_count: Number of disks used
  @type nic_count: int
  @param nic_count: Number of nics used
  @type disk_sizes: list of ints
  @param disk_sizes: Disk sizes of used disk (len must match C{disk_count})
1206
1207
  @type spindle_use: int
  @param spindle_use: The number of spindles this instance uses
1208
  @param _compute_fn: The compute function (unittest only)
1209
1210
1211
1212
1213
1214
  @return: A list of violations, or an empty list of no violations are found

  """
  assert disk_count == len(disk_sizes)

  test_settings = [
1215
1216
1217
1218
1219
1220
1221
    (constants.ISPEC_MEM_SIZE, "", mem_size),
    (constants.ISPEC_CPU_COUNT, "", cpu_count),
    (constants.ISPEC_DISK_COUNT, "", disk_count),
    (constants.ISPEC_NIC_COUNT, "", nic_count),
    (constants.ISPEC_SPINDLE_USE, "", spindle_use),
    ] + [(constants.ISPEC_DISK_SIZE, str(idx), d)
         for idx, d in enumerate(disk_sizes)]
1222
1223

  return filter(None,
1224
1225
                (_compute_fn(name, qualifier, ipolicy, value)
                 for (name, qualifier, value) in test_settings))
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241


def _ComputeIPolicyInstanceViolation(ipolicy, instance,
                                     _compute_fn=_ComputeIPolicySpecViolation):
  """Compute if instance meets the specs of ipolicy.

  @type ipolicy: dict
  @param ipolicy: The ipolicy to verify against
  @type instance: L{objects.Instance}
  @param instance: The instance to verify
  @param _compute_fn: The function to verify ipolicy (unittest only)
  @see: L{_ComputeIPolicySpecViolation}

  """
  mem_size = instance.beparams.get(constants.BE_MAXMEM, None)
  cpu_count = instance.beparams.get(constants.BE_VCPUS, None)
1242
  spindle_use = instance.beparams.get(constants.BE_SPINDLE_USE, None)
1243
1244
1245
1246
1247
  disk_count = len(instance.disks)
  disk_sizes = [disk.size for disk in instance.disks]
  nic_count = len(instance.nics)

  return _compute_fn(ipolicy, mem_size, cpu_count, disk_count, nic_count,
1248
                     disk_sizes, spindle_use)
1249
1250


Iustin Pop's avatar
Iustin Pop committed
1251
1252
def _ComputeIPolicyInstanceSpecViolation(
  ipolicy, instance_spec, _compute_fn=_ComputeIPolicySpecViolation):
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
  """Compute if instance specs meets the specs of ipolicy.

  @type ipolicy: dict
  @param ipolicy: The ipolicy to verify against
  @param instance_spec: dict
  @param instance_spec: The instance spec to verify
  @param _compute_fn: The function to verify ipolicy (unittest only)
  @see: L{_ComputeIPolicySpecViolation}

  """
  mem_size = instance_spec.get(constants.ISPEC_MEM_SIZE, None)
  cpu_count = instance_spec.get(constants.ISPEC_CPU_COUNT, None)
  disk_count = instance_spec.get(constants.ISPEC_DISK_COUNT, 0)
  disk_sizes = instance_spec.get(constants.ISPEC_DISK_SIZE, [])
  nic_count = instance_spec.get(constants.ISPEC_NIC_COUNT, 0)
1268
  spindle_use = instance_spec.get(constants.ISPEC_SPINDLE_USE, None)
1269
1270

  return _compute_fn(ipolicy, mem_size, cpu_count, disk_count, nic_count,
1271
                     disk_sizes, spindle_use)
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304


def _ComputeIPolicyNodeViolation(ipolicy, instance, current_group,
                                 target_group,
                                 _compute_fn=_ComputeIPolicyInstanceViolation):
  """Compute if instance meets the specs of the new target group.

  @param ipolicy: The ipolicy to verify
  @param instance: The instance object to verify
  @param current_group: The current group of the instance
  @param target_group: The new group of the instance
  @param _compute_fn: The function to verify ipolicy (unittest only)
  @see: L{_ComputeIPolicySpecViolation}

  """
  if current_group == target_group:
    return []
  else:
    return _compute_fn(ipolicy, instance)


def _CheckTargetNodeIPolicy(lu, ipolicy, instance, node, ignore=False,
                            _compute_fn=_ComputeIPolicyNodeViolation):
  """Checks that the target node is correct in terms of instance policy.

  @param ipolicy: The ipolicy to verify
  @param instance: The instance object to verify
  @param node: The new node to relocate
  @param ignore: Ignore violations of the ipolicy
  @param _compute_fn: The function to verify ipolicy (unittest only)
  @see: L{_ComputeIPolicySpecViolation}

  """
1305
1306
  primary_node = lu.cfg.GetNodeInfo(instance.primary_node)
  res = _compute_fn(ipolicy, instance, primary_node.group, node.group)
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316

  if res:
    msg = ("Instance does not meet target node group's (%s) instance"
           " policy: %s") % (node.group, utils.CommaJoin(res))
    if ignore:
      lu.LogWarning(msg)
    else:
      raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


1317
1318
1319
1320
1321
1322
def _ComputeNewInstanceViolations(old_ipolicy, new_ipolicy, instances):
  """Computes a set of any instances that would violate the new ipolicy.

  @param old_ipolicy: The current (still in-place) ipolicy
  @param new_ipolicy: The new (to become) ipolicy
  @param instances: List of instances to verify
1323
1324
  @return: A list of instances which violates the new ipolicy but
      did not before
1325
1326

  """
1327
1328
  return (_ComputeViolatingInstances(new_ipolicy, instances) -
          _ComputeViolatingInstances(old_ipolicy, instances))
1329
1330


1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
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")

1357
1358

def _BuildNetworkHookEnv(name, subnet, gateway, network6, gateway6,
1359
                         network_type, mac_prefix, tags):
1360
1361
1362
1363
1364
1365
  """Builds network related env variables for hooks

  This builds the hook environment from individual variables.

  @type name: string
  @param name: the name of the network
1366
1367
  @type subnet: string
  @param subnet: the ipv4 subnet
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
  @type gateway: string
  @param gateway: the ipv4 gateway
  @type network6: string
  @param network6: the ipv6 subnet
  @type gateway6: string
  @param gateway6: the ipv6 gateway
  @type network_type: string
  @param network_type: the type of the network
  @type mac_prefix: string
  @param mac_prefix: the mac_prefix
  @type tags: list
  @param tags: the tags of the network

  """
Iustin Pop's avatar
Iustin Pop committed
1382
  env = {}
1383
1384
  if name:
    env["NETWORK_NAME"] = name
1385
1386
  if subnet:
    env["NETWORK_SUBNET"] = subnet
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
  if gateway:
    env["NETWORK_GATEWAY"] = gateway
  if network6:
    env["NETWORK_SUBNET6"] = network6
  if gateway6:
    env["NETWORK_GATEWAY6"] = gateway6
  if mac_prefix:
    env["NETWORK_MAC_PREFIX"] = mac_prefix
  if network_type:
    env["NETWORK_TYPE"] = network_type
1397
1398
  if tags:
    env["NETWORK_TAGS"] = " ".join(tags)
1399
1400
1401
1402

  return env


1403
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
1404
                          minmem, maxmem, vcpus, nics, disk_template, disks,
1405
                          bep, hvp, hypervisor_name, tags):
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
  """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
1418
1419
  @type status: string
  @param status: the desired status of the instance
1420
1421
1422
1423
  @type minmem: string
  @param minmem: the minimum memory size of the instance
  @type maxmem: string
  @param maxmem: the maximum memory size of the instance
1424
1425
1426
  @type vcpus: string
  @param vcpus: the count of VCPUs the instance has
  @type nics: list
1427
  @param nics: list of tuples (ip, mac, mode, link, network) representing
1428
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
1429
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
1430
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
1431
1432
  @type disks: list
  @param disks: the list of (size, mode) pairs
1433
1434
1435
1436
  @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
1437
1438
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
1439
1440
  @type tags: list
  @param tags: list of instance tags as strings
1441
1442
  @rtype: dict
  @return: the hook environment for this instance
1443

1444
1445
  """
  env = {
1446
    "OP_TARGET": name,
1447
1448
1449
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
1450
    "INSTANCE_OS_TYPE": os_type,
1451
    "INSTANCE_STATUS": status,
1452
1453
1454
1455
    "INSTANCE_MINMEM": minmem,
    "INSTANCE_MAXMEM": maxmem,
    # TODO(2.7) remove deprecated "memory" value
    "INSTANCE_MEMORY": maxmem,
1456
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
1457
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
1458
    "INSTANCE_HYPERVISOR": hypervisor_name,
1459
1460
1461
  }
  if nics:
    nic_count = len(nics)
1462
    for idx, (ip, mac, mode, link, net, netinfo) in enumerate(nics):
1463
1464
1465
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
1466
      env["INSTANCE_NIC%d_MAC" % idx] = mac
1467
1468
      env["INSTANCE_NIC%d_MODE" % idx] = mode
      env["INSTANCE_NIC%d_LINK" % idx] = link
1469
      if network:
1470
        env["INSTANCE_NIC%d_NETWORK" % idx] = net
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
        if netinfo:
          nobj = objects.Network.FromDict(netinfo)
          if nobj.network:
            env["INSTANCE_NIC%d_NETWORK_SUBNET" % idx] = nobj.network
          if nobj.gateway:
            env["INSTANCE_NIC%d_NETWORK_GATEWAY" % idx] = nobj.gateway
          if nobj.network6:
            env["INSTANCE_NIC%d_NETWORK_SUBNET6" % idx] = nobj.network6
          if nobj.gateway6:
            env["INSTANCE_NIC%d_NETWORK_GATEWAY6" % idx] = nobj.gateway6
          if nobj.mac_prefix:
            env["INSTANCE_NIC%d_NETWORK_MAC_PREFIX" % idx] = nobj.mac_prefix
          if nobj.network_type:
            env["INSTANCE_NIC%d_NETWORK_TYPE" % idx] = nobj.network_type
1485
1486
          if nobj.tags:
            env["INSTANCE_NIC%d_NETWORK_TAGS" % idx] = " ".join(nobj.tags)
1487
1488
      if mode == constants.NIC_MODE_BRIDGED:
        env["INSTANCE_NIC%d_BRIDGE" % idx] = link
1489
1490
1491
1492
1493
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
  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

1504
1505
1506
1507
1508
  if not tags:
    tags = []

  env["INSTANCE_TAGS"] = " ".join(tags)

1509
1510
1511
1512
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

1513
1514
  return env

1515

1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
def _NICToTuple(lu, nic):
  """Build a tupple of nic information.

  @type lu:  L{LogicalUnit}
  @param lu: the logical unit on whose behalf we execute
  @type nic: L{objects.NIC}
  @param nic: nic to convert to hooks tuple

  """
  ip = nic.ip
  mac = nic.mac
1527
  cluster = lu.cfg.GetClusterInfo()
1528
1529
1530
  filled_params = cluster.SimpleFillNIC(nic.nicparams)
  mode = filled_params[constants.NIC_MODE]
  link = filled_params[constants.NIC_LINK]
1531
  net = nic.network
1532
  netinfo = None
1533
1534
  if net:
    net_uuid = lu.cfg.LookupNetwork(net)
1535
1536
1537
    if net_uuid:
      nobj = lu.cfg.GetNetwork(net_uuid)
      netinfo = objects.Network.ToDict(nobj)
1538
1539
  return (ip, mac, mode, link, net, netinfo)

1540

1541
def _NICListToTuple(lu, nics):
1542
1543
  """Build a list of nic information tuples.

1544
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
1545
  value in LUInstanceQueryData.
1546
1547
1548
1549
1550
1551
1552
1553
1554

  @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

  """
  hoo