cmdlib.py 399 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 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 itertools
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 serializer
52
from ganeti import ssconf
53
from ganeti import uidpool
54
from ganeti import compat
55
from ganeti import masterd
56
from ganeti import netutils
57
58
from ganeti import query
from ganeti import qlang
59
from ganeti import opcodes
60
61

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

Iustin Pop's avatar
Iustin Pop committed
63

64
65
66
67
68
69
70
71
72
73
74
75
76
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]


77
# End types
Iustin Pop's avatar
Iustin Pop committed
78
class LogicalUnit(object):
79
  """Logical Unit base class.
Iustin Pop's avatar
Iustin Pop committed
80
81

  Subclasses must follow these rules:
82
    - implement ExpandNames
83
84
    - implement CheckPrereq (except when tasklets are used)
    - implement Exec (except when tasklets are used)
Iustin Pop's avatar
Iustin Pop committed
85
86
    - implement BuildHooksEnv
    - redefine HPATH and HTYPE
87
    - optionally redefine their run requirements:
88
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
89
90

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

92
93
94
  @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
95
96
97
  """
  HPATH = None
  HTYPE = None
98
  REQ_BGL = True
Iustin Pop's avatar
Iustin Pop committed
99

Iustin Pop's avatar
Iustin Pop committed
100
  def __init__(self, processor, op, context, rpc):
Iustin Pop's avatar
Iustin Pop committed
101
102
    """Constructor for LogicalUnit.

Michael Hanselmann's avatar
Michael Hanselmann committed
103
    This needs to be overridden in derived classes in order to check op
Iustin Pop's avatar
Iustin Pop committed
104
105
106
    validity.

    """
Iustin Pop's avatar
Iustin Pop committed
107
    self.proc = processor
Iustin Pop's avatar
Iustin Pop committed
108
    self.op = op
Guido Trotter's avatar
Guido Trotter committed
109
110
    self.cfg = context.cfg
    self.context = context
Iustin Pop's avatar
Iustin Pop committed
111
    self.rpc = rpc
112
    # Dicts used to declare locking needs to mcpu
113
    self.needed_locks = None
114
    self.acquired_locks = {}
115
    self.share_locks = dict.fromkeys(locking.LEVELS, 0)
116
117
    self.add_locks = {}
    self.remove_locks = {}
118
119
    # Used to force good behavior when calling helper functions
    self.recalculate_locks = {}
120
    self.__ssh = None
121
    # logging
122
    self.Log = processor.Log # pylint: disable-msg=C0103
Iustin Pop's avatar
Iustin Pop committed
123
124
    self.LogWarning = processor.LogWarning # pylint: disable-msg=C0103
    self.LogInfo = processor.LogInfo # pylint: disable-msg=C0103
125
    self.LogStep = processor.LogStep # pylint: disable-msg=C0103
126
127
    # support for dry-run
    self.dry_run_result = None
128
129
130
131
    # 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
132

133
    # Tasklets
134
    self.tasklets = None
135

136
137
    # Validate opcode parameters and set defaults
    self.op.Validate(True)
138

139
    self.CheckArguments()
Iustin Pop's avatar
Iustin Pop committed
140

141
142
143
144
145
  def __GetSSH(self):
    """Returns the SshRunner object

    """
    if not self.__ssh:
146
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
147
148
149
150
    return self.__ssh

  ssh = property(fget=__GetSSH)

151
152
153
154
155
156
157
158
159
  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
160
      - CheckPrereq is run after we have acquired locks (and possible
161
162
163
164
165
166
167
168
        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

169
170
171
172
173
174
  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
175
    completed). This way locking, hooks, logging, etc. can work correctly.
176
177
178
179

    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:
180
181
182
183
184

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

Guido Trotter's avatar
Guido Trotter committed
186
187
188
189
    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.

190
191
192
193
    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.

194
195
196
197
198
    Examples::

      # Acquire all nodes and one instance
      self.needed_locks = {
        locking.LEVEL_NODE: locking.ALL_SET,
199
        locking.LEVEL_INSTANCE: ['instance1.example.com'],
200
201
202
      }
      # Acquire just two nodes
      self.needed_locks = {
203
        locking.LEVEL_NODE: ['node1.example.com', 'node2.example.com'],
204
205
206
      }
      # Acquire no locks
      self.needed_locks = {} # No, you can't leave it to the default value None
207
208
209
210
211
212
213
214
215
216

    """
    # 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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
  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
235
236
237
238
239
240
241
242
243
244
245
246
  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
247
    their canonical form if it hasn't been done by ExpandNames before.
Iustin Pop's avatar
Iustin Pop committed
248
249

    """
250
    if self.tasklets is not None:
251
      for (idx, tl) in enumerate(self.tasklets):
252
253
        logging.debug("Checking prerequisites for tasklet %s/%s",
                      idx + 1, len(self.tasklets))
254
255
        tl.CheckPrereq()
    else:
256
      pass
Iustin Pop's avatar
Iustin Pop committed
257
258
259
260
261
262
263
264
265

  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.

    """
266
    if self.tasklets is not None:
267
      for (idx, tl) in enumerate(self.tasklets):
268
        logging.debug("Executing tasklet %s/%s", idx + 1, len(self.tasklets))
269
270
271
        tl.Exec(feedback_fn)
    else:
      raise NotImplementedError
Iustin Pop's avatar
Iustin Pop committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

  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.

287
    No nodes should be returned as an empty list (and not None).
Iustin Pop's avatar
Iustin Pop committed
288
289
290
291
292
293
294

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

    """
    raise NotImplementedError

295
296
297
298
299
300
301
302
303
  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.

304
305
306
307
308
309
310
311
    @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
312
313

    """
314
315
316
    # API must be kept, thus we ignore the unused argument and could
    # be a function warnings
    # pylint: disable-msg=W0613,R0201
317
318
    return lu_result

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
  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"
334
335
336
    self.op.instance_name = _ExpandInstanceName(self.cfg,
                                                self.op.instance_name)
    self.needed_locks[locking.LEVEL_INSTANCE] = self.op.instance_name
337

338
  def _LockInstancesNodes(self, primary_only=False):
339
340
341
342
343
344
345
346
347
348
349
350
351
    """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.

352
    If should be called in DeclareLocks in a way similar to::
353

354
355
      if level == locking.LEVEL_NODE:
        self._LockInstancesNodes()
356

357
358
359
    @type primary_only: boolean
    @param primary_only: only lock primary nodes of locked instances

360
361
362
363
364
365
366
367
368
369
    """
    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 = []
370
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
371
372
      instance = self.context.cfg.GetInstanceInfo(instance_name)
      wanted_nodes.append(instance.primary_node)
373
374
      if not primary_only:
        wanted_nodes.extend(instance.secondary_nodes)
375
376
377
378
379

    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)
380
381
382

    del self.recalculate_locks[locking.LEVEL_NODE]

Iustin Pop's avatar
Iustin Pop committed
383

Iustin Pop's avatar
Iustin Pop committed
384
class NoHooksLU(LogicalUnit): # pylint: disable-msg=W0223
Iustin Pop's avatar
Iustin Pop committed
385
386
387
388
389
390
391
392
393
  """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

394
395
396
397
398
399
400
401
  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
402

403
404
405
406
407
408
409
410
411
412
413
414
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

  """
415
416
417
418
419
420
421
  def __init__(self, lu):
    self.lu = lu

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

422
423
424
425
426
427
428
429
430
431
432
433
434
435
  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.

    """
436
    pass
437
438
439
440
441
442
443
444
445
446
447
448

  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


449
450
451
452
453
454
455
class _QueryBase:
  """Base for query utility classes.

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

456
  def __init__(self, filter_, fields, use_locking):
457
458
459
460
461
    """Initializes this class.

    """
    self.use_locking = use_locking

462
463
    self.query = query.Query(self.FIELDS, fields, filter_=filter_,
                             namefield="name")
464
    self.requested_data = self.query.RequestedData()
465
    self.names = self.query.RequestedNames()
466

467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
    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

496
497
498
499
500
501
502
  @classmethod
  def FieldsQuery(cls, fields):
    """Returns list of available fields.

    @return: List of L{objects.QueryFieldDefinition}

    """
503
    return query.QueryFields(cls.FIELDS, fields)
504
505
506
507
508
509
510
511
512

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

    See L{LogicalUnit.ExpandNames}.

    """
    raise NotImplementedError()

513
  def DeclareLocks(self, lu, level):
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
    """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.

    """
533
    return query.GetQueryResponse(self.query, self._GetQueryData(lu))
534
535
536
537
538
539
540
541

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

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


542
def _GetWantedNodes(lu, nodes):
543
  """Returns list of checked and expanded node names.
544

545
546
547
548
549
550
  @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
551
  @raise errors.ProgrammerError: if the nodes parameter is wrong type
552
553

  """
554
555
  if nodes:
    return [_ExpandNodeName(lu.cfg, name) for name in nodes]
556

557
  return utils.NiceSort(lu.cfg.GetNodeList())
558
559
560


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

563
564
565
566
567
568
569
570
  @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
571
572
573

  """
  if instances:
574
    wanted = [_ExpandInstanceName(lu.cfg, name) for name in instances]
575
  else:
576
577
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
  return wanted
578
579


580
581
def _GetUpdatedParams(old_params, update_dict,
                      use_default=True, use_none=False):
582
583
584
585
586
587
588
589
  """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
590
591
592
593
594
595
  @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
596
597
598
599
600
601
  @rtype: dict
  @return: the new parameter dictionary

  """
  params_copy = copy.deepcopy(old_params)
  for key, val in update_dict.iteritems():
602
603
    if ((use_default and val == constants.VALUE_DEFAULT) or
        (use_none and val is None)):
604
605
606
607
608
609
610
611
612
      try:
        del params_copy[key]
      except KeyError:
        pass
    else:
      params_copy[key] = val
  return params_copy


613
def _CheckOutputFields(static, dynamic, selected):
614
615
  """Checks whether all selected fields are valid.

Iustin Pop's avatar
Iustin Pop committed
616
  @type static: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
617
  @param static: static fields set
Iustin Pop's avatar
Iustin Pop committed
618
  @type dynamic: L{utils.FieldSet}
Iustin Pop's avatar
Iustin Pop committed
619
  @param dynamic: dynamic fields set
620
621

  """
Iustin Pop's avatar
Iustin Pop committed
622
  f = utils.FieldSet()
Iustin Pop's avatar
Iustin Pop committed
623
624
  f.Extend(static)
  f.Extend(dynamic)
625

Iustin Pop's avatar
Iustin Pop committed
626
627
  delta = f.NonMatching(selected)
  if delta:
628
    raise errors.OpPrereqError("Unknown output fields selected: %s"
629
                               % ",".join(delta), errors.ECODE_INVAL)
630
631


632
633
634
635
636
637
638
639
640
641
642
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"
643
           " cluster level: %s" % utils.CommaJoin(used_globals))
644
645
646
    raise errors.OpPrereqError(msg, errors.ECODE_INVAL)


647
def _CheckNodeOnline(lu, node, msg=None):
648
649
650
651
  """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
652
  @param msg: if passed, should be a message to replace the default one
653
  @raise errors.OpPrereqError: if the node is offline
654
655

  """
656
657
  if msg is None:
    msg = "Can't use offline node"
658
  if lu.cfg.GetNodeInfo(node).offline:
659
    raise errors.OpPrereqError("%s: %s" % (msg, node), errors.ECODE_STATE)
660
661


662
663
664
665
666
667
668
669
670
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:
671
    raise errors.OpPrereqError("Can't use drained node %s" % node,
672
673
674
675
676
677
678
679
680
681
682
683
684
685
                               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)
686
687


Iustin Pop's avatar
Iustin Pop committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
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)


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


733
734
735
736
737
738
739
def _GetClusterDomainSecret():
  """Reads the cluster domain secret.

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

740

741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
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)


757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
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")


784
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
785
                          memory, vcpus, nics, disk_template, disks,
Michael Hanselmann's avatar
Michael Hanselmann committed
786
                          bep, hvp, hypervisor_name):
787
788
789
790
791
792
793
794
795
796
797
798
  """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
799
800
  @type status: boolean
  @param status: the should_run status of the instance
801
802
803
804
805
  @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
806
807
  @param nics: list of tuples (ip, mac, mode, link) representing
      the NICs the instance has
Iustin Pop's avatar
Iustin Pop committed
808
  @type disk_template: string
Michael Hanselmann's avatar
Michael Hanselmann committed
809
  @param disk_template: the disk template of the instance
Iustin Pop's avatar
Iustin Pop committed
810
811
  @type disks: list
  @param disks: the list of (size, mode) pairs
812
813
814
815
  @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
816
817
  @type hypervisor_name: string
  @param hypervisor_name: the hypervisor for the instance
818
819
  @rtype: dict
  @return: the hook environment for this instance
820

821
  """
822
823
824
825
  if status:
    str_status = "up"
  else:
    str_status = "down"
826
  env = {
827
    "OP_TARGET": name,
828
829
830
    "INSTANCE_NAME": name,
    "INSTANCE_PRIMARY": primary_node,
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
831
    "INSTANCE_OS_TYPE": os_type,
832
    "INSTANCE_STATUS": str_status,
833
834
    "INSTANCE_MEMORY": memory,
    "INSTANCE_VCPUS": vcpus,
Iustin Pop's avatar
Iustin Pop committed
835
    "INSTANCE_DISK_TEMPLATE": disk_template,
Michael Hanselmann's avatar
Michael Hanselmann committed
836
    "INSTANCE_HYPERVISOR": hypervisor_name,
837
838
839
840
  }

  if nics:
    nic_count = len(nics)
841
    for idx, (ip, mac, mode, link) in enumerate(nics):
842
843
844
      if ip is None:
        ip = ""
      env["INSTANCE_NIC%d_IP" % idx] = ip
Iustin Pop's avatar
Iustin Pop committed
845
      env["INSTANCE_NIC%d_MAC" % idx] = mac
846
847
848
849
      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
850
851
852
853
854
  else:
    nic_count = 0

  env["INSTANCE_NIC_COUNT"] = nic_count

Iustin Pop's avatar
Iustin Pop committed
855
856
857
858
859
860
861
862
863
864
  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

865
866
867
868
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
    for key, value in source.items():
      env["INSTANCE_%s_%s" % (kind, key)] = value

869
870
  return env

871

872
def _NICListToTuple(lu, nics):
873
874
  """Build a list of nic information tuples.

875
  This list is suitable to be passed to _BuildInstanceHookEnv or as a return
876
  value in LUInstanceQueryData.
877
878
879
880
881
882
883
884

  @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 = []
885
  cluster = lu.cfg.GetClusterInfo()
886
887
888
  for nic in nics:
    ip = nic.ip
    mac = nic.mac
889
    filled_params = cluster.SimpleFillNIC(nic.nicparams)
890
891
892
893
    mode = filled_params[constants.NIC_MODE]
    link = filled_params[constants.NIC_LINK]
    hooks_nics.append((ip, mac, mode, link))
  return hooks_nics
894

895

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

899
900
901
902
903
904
905
906
907
908
909
  @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

910
  """
911
912
913
  cluster = lu.cfg.GetClusterInfo()
  bep = cluster.FillBE(instance)
  hvp = cluster.FillHV(instance)
914
915
916
917
  args = {
    'name': instance.name,
    'primary_node': instance.primary_node,
    'secondary_nodes': instance.secondary_nodes,
918
    'os_type': instance.os,
919
    'status': instance.admin_up,
Iustin Pop's avatar
Iustin Pop committed
920
921
    'memory': bep[constants.BE_MEMORY],
    'vcpus': bep[constants.BE_VCPUS],
922
    'nics': _NICListToTuple(lu, instance.nics),
Iustin Pop's avatar
Iustin Pop committed
923
924
    'disk_template': instance.disk_template,
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
925
926
    'bep': bep,
    'hvp': hvp,
927
    'hypervisor_name': instance.hypervisor,
928
929
930
  }
  if override:
    args.update(override)
Iustin Pop's avatar
Iustin Pop committed
931
  return _BuildInstanceHookEnv(**args) # pylint: disable-msg=W0142
932
933


Guido Trotter's avatar
Guido Trotter committed
934
def _AdjustCandidatePool(lu, exceptions):
935
936
937
  """Adjust the candidate pool after node operations.

  """
Guido Trotter's avatar
Guido Trotter committed
938
  mod_list = lu.cfg.MaintainCandidatePool(exceptions)
939
940
  if mod_list:
    lu.LogInfo("Promoted nodes to master candidate role: %s",
941
               utils.CommaJoin(node.name for node in mod_list))
942
943
    for name in mod_list:
      lu.context.ReaddNode(name)
Guido Trotter's avatar
Guido Trotter committed
944
  mc_now, mc_max, _ = lu.cfg.GetMasterCandidateStats(exceptions)
945
946
947
948
949
  if mc_now > mc_max:
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
               (mc_now, mc_max))


950
951
952
953
954
955
956
957
958
959
960
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


961
def _CheckNicsBridgesExist(lu, target_nics, target_node):
962
963
964
  """Check that the brigdes needed by a list of nics exist.

  """
965
966
  cluster = lu.cfg.GetClusterInfo()
  paramslist = [cluster.SimpleFillNIC(nic.nicparams) for nic in target_nics]
967
968
969
970
  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)
971
    result.Raise("Error checking bridges on destination node '%s'" %
972
                 target_node, prereq=True, ecode=errors.ECODE_ENVIRON)
973
974
975


def _CheckInstanceBridgesExist(lu, instance, node=None):
976
977
978
  """Check that the brigdes needed by an instance exist.

  """
979
  if node is None:
Iustin Pop's avatar
Iustin Pop committed
980
    node = instance.primary_node
981
  _CheckNicsBridgesExist(lu, instance.nics, node)
982
983


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

Iustin Pop's avatar
Iustin Pop committed
987
988
  @type os_obj: L{objects.OS}
  @param os_obj: OS object to check
Guido Trotter's avatar
Guido Trotter committed
989
990
991
992
  @type name: string
  @param name: OS name passed by the user, to check for validity

  """
Iustin Pop's avatar
Iustin Pop committed
993
  if not os_obj.supported_variants:
Guido Trotter's avatar
Guido Trotter committed
994
    return
995
996
  variant = objects.OS.GetVariant(name)
  if not variant:
997
998
    raise errors.OpPrereqError("OS name must include a variant",
                               errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
999

Iustin Pop's avatar
Iustin Pop committed
1000
  if variant not in os_obj.supported_variants:
1001
    raise errors.OpPrereqError("Unsupported OS variant", errors.ECODE_INVAL)
Guido Trotter's avatar
Guido Trotter committed
1002
1003


1004
1005
1006
1007
def _GetNodeInstancesInner(cfg, fn):
  return [i for i in cfg.GetAllInstancesInfo().values() if fn(i)]


1008
1009
1010
1011
1012
1013
1014
1015
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)


1016
1017
1018
1019
def _GetNodePrimaryInstances(cfg, node_name):
  """Returns primary instances on a node.

  """
1020
1021
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name == inst.primary_node)
1022
1023


1024
1025
1026
1027
def _GetNodeSecondaryInstances(cfg, node_name):
  """Returns secondary instances on a node.

  """
1028
1029
  return _GetNodeInstancesInner(cfg,
                                lambda inst: node_name in inst.secondary_nodes)
1030
1031


1032
1033
1034
1035
1036
1037
def _GetStorageTypeArgs(cfg, storage_type):
  """Returns the arguments for a storage type.

  """
  # Special case for file storage
  if storage_type == constants.ST_FILE:
1038
1039
    # storage.FileStorage wants a list of storage directories
    return [[cfg.GetFileStorageDir()]]
1040
1041
1042
1043

  return []


1044
1045
1046
1047
1048
1049
1050
1051
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,
1052
               prereq=prereq, ecode=errors.ECODE_ENVIRON)
1053
1054
1055
1056
1057
1058
1059
1060

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

  return faulty


1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
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.")


1093
class LUClusterPostInit(LogicalUnit):
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
  """Logical unit for running hooks after cluster initialization.

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

  def BuildHooksEnv(self):
    """Build hooks env.

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

  def Exec(self, feedback_fn):
    """Nothing to do.

    """
    return True


1115
class LUClusterDestroy(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1116
1117
1118
  """Logical unit for destroying the cluster.

  """
1119
1120
  HPATH = "cluster-destroy"
  HTYPE = constants.HTYPE_CLUSTER
Iustin Pop's avatar
Iustin Pop committed
1121

1122
1123
1124
1125
1126
1127
1128
  def BuildHooksEnv(self):
    """Build hooks env.

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

Iustin Pop's avatar
Iustin Pop committed
1129
1130
1131
1132
1133
  def CheckPrereq(self):
    """Check prerequisites.

    This checks whether the cluster is empty.

Michael Hanselmann's avatar
Michael Hanselmann committed
1134
    Any errors are signaled by raising errors.OpPrereqError.
Iustin Pop's avatar
Iustin Pop committed
1135
1136

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1137
    master = self.cfg.GetMasterNode()
Iustin Pop's avatar
Iustin Pop committed
1138
1139

    nodelist = self.cfg.GetNodeList()
1140
    if len(nodelist) != 1 or nodelist[0] != master:
1141
      raise errors.OpPrereqError("There are still %d node(s) in"
1142
1143
                                 " this cluster." % (len(nodelist) - 1),
                                 errors.ECODE_INVAL)
1144
1145
    instancelist = self.cfg.GetInstanceList()
    if instancelist:
1146
      raise errors.OpPrereqError("There are still %d instance(s) in"
1147
1148
                                 " this cluster." % len(instancelist),
                                 errors.ECODE_INVAL)
Iustin Pop's avatar
Iustin Pop committed
1149
1150
1151
1152
1153

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

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
1154
    master = self.cfg.GetMasterNode()
Luca Bigliardi's avatar
Luca Bigliardi committed
1155
1156
1157
1158
1159
1160

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

1164
    result = self.rpc.call_node_stop_master(master, False)
1165
    result.Raise("Could not disable the master role")
1166

Iustin Pop's avatar
Iustin Pop committed
1167
    return master
Iustin Pop's avatar
Iustin Pop committed
1168
1169


1170
def _VerifyCertificate(filename):
1171
  """Verifies a certificate for LUClusterVerify.
1172
1173
1174
1175
1176
1177
1178
1179
1180

  @type filename: string
  @param filename: Path to PEM file

  """
  try:
    cert = OpenSSL.crypto.load_certificate(OpenSSL.crypto.FILETYPE_PEM,
                                           utils.ReadFile(filename))
  except Exception, err: # pylint: disable-msg=W0703
1181
    return (LUClusterVerify.ETYPE_ERROR,
1182
1183
            "Failed to load X509 certificate %s: %s" % (filename, err))

1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
  (errcode, msg) = \
    utils.VerifyX509Certificate(cert, constants.SSL_CERT_EXPIRATION_WARN,
                                constants.SSL_CERT_EXPIRATION_ERROR)

  if msg:
    fnamemsg = "While verifying %s: %s" % (filename, msg)
  else:
    fnamemsg = None

  if errcode is None:
    return (None, fnamemsg)
  elif errcode == utils.CERT_WARNING:
1196
    return (LUClusterVerify.ETYPE_WARNING, fnamemsg)
1197
  elif errcode == utils.CERT_ERROR:
1198
    return (LUClusterVerify.ETYPE_ERROR, fnamemsg)
1199

1200
  raise errors.ProgrammerError("Unhandled certificate error code %r" % errcode)
1201
1202


1203
class LUClusterVerify(LogicalUnit):
Iustin Pop's avatar
Iustin Pop committed
1204
1205
1206
  """Verifies the cluster status.

  """
Guido Trotter's avatar
Guido Trotter committed
1207
1208
  HPATH = "cluster-verify"
  HTYPE = constants.HTYPE_CLUSTER
1209
1210
  REQ_BGL = False

1211
1212
1213
1214
1215
  TCLUSTER = "cluster"
  TNODE = "node"
  TINSTANCE = "instance"

  ECLUSTERCFG = (TCLUSTER, "ECLUSTERCFG")
1216
  ECLUSTERCERT = (TCLUSTER, "ECLUSTERCERT")
1217
1218
1219
1220
  EINSTANCEBADNODE = (TINSTANCE, "EINSTANCEBADNODE")
  EINSTANCEDOWN = (TINSTANCE, "EINSTANCEDOWN")
  EINSTANCELAYOUT = (TINSTANCE, "EINSTANCELAYOUT")
  EINSTANCEMISSINGDISK = (TINSTANCE, "EINSTANCEMISSINGDISK")
1221
  EINSTANCEFAULTYDISK = (TINSTANCE, "EINSTANCEFAULTYDISK")
1222
  EINSTANCEWRONGNODE = (TINSTANCE, "EINSTANCEWRONGNODE")
1223
  EINSTANCESPLITGROUPS = (TINSTANCE, "EINSTANCESPLITGROUPS")
1224
  ENODEDRBD = (TNODE, "ENODEDRBD")
1225
  ENODEDRBDHELPER = (TNODE, "ENODEDRBDHELPER")
1226
1227
1228
1229
1230
1231
  ENODEFILECHECK = (TNODE, "ENODEFILECHECK")
  ENODEHOOKS = (TNODE, "ENODEHOOKS")
  ENODEHV = (TNODE, "ENODEHV")
  ENODELVM = (TNODE, "ENODELVM")
  ENODEN1 = (TNODE, "ENODEN1")
  ENODENET = (TNODE, "ENODENET")
1232
  ENODEOS = (TNODE, "ENODEOS")
1233
1234
1235
1236
1237
  ENODEORPHANINSTANCE = (TNODE, "ENODEORPHANINSTANCE")
  ENODEORPHANLV = (TNODE, "ENODEORPHANLV")
  ENODERPC = (TNODE, "ENODERPC")
  ENODESSH = (TNODE, "ENODESSH")
  ENODEVERSION = (TNODE, "ENODEVERSION")
1238
  ENODESETUP = (TNODE, "ENODESETUP")
1239
  ENODETIME = (TNODE, "ENODETIME")
1240
  ENODEOOBPATH = (TNODE, "ENODEOOBPATH")
1241

1242
1243
1244
1245
  ETYPE_FIELD = "code"
  ETYPE_ERROR = "ERROR"
  ETYPE_WARNING = "WARNING"

1246
1247
  _HOOKS_INDENT_RE = re.compile("^", re.M)

Iustin Pop's avatar
Iustin Pop committed
1248
1249
1250
  class NodeImage(object):
    """A class representing the logical and physical status of a node.

1251
1252
    @type name: string
    @ivar name: the node name to which this object refers
Iustin Pop's avatar
Iustin Pop committed
1253
    @ivar volumes: a structure as returned from
Iustin Pop's avatar
Iustin Pop committed
1254
        L{ganeti.backend.GetVolumeList} (runtime)
Iustin Pop's avatar
Iustin Pop committed
1255
1256
1257
    @ivar instances: a list of running instances (runtime)
    @ivar pinst: list of configured primary instances (config)
    @ivar sinst: list of configured secondary instances (config)
1258
1259
    @ivar sbp: dictionary of {primary-node: list of instances} for all
        instances for which this node is secondary (config)
Iustin Pop's avatar
Iustin Pop committed
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
    @ivar mfree: free memory, as reported by hypervisor (runtime)
    @ivar dfree: free disk, as reported by the node (runtime)
    @ivar offline: the offline status (config)
    @type rpc_fail: boolean
    @ivar rpc_fail: whether the RPC verify call was successfull (overall,
        not whether the individual keys were correct) (runtime)
    @type lvm_fail: boolean
    @ivar lvm_fail: whether the RPC call didn't return valid LVM data
    @type hyp_fail: boolean
    @ivar hyp_fail: whether the RPC call didn't return the instance list
    @type ghost: boolean
    @ivar ghost: whether this is a known node or not (config)
1272
1273
1274
1275
    @type os_fail: boolean
    @ivar os_fail: whether the RPC call didn't return valid OS data
    @type oslist: list
    @ivar oslist: list of OSes as diagnosed by DiagnoseOS
1276
1277
    @type vm_capable: boolean
    @ivar vm_capable: whether the node can host instances
Iustin Pop's avatar
Iustin Pop committed
1278
1279

    """
1280
    def __init__(self, offline=False, name=None, vm_capable=True):
1281
      self.name = name
Iustin Pop's avatar
Iustin Pop committed
1282
1283
1284
1285
1286
1287
1288
1289
      self.volumes = {}
      self.instances = []
      self.pinst = []
      self.sinst = []
      self.sbp = {}
      self.mfree = 0
      self.dfree = 0
      self.offline = offline
1290
      self.vm_capable = vm_capable
Iustin Pop's avatar
Iustin Pop committed
1291
1292
1293
1294
      self.rpc_fail = False
      self.lvm_fail = False
      self.hyp_fail = False
      self.ghost = False
1295
1296
      self.os_fail = False
      self.oslist = {}
Iustin Pop's avatar
Iustin Pop committed
1297

1298
1299
1300
1301
1302
  def ExpandNames(self):
    self.needed_locks = {
      locking.LEVEL_NODE: locking.ALL_SET,
      locking.LEVEL_INSTANCE: locking.ALL_SET,
    }
1303
    self.share_locks = dict.fromkeys(locking.LEVELS, 1)
Iustin Pop's avatar
Iustin Pop committed
1304

1305
1306
1307
1308
1309
1310
1311
1312
1313
  def _Error(self, ecode, item, msg, *args, **kwargs):
    """Format an error message.

    Based on the opcode's error_codes parameter, either format a
    parseable error code, or a simpler error string.

    This must be called only from Exec and functions called from Exec.

    """
1314
    ltype = kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR)
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
    itype, etxt = ecode
    # first complete the msg
    if args:
      msg = msg % args
    # then format the whole message
    if self.op.error_codes:
      msg = "%s:%s:%s:%s:%s" % (ltype, etxt, itype, item, msg)
    else:
      if item:
        item = " " + item
      else:
        item = ""
      msg = "%s: %s%s: %s" % (ltype, itype, item, msg)
    # and finally report it via the feedback_fn
    self._feedback_fn("  - %s" % msg)

1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
  def _ErrorIf(self, cond, *args, **kwargs):
    """Log an error message if the passed condition is True.

    """
    cond = bool(cond) or self.op.debug_simulate_errors
    if cond:
      self._Error(*args, **kwargs)
    # do not mark the operation as failed for WARN cases only
    if kwargs.get(self.ETYPE_FIELD, self.ETYPE_ERROR) == self.ETYPE_ERROR:
      self.bad = self.bad or cond

Iustin Pop's avatar
Iustin Pop committed
1342
  def _VerifyNode(self, ninfo, nresult):
1343
    """Perform some basic validation on data returned from a node.
Iustin Pop's avatar
Iustin Pop committed
1344

1345
1346
1347
      - check the result data structure is well formed and has all the
        mandatory fields
      - check ganeti version
Iustin Pop's avatar
Iustin Pop committed
1348

Iustin Pop's avatar
Iustin Pop committed
1349
1350
1351
1352
1353
1354
    @type ninfo: L{objects.Node}
    @param ninfo: the node to check
    @param nresult: the results from the node
    @rtype: boolean
    @return: whether overall this call was successful (and we can expect
         reasonable values in the respose)
1355

Iustin Pop's avatar
Iustin Pop committed
1356
    """
Iustin Pop's avatar
Iustin Pop committed
1357
    node = ninfo.name
Iustin Pop's avatar
Iustin Pop committed
1358
    _ErrorIf = self._ErrorIf # pylint: disable-msg=C0103
1359

Iustin Pop's avatar
Iustin Pop committed
1360
1361
    # main result, nresult should be a non-empty dict
    test = not nresult or not isinstance(nresult, dict)
1362
    _ErrorIf(test, self.ENODERPC, node,
1363
                  "unable to verify node: no data returned")
1364
    if test:
Iustin Pop's avatar
Iustin Pop committed
1365
      return False
1366

Iustin Pop's avatar
Iustin Pop committed
1367
1368
    # compares ganeti version
    local_version = constants.PROTOCOL_VERSION
Iustin Pop's avatar
Iustin Pop committed
1369
    remote_version = nresult.get("version", None)
1370
1371
1372
1373
1374
1375
    test = not (remote_version and
                isinstance(remote_version, (list, tuple)) and
                len(remote_version) == 2)
    _ErrorIf(test, self.ENODERPC, node,
             "connection to node returned invalid data")
    if test:
Iustin Pop's avatar
Iustin Pop committed
1376
      return False
1377
1378
1379
1380
1381
1382

    test = local_version != remote_version[0]
    _ErrorIf(test, self.ENODEVERSION, node,
             "incompatible protocol versions: master %s,"
             " node %s", local_version, remote_version[0])
    if test:
Iustin Pop's avatar
Iustin Pop committed
1383
      return False
Iustin Pop's avatar
Iustin Pop committed
1384

1385
    # node seems compatible, we can actually try to look into its results
Iustin Pop's avatar
Iustin Pop committed
1386

1387
    # full package version
1388
1389
    self._ErrorIf(constants.RELEASE_VERSION != remote_version[1],
                  self.ENODEVERSION, node,
1390
1391
                  "software version mismatch: master %s, node %s",
                  constants.RELEASE_VERSION, remote_version[1],
1392