Statistics
| Branch: | Tag: | Revision:

root / lib / cmdlib.py @ e631cb25

History | View | Annotate | Download (245.4 kB)

1
#
2
#
3

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

    
21

    
22
"""Module implementing the master-side code."""
23

    
24
# pylint: disable-msg=W0613,W0201
25

    
26
import os
27
import os.path
28
import time
29
import tempfile
30
import re
31
import platform
32
import logging
33
import copy
34
import random
35

    
36
from ganeti import ssh
37
from ganeti import utils
38
from ganeti import errors
39
from ganeti import hypervisor
40
from ganeti import locking
41
from ganeti import constants
42
from ganeti import objects
43
from ganeti import opcodes
44
from ganeti import serializer
45
from ganeti import ssconf
46

    
47

    
48
class LogicalUnit(object):
49
  """Logical Unit base class.
50

51
  Subclasses must follow these rules:
52
    - implement ExpandNames
53
    - implement CheckPrereq
54
    - implement Exec
55
    - implement BuildHooksEnv
56
    - redefine HPATH and HTYPE
57
    - optionally redefine their run requirements:
58
        REQ_BGL: the LU needs to hold the Big Ganeti Lock exclusively
59

60
  Note that all commands require root permissions.
61

62
  """
63
  HPATH = None
64
  HTYPE = None
65
  _OP_REQP = []
66
  REQ_BGL = True
67

    
68
  def __init__(self, processor, op, context, rpc):
69
    """Constructor for LogicalUnit.
70

71
    This needs to be overriden in derived classes in order to check op
72
    validity.
73

74
    """
75
    self.proc = processor
76
    self.op = op
77
    self.cfg = context.cfg
78
    self.context = context
79
    self.rpc = rpc
80
    # Dicts used to declare locking needs to mcpu
81
    self.needed_locks = None
82
    self.acquired_locks = {}
83
    self.share_locks = dict(((i, 0) for i in locking.LEVELS))
84
    self.add_locks = {}
85
    self.remove_locks = {}
86
    # Used to force good behavior when calling helper functions
87
    self.recalculate_locks = {}
88
    self.__ssh = None
89
    # logging
90
    self.LogWarning = processor.LogWarning
91
    self.LogInfo = processor.LogInfo
92

    
93
    for attr_name in self._OP_REQP:
94
      attr_val = getattr(op, attr_name, None)
95
      if attr_val is None:
96
        raise errors.OpPrereqError("Required parameter '%s' missing" %
97
                                   attr_name)
98
    self.CheckArguments()
99

    
100
  def __GetSSH(self):
101
    """Returns the SshRunner object
102

103
    """
104
    if not self.__ssh:
105
      self.__ssh = ssh.SshRunner(self.cfg.GetClusterName())
106
    return self.__ssh
107

    
108
  ssh = property(fget=__GetSSH)
109

    
110
  def CheckArguments(self):
111
    """Check syntactic validity for the opcode arguments.
112

113
    This method is for doing a simple syntactic check and ensure
114
    validity of opcode parameters, without any cluster-related
115
    checks. While the same can be accomplished in ExpandNames and/or
116
    CheckPrereq, doing these separate is better because:
117

118
      - ExpandNames is left as as purely a lock-related function
119
      - CheckPrereq is run after we have aquired locks (and possible
120
        waited for them)
121

122
    The function is allowed to change the self.op attribute so that
123
    later methods can no longer worry about missing parameters.
124

125
    """
126
    pass
127

    
128
  def ExpandNames(self):
129
    """Expand names for this LU.
130

131
    This method is called before starting to execute the opcode, and it should
132
    update all the parameters of the opcode to their canonical form (e.g. a
133
    short node name must be fully expanded after this method has successfully
134
    completed). This way locking, hooks, logging, ecc. can work correctly.
135

136
    LUs which implement this method must also populate the self.needed_locks
137
    member, as a dict with lock levels as keys, and a list of needed lock names
138
    as values. Rules:
139

140
      - use an empty dict if you don't need any lock
141
      - if you don't need any lock at a particular level omit that level
142
      - don't put anything for the BGL level
143
      - if you want all locks at a level use locking.ALL_SET as a value
144

145
    If you need to share locks (rather than acquire them exclusively) at one
146
    level you can modify self.share_locks, setting a true value (usually 1) for
147
    that level. By default locks are not shared.
148

149
    Examples::
150

151
      # Acquire all nodes and one instance
152
      self.needed_locks = {
153
        locking.LEVEL_NODE: locking.ALL_SET,
154
        locking.LEVEL_INSTANCE: ['instance1.example.tld'],
155
      }
156
      # Acquire just two nodes
157
      self.needed_locks = {
158
        locking.LEVEL_NODE: ['node1.example.tld', 'node2.example.tld'],
159
      }
160
      # Acquire no locks
161
      self.needed_locks = {} # No, you can't leave it to the default value None
162

163
    """
164
    # The implementation of this method is mandatory only if the new LU is
165
    # concurrent, so that old LUs don't need to be changed all at the same
166
    # time.
167
    if self.REQ_BGL:
168
      self.needed_locks = {} # Exclusive LUs don't need locks.
169
    else:
170
      raise NotImplementedError
171

    
172
  def DeclareLocks(self, level):
173
    """Declare LU locking needs for a level
174

175
    While most LUs can just declare their locking needs at ExpandNames time,
176
    sometimes there's the need to calculate some locks after having acquired
177
    the ones before. This function is called just before acquiring locks at a
178
    particular level, but after acquiring the ones at lower levels, and permits
179
    such calculations. It can be used to modify self.needed_locks, and by
180
    default it does nothing.
181

182
    This function is only called if you have something already set in
183
    self.needed_locks for the level.
184

185
    @param level: Locking level which is going to be locked
186
    @type level: member of ganeti.locking.LEVELS
187

188
    """
189

    
190
  def CheckPrereq(self):
191
    """Check prerequisites for this LU.
192

193
    This method should check that the prerequisites for the execution
194
    of this LU are fulfilled. It can do internode communication, but
195
    it should be idempotent - no cluster or system changes are
196
    allowed.
197

198
    The method should raise errors.OpPrereqError in case something is
199
    not fulfilled. Its return value is ignored.
200

201
    This method should also update all the parameters of the opcode to
202
    their canonical form if it hasn't been done by ExpandNames before.
203

204
    """
205
    raise NotImplementedError
206

    
207
  def Exec(self, feedback_fn):
208
    """Execute the LU.
209

210
    This method should implement the actual work. It should raise
211
    errors.OpExecError for failures that are somewhat dealt with in
212
    code, or expected.
213

214
    """
215
    raise NotImplementedError
216

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

220
    This method should return a three-node tuple consisting of: a dict
221
    containing the environment that will be used for running the
222
    specific hook for this LU, a list of node names on which the hook
223
    should run before the execution, and a list of node names on which
224
    the hook should run after the execution.
225

226
    The keys of the dict must not have 'GANETI_' prefixed as this will
227
    be handled in the hooks runner. Also note additional keys will be
228
    added by the hooks runner. If the LU doesn't define any
229
    environment, an empty dict (and not None) should be returned.
230

231
    No nodes should be returned as an empty list (and not None).
232

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

236
    """
237
    raise NotImplementedError
238

    
239
  def HooksCallBack(self, phase, hook_results, feedback_fn, lu_result):
240
    """Notify the LU about the results of its hooks.
241

242
    This method is called every time a hooks phase is executed, and notifies
243
    the Logical Unit about the hooks' result. The LU can then use it to alter
244
    its result based on the hooks.  By default the method does nothing and the
245
    previous result is passed back unchanged but any LU can define it if it
246
    wants to use the local cluster hook-scripts somehow.
247

248
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
249
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
250
    @param hook_results: the results of the multi-node hooks rpc call
251
    @param feedback_fn: function used send feedback back to the caller
252
    @param lu_result: the previous Exec result this LU had, or None
253
        in the PRE phase
254
    @return: the new Exec result, based on the previous result
255
        and hook results
256

257
    """
258
    return lu_result
259

    
260
  def _ExpandAndLockInstance(self):
261
    """Helper function to expand and lock an instance.
262

263
    Many LUs that work on an instance take its name in self.op.instance_name
264
    and need to expand it and then declare the expanded name for locking. This
265
    function does it, and then updates self.op.instance_name to the expanded
266
    name. It also initializes needed_locks as a dict, if this hasn't been done
267
    before.
268

269
    """
270
    if self.needed_locks is None:
271
      self.needed_locks = {}
272
    else:
273
      assert locking.LEVEL_INSTANCE not in self.needed_locks, \
274
        "_ExpandAndLockInstance called with instance-level locks set"
275
    expanded_name = self.cfg.ExpandInstanceName(self.op.instance_name)
276
    if expanded_name is None:
277
      raise errors.OpPrereqError("Instance '%s' not known" %
278
                                  self.op.instance_name)
279
    self.needed_locks[locking.LEVEL_INSTANCE] = expanded_name
280
    self.op.instance_name = expanded_name
281

    
282
  def _LockInstancesNodes(self, primary_only=False):
283
    """Helper function to declare instances' nodes for locking.
284

285
    This function should be called after locking one or more instances to lock
286
    their nodes. Its effect is populating self.needed_locks[locking.LEVEL_NODE]
287
    with all primary or secondary nodes for instances already locked and
288
    present in self.needed_locks[locking.LEVEL_INSTANCE].
289

290
    It should be called from DeclareLocks, and for safety only works if
291
    self.recalculate_locks[locking.LEVEL_NODE] is set.
292

293
    In the future it may grow parameters to just lock some instance's nodes, or
294
    to just lock primaries or secondary nodes, if needed.
295

296
    If should be called in DeclareLocks in a way similar to::
297

298
      if level == locking.LEVEL_NODE:
299
        self._LockInstancesNodes()
300

301
    @type primary_only: boolean
302
    @param primary_only: only lock primary nodes of locked instances
303

304
    """
305
    assert locking.LEVEL_NODE in self.recalculate_locks, \
306
      "_LockInstancesNodes helper function called with no nodes to recalculate"
307

    
308
    # TODO: check if we're really been called with the instance locks held
309

    
310
    # For now we'll replace self.needed_locks[locking.LEVEL_NODE], but in the
311
    # future we might want to have different behaviors depending on the value
312
    # of self.recalculate_locks[locking.LEVEL_NODE]
313
    wanted_nodes = []
314
    for instance_name in self.acquired_locks[locking.LEVEL_INSTANCE]:
315
      instance = self.context.cfg.GetInstanceInfo(instance_name)
316
      wanted_nodes.append(instance.primary_node)
317
      if not primary_only:
318
        wanted_nodes.extend(instance.secondary_nodes)
319

    
320
    if self.recalculate_locks[locking.LEVEL_NODE] == constants.LOCKS_REPLACE:
321
      self.needed_locks[locking.LEVEL_NODE] = wanted_nodes
322
    elif self.recalculate_locks[locking.LEVEL_NODE] == constants.LOCKS_APPEND:
323
      self.needed_locks[locking.LEVEL_NODE].extend(wanted_nodes)
324

    
325
    del self.recalculate_locks[locking.LEVEL_NODE]
326

    
327

    
328
class NoHooksLU(LogicalUnit):
329
  """Simple LU which runs no hooks.
330

331
  This LU is intended as a parent for other LogicalUnits which will
332
  run no hooks, in order to reduce duplicate code.
333

334
  """
335
  HPATH = None
336
  HTYPE = None
337

    
338

    
339
def _GetWantedNodes(lu, nodes):
340
  """Returns list of checked and expanded node names.
341

342
  @type lu: L{LogicalUnit}
343
  @param lu: the logical unit on whose behalf we execute
344
  @type nodes: list
345
  @param nodes: list of node names or None for all nodes
346
  @rtype: list
347
  @return: the list of nodes, sorted
348
  @raise errors.OpProgrammerError: if the nodes parameter is wrong type
349

350
  """
351
  if not isinstance(nodes, list):
352
    raise errors.OpPrereqError("Invalid argument type 'nodes'")
353

    
354
  if not nodes:
355
    raise errors.ProgrammerError("_GetWantedNodes should only be called with a"
356
      " non-empty list of nodes whose name is to be expanded.")
357

    
358
  wanted = []
359
  for name in nodes:
360
    node = lu.cfg.ExpandNodeName(name)
361
    if node is None:
362
      raise errors.OpPrereqError("No such node name '%s'" % name)
363
    wanted.append(node)
364

    
365
  return utils.NiceSort(wanted)
366

    
367

    
368
def _GetWantedInstances(lu, instances):
369
  """Returns list of checked and expanded instance names.
370

371
  @type lu: L{LogicalUnit}
372
  @param lu: the logical unit on whose behalf we execute
373
  @type instances: list
374
  @param instances: list of instance names or None for all instances
375
  @rtype: list
376
  @return: the list of instances, sorted
377
  @raise errors.OpPrereqError: if the instances parameter is wrong type
378
  @raise errors.OpPrereqError: if any of the passed instances is not found
379

380
  """
381
  if not isinstance(instances, list):
382
    raise errors.OpPrereqError("Invalid argument type 'instances'")
383

    
384
  if instances:
385
    wanted = []
386

    
387
    for name in instances:
388
      instance = lu.cfg.ExpandInstanceName(name)
389
      if instance is None:
390
        raise errors.OpPrereqError("No such instance name '%s'" % name)
391
      wanted.append(instance)
392

    
393
  else:
394
    wanted = utils.NiceSort(lu.cfg.GetInstanceList())
395
  return wanted
396

    
397

    
398
def _CheckOutputFields(static, dynamic, selected):
399
  """Checks whether all selected fields are valid.
400

401
  @type static: L{utils.FieldSet}
402
  @param static: static fields set
403
  @type dynamic: L{utils.FieldSet}
404
  @param dynamic: dynamic fields set
405

406
  """
407
  f = utils.FieldSet()
408
  f.Extend(static)
409
  f.Extend(dynamic)
410

    
411
  delta = f.NonMatching(selected)
412
  if delta:
413
    raise errors.OpPrereqError("Unknown output fields selected: %s"
414
                               % ",".join(delta))
415

    
416

    
417
def _CheckBooleanOpField(op, name):
418
  """Validates boolean opcode parameters.
419

420
  This will ensure that an opcode parameter is either a boolean value,
421
  or None (but that it always exists).
422

423
  """
424
  val = getattr(op, name, None)
425
  if not (val is None or isinstance(val, bool)):
426
    raise errors.OpPrereqError("Invalid boolean parameter '%s' (%s)" %
427
                               (name, str(val)))
428
  setattr(op, name, val)
429

    
430

    
431
def _CheckNodeOnline(lu, node):
432
  """Ensure that a given node is online.
433

434
  @param lu: the LU on behalf of which we make the check
435
  @param node: the node to check
436
  @raise errors.OpPrereqError: if the node is offline
437

438
  """
439
  if lu.cfg.GetNodeInfo(node).offline:
440
    raise errors.OpPrereqError("Can't use offline node %s" % node)
441

    
442

    
443
def _CheckNodeNotDrained(lu, node):
444
  """Ensure that a given node is not drained.
445

446
  @param lu: the LU on behalf of which we make the check
447
  @param node: the node to check
448
  @raise errors.OpPrereqError: if the node is drained
449

450
  """
451
  if lu.cfg.GetNodeInfo(node).drained:
452
    raise errors.OpPrereqError("Can't use drained node %s" % node)
453

    
454

    
455
def _BuildInstanceHookEnv(name, primary_node, secondary_nodes, os_type, status,
456
                          memory, vcpus, nics, disk_template, disks,
457
                          bep, hvp, hypervisor):
458
  """Builds instance related env variables for hooks
459

460
  This builds the hook environment from individual variables.
461

462
  @type name: string
463
  @param name: the name of the instance
464
  @type primary_node: string
465
  @param primary_node: the name of the instance's primary node
466
  @type secondary_nodes: list
467
  @param secondary_nodes: list of secondary nodes as strings
468
  @type os_type: string
469
  @param os_type: the name of the instance's OS
470
  @type status: boolean
471
  @param status: the should_run status of the instance
472
  @type memory: string
473
  @param memory: the memory size of the instance
474
  @type vcpus: string
475
  @param vcpus: the count of VCPUs the instance has
476
  @type nics: list
477
  @param nics: list of tuples (ip, bridge, mac) representing
478
      the NICs the instance  has
479
  @type disk_template: string
480
  @param disk_template: the distk template of the instance
481
  @type disks: list
482
  @param disks: the list of (size, mode) pairs
483
  @type bep: dict
484
  @param bep: the backend parameters for the instance
485
  @type hvp: dict
486
  @param hvp: the hypervisor parameters for the instance
487
  @type hypervisor: string
488
  @param hypervisor: the hypervisor for the instance
489
  @rtype: dict
490
  @return: the hook environment for this instance
491

492
  """
493
  if status:
494
    str_status = "up"
495
  else:
496
    str_status = "down"
497
  env = {
498
    "OP_TARGET": name,
499
    "INSTANCE_NAME": name,
500
    "INSTANCE_PRIMARY": primary_node,
501
    "INSTANCE_SECONDARIES": " ".join(secondary_nodes),
502
    "INSTANCE_OS_TYPE": os_type,
503
    "INSTANCE_STATUS": str_status,
504
    "INSTANCE_MEMORY": memory,
505
    "INSTANCE_VCPUS": vcpus,
506
    "INSTANCE_DISK_TEMPLATE": disk_template,
507
    "INSTANCE_HYPERVISOR": hypervisor,
508
  }
509

    
510
  if nics:
511
    nic_count = len(nics)
512
    for idx, (ip, bridge, mac) in enumerate(nics):
513
      if ip is None:
514
        ip = ""
515
      env["INSTANCE_NIC%d_IP" % idx] = ip
516
      env["INSTANCE_NIC%d_BRIDGE" % idx] = bridge
517
      env["INSTANCE_NIC%d_MAC" % idx] = mac
518
  else:
519
    nic_count = 0
520

    
521
  env["INSTANCE_NIC_COUNT"] = nic_count
522

    
523
  if disks:
524
    disk_count = len(disks)
525
    for idx, (size, mode) in enumerate(disks):
526
      env["INSTANCE_DISK%d_SIZE" % idx] = size
527
      env["INSTANCE_DISK%d_MODE" % idx] = mode
528
  else:
529
    disk_count = 0
530

    
531
  env["INSTANCE_DISK_COUNT"] = disk_count
532

    
533
  for source, kind in [(bep, "BE"), (hvp, "HV")]:
534
    for key, value in source.items():
535
      env["INSTANCE_%s_%s" % (kind, key)] = value
536

    
537
  return env
538

    
539

    
540
def _BuildInstanceHookEnvByObject(lu, instance, override=None):
541
  """Builds instance related env variables for hooks from an object.
542

543
  @type lu: L{LogicalUnit}
544
  @param lu: the logical unit on whose behalf we execute
545
  @type instance: L{objects.Instance}
546
  @param instance: the instance for which we should build the
547
      environment
548
  @type override: dict
549
  @param override: dictionary with key/values that will override
550
      our values
551
  @rtype: dict
552
  @return: the hook environment dictionary
553

554
  """
555
  cluster = lu.cfg.GetClusterInfo()
556
  bep = cluster.FillBE(instance)
557
  hvp = cluster.FillHV(instance)
558
  args = {
559
    'name': instance.name,
560
    'primary_node': instance.primary_node,
561
    'secondary_nodes': instance.secondary_nodes,
562
    'os_type': instance.os,
563
    'status': instance.admin_up,
564
    'memory': bep[constants.BE_MEMORY],
565
    'vcpus': bep[constants.BE_VCPUS],
566
    'nics': [(nic.ip, nic.bridge, nic.mac) for nic in instance.nics],
567
    'disk_template': instance.disk_template,
568
    'disks': [(disk.size, disk.mode) for disk in instance.disks],
569
    'bep': bep,
570
    'hvp': hvp,
571
    'hypervisor': instance.hypervisor,
572
  }
573
  if override:
574
    args.update(override)
575
  return _BuildInstanceHookEnv(**args)
576

    
577

    
578
def _AdjustCandidatePool(lu):
579
  """Adjust the candidate pool after node operations.
580

581
  """
582
  mod_list = lu.cfg.MaintainCandidatePool()
583
  if mod_list:
584
    lu.LogInfo("Promoted nodes to master candidate role: %s",
585
               ", ".join(node.name for node in mod_list))
586
    for name in mod_list:
587
      lu.context.ReaddNode(name)
588
  mc_now, mc_max = lu.cfg.GetMasterCandidateStats()
589
  if mc_now > mc_max:
590
    lu.LogInfo("Note: more nodes are candidates (%d) than desired (%d)" %
591
               (mc_now, mc_max))
592

    
593

    
594
def _CheckInstanceBridgesExist(lu, instance):
595
  """Check that the brigdes needed by an instance exist.
596

597
  """
598
  # check bridges existance
599
  brlist = [nic.bridge for nic in instance.nics]
600
  result = lu.rpc.call_bridges_exist(instance.primary_node, brlist)
601
  result.Raise()
602
  if not result.data:
603
    raise errors.OpPrereqError("One or more target bridges %s does not"
604
                               " exist on destination node '%s'" %
605
                               (brlist, instance.primary_node))
606

    
607

    
608
class LUDestroyCluster(NoHooksLU):
609
  """Logical unit for destroying the cluster.
610

611
  """
612
  _OP_REQP = []
613

    
614
  def CheckPrereq(self):
615
    """Check prerequisites.
616

617
    This checks whether the cluster is empty.
618

619
    Any errors are signalled by raising errors.OpPrereqError.
620

621
    """
622
    master = self.cfg.GetMasterNode()
623

    
624
    nodelist = self.cfg.GetNodeList()
625
    if len(nodelist) != 1 or nodelist[0] != master:
626
      raise errors.OpPrereqError("There are still %d node(s) in"
627
                                 " this cluster." % (len(nodelist) - 1))
628
    instancelist = self.cfg.GetInstanceList()
629
    if instancelist:
630
      raise errors.OpPrereqError("There are still %d instance(s) in"
631
                                 " this cluster." % len(instancelist))
632

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

636
    """
637
    master = self.cfg.GetMasterNode()
638
    result = self.rpc.call_node_stop_master(master, False)
639
    result.Raise()
640
    if not result.data:
641
      raise errors.OpExecError("Could not disable the master role")
642
    priv_key, pub_key, _ = ssh.GetUserFiles(constants.GANETI_RUNAS)
643
    utils.CreateBackup(priv_key)
644
    utils.CreateBackup(pub_key)
645
    return master
646

    
647

    
648
class LUVerifyCluster(LogicalUnit):
649
  """Verifies the cluster status.
650

651
  """
652
  HPATH = "cluster-verify"
653
  HTYPE = constants.HTYPE_CLUSTER
654
  _OP_REQP = ["skip_checks"]
655
  REQ_BGL = False
656

    
657
  def ExpandNames(self):
658
    self.needed_locks = {
659
      locking.LEVEL_NODE: locking.ALL_SET,
660
      locking.LEVEL_INSTANCE: locking.ALL_SET,
661
    }
662
    self.share_locks = dict(((i, 1) for i in locking.LEVELS))
663

    
664
  def _VerifyNode(self, nodeinfo, file_list, local_cksum,
665
                  node_result, feedback_fn, master_files,
666
                  drbd_map, vg_name):
667
    """Run multiple tests against a node.
668

669
    Test list:
670

671
      - compares ganeti version
672
      - checks vg existance and size > 20G
673
      - checks config file checksum
674
      - checks ssh to other nodes
675

676
    @type nodeinfo: L{objects.Node}
677
    @param nodeinfo: the node to check
678
    @param file_list: required list of files
679
    @param local_cksum: dictionary of local files and their checksums
680
    @param node_result: the results from the node
681
    @param feedback_fn: function used to accumulate results
682
    @param master_files: list of files that only masters should have
683
    @param drbd_map: the useddrbd minors for this node, in
684
        form of minor: (instance, must_exist) which correspond to instances
685
        and their running status
686
    @param vg_name: Ganeti Volume Group (result of self.cfg.GetVGName())
687

688
    """
689
    node = nodeinfo.name
690

    
691
    # main result, node_result should be a non-empty dict
692
    if not node_result or not isinstance(node_result, dict):
693
      feedback_fn("  - ERROR: unable to verify node %s." % (node,))
694
      return True
695

    
696
    # compares ganeti version
697
    local_version = constants.PROTOCOL_VERSION
698
    remote_version = node_result.get('version', None)
699
    if not (remote_version and isinstance(remote_version, (list, tuple)) and
700
            len(remote_version) == 2):
701
      feedback_fn("  - ERROR: connection to %s failed" % (node))
702
      return True
703

    
704
    if local_version != remote_version[0]:
705
      feedback_fn("  - ERROR: incompatible protocol versions: master %s,"
706
                  " node %s %s" % (local_version, node, remote_version[0]))
707
      return True
708

    
709
    # node seems compatible, we can actually try to look into its results
710

    
711
    bad = False
712

    
713
    # full package version
714
    if constants.RELEASE_VERSION != remote_version[1]:
715
      feedback_fn("  - WARNING: software version mismatch: master %s,"
716
                  " node %s %s" %
717
                  (constants.RELEASE_VERSION, node, remote_version[1]))
718

    
719
    # checks vg existence and size > 20G
720
    if vg_name is not None:
721
      vglist = node_result.get(constants.NV_VGLIST, None)
722
      if not vglist:
723
        feedback_fn("  - ERROR: unable to check volume groups on node %s." %
724
                        (node,))
725
        bad = True
726
      else:
727
        vgstatus = utils.CheckVolumeGroupSize(vglist, vg_name,
728
                                              constants.MIN_VG_SIZE)
729
        if vgstatus:
730
          feedback_fn("  - ERROR: %s on node %s" % (vgstatus, node))
731
          bad = True
732

    
733
    # checks config file checksum
734

    
735
    remote_cksum = node_result.get(constants.NV_FILELIST, None)
736
    if not isinstance(remote_cksum, dict):
737
      bad = True
738
      feedback_fn("  - ERROR: node hasn't returned file checksum data")
739
    else:
740
      for file_name in file_list:
741
        node_is_mc = nodeinfo.master_candidate
742
        must_have_file = file_name not in master_files
743
        if file_name not in remote_cksum:
744
          if node_is_mc or must_have_file:
745
            bad = True
746
            feedback_fn("  - ERROR: file '%s' missing" % file_name)
747
        elif remote_cksum[file_name] != local_cksum[file_name]:
748
          if node_is_mc or must_have_file:
749
            bad = True
750
            feedback_fn("  - ERROR: file '%s' has wrong checksum" % file_name)
751
          else:
752
            # not candidate and this is not a must-have file
753
            bad = True
754
            feedback_fn("  - ERROR: file '%s' should not exist on non master"
755
                        " candidates (and the file is outdated)" % file_name)
756
        else:
757
          # all good, except non-master/non-must have combination
758
          if not node_is_mc and not must_have_file:
759
            feedback_fn("  - ERROR: file '%s' should not exist on non master"
760
                        " candidates" % file_name)
761

    
762
    # checks ssh to any
763

    
764
    if constants.NV_NODELIST not in node_result:
765
      bad = True
766
      feedback_fn("  - ERROR: node hasn't returned node ssh connectivity data")
767
    else:
768
      if node_result[constants.NV_NODELIST]:
769
        bad = True
770
        for node in node_result[constants.NV_NODELIST]:
771
          feedback_fn("  - ERROR: ssh communication with node '%s': %s" %
772
                          (node, node_result[constants.NV_NODELIST][node]))
773

    
774
    if constants.NV_NODENETTEST not in node_result:
775
      bad = True
776
      feedback_fn("  - ERROR: node hasn't returned node tcp connectivity data")
777
    else:
778
      if node_result[constants.NV_NODENETTEST]:
779
        bad = True
780
        nlist = utils.NiceSort(node_result[constants.NV_NODENETTEST].keys())
781
        for node in nlist:
782
          feedback_fn("  - ERROR: tcp communication with node '%s': %s" %
783
                          (node, node_result[constants.NV_NODENETTEST][node]))
784

    
785
    hyp_result = node_result.get(constants.NV_HYPERVISOR, None)
786
    if isinstance(hyp_result, dict):
787
      for hv_name, hv_result in hyp_result.iteritems():
788
        if hv_result is not None:
789
          feedback_fn("  - ERROR: hypervisor %s verify failure: '%s'" %
790
                      (hv_name, hv_result))
791

    
792
    # check used drbd list
793
    if vg_name is not None:
794
      used_minors = node_result.get(constants.NV_DRBDLIST, [])
795
      if not isinstance(used_minors, (tuple, list)):
796
        feedback_fn("  - ERROR: cannot parse drbd status file: %s" %
797
                    str(used_minors))
798
      else:
799
        for minor, (iname, must_exist) in drbd_map.items():
800
          if minor not in used_minors and must_exist:
801
            feedback_fn("  - ERROR: drbd minor %d of instance %s is"
802
                        " not active" % (minor, iname))
803
            bad = True
804
        for minor in used_minors:
805
          if minor not in drbd_map:
806
            feedback_fn("  - ERROR: unallocated drbd minor %d is in use" %
807
                        minor)
808
            bad = True
809

    
810
    return bad
811

    
812
  def _VerifyInstance(self, instance, instanceconfig, node_vol_is,
813
                      node_instance, feedback_fn, n_offline):
814
    """Verify an instance.
815

816
    This function checks to see if the required block devices are
817
    available on the instance's node.
818

819
    """
820
    bad = False
821

    
822
    node_current = instanceconfig.primary_node
823

    
824
    node_vol_should = {}
825
    instanceconfig.MapLVsByNode(node_vol_should)
826

    
827
    for node in node_vol_should:
828
      if node in n_offline:
829
        # ignore missing volumes on offline nodes
830
        continue
831
      for volume in node_vol_should[node]:
832
        if node not in node_vol_is or volume not in node_vol_is[node]:
833
          feedback_fn("  - ERROR: volume %s missing on node %s" %
834
                          (volume, node))
835
          bad = True
836

    
837
    if instanceconfig.admin_up:
838
      if ((node_current not in node_instance or
839
          not instance in node_instance[node_current]) and
840
          node_current not in n_offline):
841
        feedback_fn("  - ERROR: instance %s not running on node %s" %
842
                        (instance, node_current))
843
        bad = True
844

    
845
    for node in node_instance:
846
      if (not node == node_current):
847
        if instance in node_instance[node]:
848
          feedback_fn("  - ERROR: instance %s should not run on node %s" %
849
                          (instance, node))
850
          bad = True
851

    
852
    return bad
853

    
854
  def _VerifyOrphanVolumes(self, node_vol_should, node_vol_is, feedback_fn):
855
    """Verify if there are any unknown volumes in the cluster.
856

857
    The .os, .swap and backup volumes are ignored. All other volumes are
858
    reported as unknown.
859

860
    """
861
    bad = False
862

    
863
    for node in node_vol_is:
864
      for volume in node_vol_is[node]:
865
        if node not in node_vol_should or volume not in node_vol_should[node]:
866
          feedback_fn("  - ERROR: volume %s on node %s should not exist" %
867
                      (volume, node))
868
          bad = True
869
    return bad
870

    
871
  def _VerifyOrphanInstances(self, instancelist, node_instance, feedback_fn):
872
    """Verify the list of running instances.
873

874
    This checks what instances are running but unknown to the cluster.
875

876
    """
877
    bad = False
878
    for node in node_instance:
879
      for runninginstance in node_instance[node]:
880
        if runninginstance not in instancelist:
881
          feedback_fn("  - ERROR: instance %s on node %s should not exist" %
882
                          (runninginstance, node))
883
          bad = True
884
    return bad
885

    
886
  def _VerifyNPlusOneMemory(self, node_info, instance_cfg, feedback_fn):
887
    """Verify N+1 Memory Resilience.
888

889
    Check that if one single node dies we can still start all the instances it
890
    was primary for.
891

892
    """
893
    bad = False
894

    
895
    for node, nodeinfo in node_info.iteritems():
896
      # This code checks that every node which is now listed as secondary has
897
      # enough memory to host all instances it is supposed to should a single
898
      # other node in the cluster fail.
899
      # FIXME: not ready for failover to an arbitrary node
900
      # FIXME: does not support file-backed instances
901
      # WARNING: we currently take into account down instances as well as up
902
      # ones, considering that even if they're down someone might want to start
903
      # them even in the event of a node failure.
904
      for prinode, instances in nodeinfo['sinst-by-pnode'].iteritems():
905
        needed_mem = 0
906
        for instance in instances:
907
          bep = self.cfg.GetClusterInfo().FillBE(instance_cfg[instance])
908
          if bep[constants.BE_AUTO_BALANCE]:
909
            needed_mem += bep[constants.BE_MEMORY]
910
        if nodeinfo['mfree'] < needed_mem:
911
          feedback_fn("  - ERROR: not enough memory on node %s to accomodate"
912
                      " failovers should node %s fail" % (node, prinode))
913
          bad = True
914
    return bad
915

    
916
  def CheckPrereq(self):
917
    """Check prerequisites.
918

919
    Transform the list of checks we're going to skip into a set and check that
920
    all its members are valid.
921

922
    """
923
    self.skip_set = frozenset(self.op.skip_checks)
924
    if not constants.VERIFY_OPTIONAL_CHECKS.issuperset(self.skip_set):
925
      raise errors.OpPrereqError("Invalid checks to be skipped specified")
926

    
927
  def BuildHooksEnv(self):
928
    """Build hooks env.
929

930
    Cluster-Verify hooks just rone in the post phase and their failure makes
931
    the output be logged in the verify output and the verification to fail.
932

933
    """
934
    all_nodes = self.cfg.GetNodeList()
935
    env = {
936
      "CLUSTER_TAGS": " ".join(self.cfg.GetClusterInfo().GetTags())
937
      }
938
    for node in self.cfg.GetAllNodesInfo().values():
939
      env["NODE_TAGS_%s" % node.name] = " ".join(node.GetTags())
940

    
941
    return env, [], all_nodes
942

    
943
  def Exec(self, feedback_fn):
944
    """Verify integrity of cluster, performing various test on nodes.
945

946
    """
947
    bad = False
948
    feedback_fn("* Verifying global settings")
949
    for msg in self.cfg.VerifyConfig():
950
      feedback_fn("  - ERROR: %s" % msg)
951

    
952
    vg_name = self.cfg.GetVGName()
953
    hypervisors = self.cfg.GetClusterInfo().enabled_hypervisors
954
    nodelist = utils.NiceSort(self.cfg.GetNodeList())
955
    nodeinfo = [self.cfg.GetNodeInfo(nname) for nname in nodelist]
956
    instancelist = utils.NiceSort(self.cfg.GetInstanceList())
957
    instanceinfo = dict((iname, self.cfg.GetInstanceInfo(iname))
958
                        for iname in instancelist)
959
    i_non_redundant = [] # Non redundant instances
960
    i_non_a_balanced = [] # Non auto-balanced instances
961
    n_offline = [] # List of offline nodes
962
    n_drained = [] # List of nodes being drained
963
    node_volume = {}
964
    node_instance = {}
965
    node_info = {}
966
    instance_cfg = {}
967

    
968
    # FIXME: verify OS list
969
    # do local checksums
970
    master_files = [constants.CLUSTER_CONF_FILE]
971

    
972
    file_names = ssconf.SimpleStore().GetFileList()
973
    file_names.append(constants.SSL_CERT_FILE)
974
    file_names.append(constants.RAPI_CERT_FILE)
975
    file_names.extend(master_files)
976

    
977
    local_checksums = utils.FingerprintFiles(file_names)
978

    
979
    feedback_fn("* Gathering data (%d nodes)" % len(nodelist))
980
    node_verify_param = {
981
      constants.NV_FILELIST: file_names,
982
      constants.NV_NODELIST: [node.name for node in nodeinfo
983
                              if not node.offline],
984
      constants.NV_HYPERVISOR: hypervisors,
985
      constants.NV_NODENETTEST: [(node.name, node.primary_ip,
986
                                  node.secondary_ip) for node in nodeinfo
987
                                 if not node.offline],
988
      constants.NV_INSTANCELIST: hypervisors,
989
      constants.NV_VERSION: None,
990
      constants.NV_HVINFO: self.cfg.GetHypervisorType(),
991
      }
992
    if vg_name is not None:
993
      node_verify_param[constants.NV_VGLIST] = None
994
      node_verify_param[constants.NV_LVLIST] = vg_name
995
      node_verify_param[constants.NV_DRBDLIST] = None
996
    all_nvinfo = self.rpc.call_node_verify(nodelist, node_verify_param,
997
                                           self.cfg.GetClusterName())
998

    
999
    cluster = self.cfg.GetClusterInfo()
1000
    master_node = self.cfg.GetMasterNode()
1001
    all_drbd_map = self.cfg.ComputeDRBDMap()
1002

    
1003
    for node_i in nodeinfo:
1004
      node = node_i.name
1005
      nresult = all_nvinfo[node].data
1006

    
1007
      if node_i.offline:
1008
        feedback_fn("* Skipping offline node %s" % (node,))
1009
        n_offline.append(node)
1010
        continue
1011

    
1012
      if node == master_node:
1013
        ntype = "master"
1014
      elif node_i.master_candidate:
1015
        ntype = "master candidate"
1016
      elif node_i.drained:
1017
        ntype = "drained"
1018
        n_drained.append(node)
1019
      else:
1020
        ntype = "regular"
1021
      feedback_fn("* Verifying node %s (%s)" % (node, ntype))
1022

    
1023
      if all_nvinfo[node].failed or not isinstance(nresult, dict):
1024
        feedback_fn("  - ERROR: connection to %s failed" % (node,))
1025
        bad = True
1026
        continue
1027

    
1028
      node_drbd = {}
1029
      for minor, instance in all_drbd_map[node].items():
1030
        if instance not in instanceinfo:
1031
          feedback_fn("  - ERROR: ghost instance '%s' in temporary DRBD map" %
1032
                      instance)
1033
          # ghost instance should not be running, but otherwise we
1034
          # don't give double warnings (both ghost instance and
1035
          # unallocated minor in use)
1036
          node_drbd[minor] = (instance, False)
1037
        else:
1038
          instance = instanceinfo[instance]
1039
          node_drbd[minor] = (instance.name, instance.admin_up)
1040
      result = self._VerifyNode(node_i, file_names, local_checksums,
1041
                                nresult, feedback_fn, master_files,
1042
                                node_drbd, vg_name)
1043
      bad = bad or result
1044

    
1045
      lvdata = nresult.get(constants.NV_LVLIST, "Missing LV data")
1046
      if vg_name is None:
1047
        node_volume[node] = {}
1048
      elif isinstance(lvdata, basestring):
1049
        feedback_fn("  - ERROR: LVM problem on node %s: %s" %
1050
                    (node, utils.SafeEncode(lvdata)))
1051
        bad = True
1052
        node_volume[node] = {}
1053
      elif not isinstance(lvdata, dict):
1054
        feedback_fn("  - ERROR: connection to %s failed (lvlist)" % (node,))
1055
        bad = True
1056
        continue
1057
      else:
1058
        node_volume[node] = lvdata
1059

    
1060
      # node_instance
1061
      idata = nresult.get(constants.NV_INSTANCELIST, None)
1062
      if not isinstance(idata, list):
1063
        feedback_fn("  - ERROR: connection to %s failed (instancelist)" %
1064
                    (node,))
1065
        bad = True
1066
        continue
1067

    
1068
      node_instance[node] = idata
1069

    
1070
      # node_info
1071
      nodeinfo = nresult.get(constants.NV_HVINFO, None)
1072
      if not isinstance(nodeinfo, dict):
1073
        feedback_fn("  - ERROR: connection to %s failed (hvinfo)" % (node,))
1074
        bad = True
1075
        continue
1076

    
1077
      try:
1078
        node_info[node] = {
1079
          "mfree": int(nodeinfo['memory_free']),
1080
          "pinst": [],
1081
          "sinst": [],
1082
          # dictionary holding all instances this node is secondary for,
1083
          # grouped by their primary node. Each key is a cluster node, and each
1084
          # value is a list of instances which have the key as primary and the
1085
          # current node as secondary.  this is handy to calculate N+1 memory
1086
          # availability if you can only failover from a primary to its
1087
          # secondary.
1088
          "sinst-by-pnode": {},
1089
        }
1090
        # FIXME: devise a free space model for file based instances as well
1091
        if vg_name is not None:
1092
          if (constants.NV_VGLIST not in nresult or
1093
              vg_name not in nresult[constants.NV_VGLIST]):
1094
            feedback_fn("  - ERROR: node %s didn't return data for the"
1095
                        " volume group '%s' - it is either missing or broken" %
1096
                        (node, vg_name))
1097
            bad = True
1098
            continue
1099
          node_info[node]["dfree"] = int(nresult[constants.NV_VGLIST][vg_name])
1100
      except (ValueError, KeyError):
1101
        feedback_fn("  - ERROR: invalid nodeinfo value returned"
1102
                    " from node %s" % (node,))
1103
        bad = True
1104
        continue
1105

    
1106
    node_vol_should = {}
1107

    
1108
    for instance in instancelist:
1109
      feedback_fn("* Verifying instance %s" % instance)
1110
      inst_config = instanceinfo[instance]
1111
      result =  self._VerifyInstance(instance, inst_config, node_volume,
1112
                                     node_instance, feedback_fn, n_offline)
1113
      bad = bad or result
1114
      inst_nodes_offline = []
1115

    
1116
      inst_config.MapLVsByNode(node_vol_should)
1117

    
1118
      instance_cfg[instance] = inst_config
1119

    
1120
      pnode = inst_config.primary_node
1121
      if pnode in node_info:
1122
        node_info[pnode]['pinst'].append(instance)
1123
      elif pnode not in n_offline:
1124
        feedback_fn("  - ERROR: instance %s, connection to primary node"
1125
                    " %s failed" % (instance, pnode))
1126
        bad = True
1127

    
1128
      if pnode in n_offline:
1129
        inst_nodes_offline.append(pnode)
1130

    
1131
      # If the instance is non-redundant we cannot survive losing its primary
1132
      # node, so we are not N+1 compliant. On the other hand we have no disk
1133
      # templates with more than one secondary so that situation is not well
1134
      # supported either.
1135
      # FIXME: does not support file-backed instances
1136
      if len(inst_config.secondary_nodes) == 0:
1137
        i_non_redundant.append(instance)
1138
      elif len(inst_config.secondary_nodes) > 1:
1139
        feedback_fn("  - WARNING: multiple secondaries for instance %s"
1140
                    % instance)
1141

    
1142
      if not cluster.FillBE(inst_config)[constants.BE_AUTO_BALANCE]:
1143
        i_non_a_balanced.append(instance)
1144

    
1145
      for snode in inst_config.secondary_nodes:
1146
        if snode in node_info:
1147
          node_info[snode]['sinst'].append(instance)
1148
          if pnode not in node_info[snode]['sinst-by-pnode']:
1149
            node_info[snode]['sinst-by-pnode'][pnode] = []
1150
          node_info[snode]['sinst-by-pnode'][pnode].append(instance)
1151
        elif snode not in n_offline:
1152
          feedback_fn("  - ERROR: instance %s, connection to secondary node"
1153
                      " %s failed" % (instance, snode))
1154
          bad = True
1155
        if snode in n_offline:
1156
          inst_nodes_offline.append(snode)
1157

    
1158
      if inst_nodes_offline:
1159
        # warn that the instance lives on offline nodes, and set bad=True
1160
        feedback_fn("  - ERROR: instance lives on offline node(s) %s" %
1161
                    ", ".join(inst_nodes_offline))
1162
        bad = True
1163

    
1164
    feedback_fn("* Verifying orphan volumes")
1165
    result = self._VerifyOrphanVolumes(node_vol_should, node_volume,
1166
                                       feedback_fn)
1167
    bad = bad or result
1168

    
1169
    feedback_fn("* Verifying remaining instances")
1170
    result = self._VerifyOrphanInstances(instancelist, node_instance,
1171
                                         feedback_fn)
1172
    bad = bad or result
1173

    
1174
    if constants.VERIFY_NPLUSONE_MEM not in self.skip_set:
1175
      feedback_fn("* Verifying N+1 Memory redundancy")
1176
      result = self._VerifyNPlusOneMemory(node_info, instance_cfg, feedback_fn)
1177
      bad = bad or result
1178

    
1179
    feedback_fn("* Other Notes")
1180
    if i_non_redundant:
1181
      feedback_fn("  - NOTICE: %d non-redundant instance(s) found."
1182
                  % len(i_non_redundant))
1183

    
1184
    if i_non_a_balanced:
1185
      feedback_fn("  - NOTICE: %d non-auto-balanced instance(s) found."
1186
                  % len(i_non_a_balanced))
1187

    
1188
    if n_offline:
1189
      feedback_fn("  - NOTICE: %d offline node(s) found." % len(n_offline))
1190

    
1191
    if n_drained:
1192
      feedback_fn("  - NOTICE: %d drained node(s) found." % len(n_drained))
1193

    
1194
    return not bad
1195

    
1196
  def HooksCallBack(self, phase, hooks_results, feedback_fn, lu_result):
1197
    """Analize the post-hooks' result
1198

1199
    This method analyses the hook result, handles it, and sends some
1200
    nicely-formatted feedback back to the user.
1201

1202
    @param phase: one of L{constants.HOOKS_PHASE_POST} or
1203
        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
1204
    @param hooks_results: the results of the multi-node hooks rpc call
1205
    @param feedback_fn: function used send feedback back to the caller
1206
    @param lu_result: previous Exec result
1207
    @return: the new Exec result, based on the previous result
1208
        and hook results
1209

1210
    """
1211
    # We only really run POST phase hooks, and are only interested in
1212
    # their results
1213
    if phase == constants.HOOKS_PHASE_POST:
1214
      # Used to change hooks' output to proper indentation
1215
      indent_re = re.compile('^', re.M)
1216
      feedback_fn("* Hooks Results")
1217
      if not hooks_results:
1218
        feedback_fn("  - ERROR: general communication failure")
1219
        lu_result = 1
1220
      else:
1221
        for node_name in hooks_results:
1222
          show_node_header = True
1223
          res = hooks_results[node_name]
1224
          if res.failed or res.data is False or not isinstance(res.data, list):
1225
            if res.offline:
1226
              # no need to warn or set fail return value
1227
              continue
1228
            feedback_fn("    Communication failure in hooks execution")
1229
            lu_result = 1
1230
            continue
1231
          for script, hkr, output in res.data:
1232
            if hkr == constants.HKR_FAIL:
1233
              # The node header is only shown once, if there are
1234
              # failing hooks on that node
1235
              if show_node_header:
1236
                feedback_fn("  Node %s:" % node_name)
1237
                show_node_header = False
1238
              feedback_fn("    ERROR: Script %s failed, output:" % script)
1239
              output = indent_re.sub('      ', output)
1240
              feedback_fn("%s" % output)
1241
              lu_result = 1
1242

    
1243
      return lu_result
1244

    
1245

    
1246
class LUVerifyDisks(NoHooksLU):
1247
  """Verifies the cluster disks status.
1248

1249
  """
1250
  _OP_REQP = []
1251
  REQ_BGL = False
1252

    
1253
  def ExpandNames(self):
1254
    self.needed_locks = {
1255
      locking.LEVEL_NODE: locking.ALL_SET,
1256
      locking.LEVEL_INSTANCE: locking.ALL_SET,
1257
    }
1258
    self.share_locks = dict(((i, 1) for i in locking.LEVELS))
1259

    
1260
  def CheckPrereq(self):
1261
    """Check prerequisites.
1262

1263
    This has no prerequisites.
1264

1265
    """
1266
    pass
1267

    
1268
  def Exec(self, feedback_fn):
1269
    """Verify integrity of cluster disks.
1270

1271
    """
1272
    result = res_nodes, res_nlvm, res_instances, res_missing = [], {}, [], {}
1273

    
1274
    vg_name = self.cfg.GetVGName()
1275
    nodes = utils.NiceSort(self.cfg.GetNodeList())
1276
    instances = [self.cfg.GetInstanceInfo(name)
1277
                 for name in self.cfg.GetInstanceList()]
1278

    
1279
    nv_dict = {}
1280
    for inst in instances:
1281
      inst_lvs = {}
1282
      if (not inst.admin_up or
1283
          inst.disk_template not in constants.DTS_NET_MIRROR):
1284
        continue
1285
      inst.MapLVsByNode(inst_lvs)
1286
      # transform { iname: {node: [vol,],},} to {(node, vol): iname}
1287
      for node, vol_list in inst_lvs.iteritems():
1288
        for vol in vol_list:
1289
          nv_dict[(node, vol)] = inst
1290

    
1291
    if not nv_dict:
1292
      return result
1293

    
1294
    node_lvs = self.rpc.call_volume_list(nodes, vg_name)
1295

    
1296
    to_act = set()
1297
    for node in nodes:
1298
      # node_volume
1299
      lvs = node_lvs[node]
1300
      if lvs.failed:
1301
        if not lvs.offline:
1302
          self.LogWarning("Connection to node %s failed: %s" %
1303
                          (node, lvs.data))
1304
        continue
1305
      lvs = lvs.data
1306
      if isinstance(lvs, basestring):
1307
        logging.warning("Error enumerating LVs on node %s: %s", node, lvs)
1308
        res_nlvm[node] = lvs
1309
        continue
1310
      elif not isinstance(lvs, dict):
1311
        logging.warning("Connection to node %s failed or invalid data"
1312
                        " returned", node)
1313
        res_nodes.append(node)
1314
        continue
1315

    
1316
      for lv_name, (_, lv_inactive, lv_online) in lvs.iteritems():
1317
        inst = nv_dict.pop((node, lv_name), None)
1318
        if (not lv_online and inst is not None
1319
            and inst.name not in res_instances):
1320
          res_instances.append(inst.name)
1321

    
1322
    # any leftover items in nv_dict are missing LVs, let's arrange the
1323
    # data better
1324
    for key, inst in nv_dict.iteritems():
1325
      if inst.name not in res_missing:
1326
        res_missing[inst.name] = []
1327
      res_missing[inst.name].append(key)
1328

    
1329
    return result
1330

    
1331

    
1332
class LURenameCluster(LogicalUnit):
1333
  """Rename the cluster.
1334

1335
  """
1336
  HPATH = "cluster-rename"
1337
  HTYPE = constants.HTYPE_CLUSTER
1338
  _OP_REQP = ["name"]
1339

    
1340
  def BuildHooksEnv(self):
1341
    """Build hooks env.
1342

1343
    """
1344
    env = {
1345
      "OP_TARGET": self.cfg.GetClusterName(),
1346
      "NEW_NAME": self.op.name,
1347
      }
1348
    mn = self.cfg.GetMasterNode()
1349
    return env, [mn], [mn]
1350

    
1351
  def CheckPrereq(self):
1352
    """Verify that the passed name is a valid one.
1353

1354
    """
1355
    hostname = utils.HostInfo(self.op.name)
1356

    
1357
    new_name = hostname.name
1358
    self.ip = new_ip = hostname.ip
1359
    old_name = self.cfg.GetClusterName()
1360
    old_ip = self.cfg.GetMasterIP()
1361
    if new_name == old_name and new_ip == old_ip:
1362
      raise errors.OpPrereqError("Neither the name nor the IP address of the"
1363
                                 " cluster has changed")
1364
    if new_ip != old_ip:
1365
      if utils.TcpPing(new_ip, constants.DEFAULT_NODED_PORT):
1366
        raise errors.OpPrereqError("The given cluster IP address (%s) is"
1367
                                   " reachable on the network. Aborting." %
1368
                                   new_ip)
1369

    
1370
    self.op.name = new_name
1371

    
1372
  def Exec(self, feedback_fn):
1373
    """Rename the cluster.
1374

1375
    """
1376
    clustername = self.op.name
1377
    ip = self.ip
1378

    
1379
    # shutdown the master IP
1380
    master = self.cfg.GetMasterNode()
1381
    result = self.rpc.call_node_stop_master(master, False)
1382
    if result.failed or not result.data:
1383
      raise errors.OpExecError("Could not disable the master role")
1384

    
1385
    try:
1386
      cluster = self.cfg.GetClusterInfo()
1387
      cluster.cluster_name = clustername
1388
      cluster.master_ip = ip
1389
      self.cfg.Update(cluster)
1390

    
1391
      # update the known hosts file
1392
      ssh.WriteKnownHostsFile(self.cfg, constants.SSH_KNOWN_HOSTS_FILE)
1393
      node_list = self.cfg.GetNodeList()
1394
      try:
1395
        node_list.remove(master)
1396
      except ValueError:
1397
        pass
1398
      result = self.rpc.call_upload_file(node_list,
1399
                                         constants.SSH_KNOWN_HOSTS_FILE)
1400
      for to_node, to_result in result.iteritems():
1401
        if to_result.failed or not to_result.data:
1402
          logging.error("Copy of file %s to node %s failed",
1403
                        constants.SSH_KNOWN_HOSTS_FILE, to_node)
1404

    
1405
    finally:
1406
      result = self.rpc.call_node_start_master(master, False)
1407
      if result.failed or not result.data:
1408
        self.LogWarning("Could not re-enable the master role on"
1409
                        " the master, please restart manually.")
1410

    
1411

    
1412
def _RecursiveCheckIfLVMBased(disk):
1413
  """Check if the given disk or its children are lvm-based.
1414

1415
  @type disk: L{objects.Disk}
1416
  @param disk: the disk to check
1417
  @rtype: booleean
1418
  @return: boolean indicating whether a LD_LV dev_type was found or not
1419

1420
  """
1421
  if disk.children:
1422
    for chdisk in disk.children:
1423
      if _RecursiveCheckIfLVMBased(chdisk):
1424
        return True
1425
  return disk.dev_type == constants.LD_LV
1426

    
1427

    
1428
class LUSetClusterParams(LogicalUnit):
1429
  """Change the parameters of the cluster.
1430

1431
  """
1432
  HPATH = "cluster-modify"
1433
  HTYPE = constants.HTYPE_CLUSTER
1434
  _OP_REQP = []
1435
  REQ_BGL = False
1436

    
1437
  def CheckArguments(self):
1438
    """Check parameters
1439

1440
    """
1441
    if not hasattr(self.op, "candidate_pool_size"):
1442
      self.op.candidate_pool_size = None
1443
    if self.op.candidate_pool_size is not None:
1444
      try:
1445
        self.op.candidate_pool_size = int(self.op.candidate_pool_size)
1446
      except (ValueError, TypeError), err:
1447
        raise errors.OpPrereqError("Invalid candidate_pool_size value: %s" %
1448
                                   str(err))
1449
      if self.op.candidate_pool_size < 1:
1450
        raise errors.OpPrereqError("At least one master candidate needed")
1451

    
1452
  def ExpandNames(self):
1453
    # FIXME: in the future maybe other cluster params won't require checking on
1454
    # all nodes to be modified.
1455
    self.needed_locks = {
1456
      locking.LEVEL_NODE: locking.ALL_SET,
1457
    }
1458
    self.share_locks[locking.LEVEL_NODE] = 1
1459

    
1460
  def BuildHooksEnv(self):
1461
    """Build hooks env.
1462

1463
    """
1464
    env = {
1465
      "OP_TARGET": self.cfg.GetClusterName(),
1466
      "NEW_VG_NAME": self.op.vg_name,
1467
      }
1468
    mn = self.cfg.GetMasterNode()
1469
    return env, [mn], [mn]
1470

    
1471
  def CheckPrereq(self):
1472
    """Check prerequisites.
1473

1474
    This checks whether the given params don't conflict and
1475
    if the given volume group is valid.
1476

1477
    """
1478
    if self.op.vg_name is not None and not self.op.vg_name:
1479
      instances = self.cfg.GetAllInstancesInfo().values()
1480
      for inst in instances:
1481
        for disk in inst.disks:
1482
          if _RecursiveCheckIfLVMBased(disk):
1483
            raise errors.OpPrereqError("Cannot disable lvm storage while"
1484
                                       " lvm-based instances exist")
1485

    
1486
    node_list = self.acquired_locks[locking.LEVEL_NODE]
1487

    
1488
    # if vg_name not None, checks given volume group on all nodes
1489
    if self.op.vg_name:
1490
      vglist = self.rpc.call_vg_list(node_list)
1491
      for node in node_list:
1492
        if vglist[node].failed:
1493
          # ignoring down node
1494
          self.LogWarning("Node %s unreachable/error, ignoring" % node)
1495
          continue
1496
        vgstatus = utils.CheckVolumeGroupSize(vglist[node].data,
1497
                                              self.op.vg_name,
1498
                                              constants.MIN_VG_SIZE)
1499
        if vgstatus:
1500
          raise errors.OpPrereqError("Error on node '%s': %s" %
1501
                                     (node, vgstatus))
1502

    
1503
    self.cluster = cluster = self.cfg.GetClusterInfo()
1504
    # validate beparams changes
1505
    if self.op.beparams:
1506
      utils.ForceDictType(self.op.beparams, constants.BES_PARAMETER_TYPES)
1507
      self.new_beparams = cluster.FillDict(
1508
        cluster.beparams[constants.BEGR_DEFAULT], self.op.beparams)
1509

    
1510
    # hypervisor list/parameters
1511
    self.new_hvparams = cluster.FillDict(cluster.hvparams, {})
1512
    if self.op.hvparams:
1513
      if not isinstance(self.op.hvparams, dict):
1514
        raise errors.OpPrereqError("Invalid 'hvparams' parameter on input")
1515
      for hv_name, hv_dict in self.op.hvparams.items():
1516
        if hv_name not in self.new_hvparams:
1517
          self.new_hvparams[hv_name] = hv_dict
1518
        else:
1519
          self.new_hvparams[hv_name].update(hv_dict)
1520

    
1521
    if self.op.enabled_hypervisors is not None:
1522
      self.hv_list = self.op.enabled_hypervisors
1523
    else:
1524
      self.hv_list = cluster.enabled_hypervisors
1525

    
1526
    if self.op.hvparams or self.op.enabled_hypervisors is not None:
1527
      # either the enabled list has changed, or the parameters have, validate
1528
      for hv_name, hv_params in self.new_hvparams.items():
1529
        if ((self.op.hvparams and hv_name in self.op.hvparams) or
1530
            (self.op.enabled_hypervisors and
1531
             hv_name in self.op.enabled_hypervisors)):
1532
          # either this is a new hypervisor, or its parameters have changed
1533
          hv_class = hypervisor.GetHypervisor(hv_name)
1534
          utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
1535
          hv_class.CheckParameterSyntax(hv_params)
1536
          _CheckHVParams(self, node_list, hv_name, hv_params)
1537

    
1538
  def Exec(self, feedback_fn):
1539
    """Change the parameters of the cluster.
1540

1541
    """
1542
    if self.op.vg_name is not None:
1543
      new_volume = self.op.vg_name
1544
      if not new_volume:
1545
        new_volume = None
1546
      if new_volume != self.cfg.GetVGName():
1547
        self.cfg.SetVGName(new_volume)
1548
      else:
1549
        feedback_fn("Cluster LVM configuration already in desired"
1550
                    " state, not changing")
1551
    if self.op.hvparams:
1552
      self.cluster.hvparams = self.new_hvparams
1553
    if self.op.enabled_hypervisors is not None:
1554
      self.cluster.enabled_hypervisors = self.op.enabled_hypervisors
1555
    if self.op.beparams:
1556
      self.cluster.beparams[constants.BEGR_DEFAULT] = self.new_beparams
1557
    if self.op.candidate_pool_size is not None:
1558
      self.cluster.candidate_pool_size = self.op.candidate_pool_size
1559
      # we need to update the pool size here, otherwise the save will fail
1560
      _AdjustCandidatePool(self)
1561

    
1562
    self.cfg.Update(self.cluster)
1563

    
1564

    
1565
class LURedistributeConfig(NoHooksLU):
1566
  """Force the redistribution of cluster configuration.
1567

1568
  This is a very simple LU.
1569

1570
  """
1571
  _OP_REQP = []
1572
  REQ_BGL = False
1573

    
1574
  def ExpandNames(self):
1575
    self.needed_locks = {
1576
      locking.LEVEL_NODE: locking.ALL_SET,
1577
    }
1578
    self.share_locks[locking.LEVEL_NODE] = 1
1579

    
1580
  def CheckPrereq(self):
1581
    """Check prerequisites.
1582

1583
    """
1584

    
1585
  def Exec(self, feedback_fn):
1586
    """Redistribute the configuration.
1587

1588
    """
1589
    self.cfg.Update(self.cfg.GetClusterInfo())
1590

    
1591

    
1592
def _WaitForSync(lu, instance, oneshot=False, unlock=False):
1593
  """Sleep and poll for an instance's disk to sync.
1594

1595
  """
1596
  if not instance.disks:
1597
    return True
1598

    
1599
  if not oneshot:
1600
    lu.proc.LogInfo("Waiting for instance %s to sync disks." % instance.name)
1601

    
1602
  node = instance.primary_node
1603

    
1604
  for dev in instance.disks:
1605
    lu.cfg.SetDiskID(dev, node)
1606

    
1607
  retries = 0
1608
  degr_retries = 10 # in seconds, as we sleep 1 second each time
1609
  while True:
1610
    max_time = 0
1611
    done = True
1612
    cumul_degraded = False
1613
    rstats = lu.rpc.call_blockdev_getmirrorstatus(node, instance.disks)
1614
    if rstats.failed or not rstats.data:
1615
      lu.LogWarning("Can't get any data from node %s", node)
1616
      retries += 1
1617
      if retries >= 10:
1618
        raise errors.RemoteError("Can't contact node %s for mirror data,"
1619
                                 " aborting." % node)
1620
      time.sleep(6)
1621
      continue
1622
    rstats = rstats.data
1623
    retries = 0
1624
    for i, mstat in enumerate(rstats):
1625
      if mstat is None:
1626
        lu.LogWarning("Can't compute data for node %s/%s",
1627
                           node, instance.disks[i].iv_name)
1628
        continue
1629
      # we ignore the ldisk parameter
1630
      perc_done, est_time, is_degraded, _ = mstat
1631
      cumul_degraded = cumul_degraded or (is_degraded and perc_done is None)
1632
      if perc_done is not None:
1633
        done = False
1634
        if est_time is not None:
1635
          rem_time = "%d estimated seconds remaining" % est_time
1636
          max_time = est_time
1637
        else:
1638
          rem_time = "no time estimate"
1639
        lu.proc.LogInfo("- device %s: %5.2f%% done, %s" %
1640
                        (instance.disks[i].iv_name, perc_done, rem_time))
1641

    
1642
    # if we're done but degraded, let's do a few small retries, to
1643
    # make sure we see a stable and not transient situation; therefore
1644
    # we force restart of the loop
1645
    if (done or oneshot) and cumul_degraded and degr_retries > 0:
1646
      logging.info("Degraded disks found, %d retries left", degr_retries)
1647
      degr_retries -= 1
1648
      time.sleep(1)
1649
      continue
1650

    
1651
    if done or oneshot:
1652
      break
1653

    
1654
    time.sleep(min(60, max_time))
1655

    
1656
  if done:
1657
    lu.proc.LogInfo("Instance %s's disks are in sync." % instance.name)
1658
  return not cumul_degraded
1659

    
1660

    
1661
def _CheckDiskConsistency(lu, dev, node, on_primary, ldisk=False):
1662
  """Check that mirrors are not degraded.
1663

1664
  The ldisk parameter, if True, will change the test from the
1665
  is_degraded attribute (which represents overall non-ok status for
1666
  the device(s)) to the ldisk (representing the local storage status).
1667

1668
  """
1669
  lu.cfg.SetDiskID(dev, node)
1670
  if ldisk:
1671
    idx = 6
1672
  else:
1673
    idx = 5
1674

    
1675
  result = True
1676
  if on_primary or dev.AssembleOnSecondary():
1677
    rstats = lu.rpc.call_blockdev_find(node, dev)
1678
    msg = rstats.RemoteFailMsg()
1679
    if msg:
1680
      lu.LogWarning("Can't find disk on node %s: %s", node, msg)
1681
      result = False
1682
    elif not rstats.payload:
1683
      lu.LogWarning("Can't find disk on node %s", node)
1684
      result = False
1685
    else:
1686
      result = result and (not rstats.payload[idx])
1687
  if dev.children:
1688
    for child in dev.children:
1689
      result = result and _CheckDiskConsistency(lu, child, node, on_primary)
1690

    
1691
  return result
1692

    
1693

    
1694
class LUDiagnoseOS(NoHooksLU):
1695
  """Logical unit for OS diagnose/query.
1696

1697
  """
1698
  _OP_REQP = ["output_fields", "names"]
1699
  REQ_BGL = False
1700
  _FIELDS_STATIC = utils.FieldSet()
1701
  _FIELDS_DYNAMIC = utils.FieldSet("name", "valid", "node_status")
1702

    
1703
  def ExpandNames(self):
1704
    if self.op.names:
1705
      raise errors.OpPrereqError("Selective OS query not supported")
1706

    
1707
    _CheckOutputFields(static=self._FIELDS_STATIC,
1708
                       dynamic=self._FIELDS_DYNAMIC,
1709
                       selected=self.op.output_fields)
1710

    
1711
    # Lock all nodes, in shared mode
1712
    # Temporary removal of locks, should be reverted later
1713
    # TODO: reintroduce locks when they are lighter-weight
1714
    self.needed_locks = {}
1715
    #self.share_locks[locking.LEVEL_NODE] = 1
1716
    #self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
1717

    
1718
  def CheckPrereq(self):
1719
    """Check prerequisites.
1720

1721
    """
1722

    
1723
  @staticmethod
1724
  def _DiagnoseByOS(node_list, rlist):
1725
    """Remaps a per-node return list into an a per-os per-node dictionary
1726

1727
    @param node_list: a list with the names of all nodes
1728
    @param rlist: a map with node names as keys and OS objects as values
1729

1730
    @rtype: dict
1731
    @return: a dictionary with osnames as keys and as value another map, with
1732
        nodes as keys and list of OS objects as values, eg::
1733

1734
          {"debian-etch": {"node1": [<object>,...],
1735
                           "node2": [<object>,]}
1736
          }
1737

1738
    """
1739
    all_os = {}
1740
    # we build here the list of nodes that didn't fail the RPC (at RPC
1741
    # level), so that nodes with a non-responding node daemon don't
1742
    # make all OSes invalid
1743
    good_nodes = [node_name for node_name in rlist
1744
                  if not rlist[node_name].failed]
1745
    for node_name, nr in rlist.iteritems():
1746
      if nr.failed or not nr.data:
1747
        continue
1748
      for os_obj in nr.data:
1749
        if os_obj.name not in all_os:
1750
          # build a list of nodes for this os containing empty lists
1751
          # for each node in node_list
1752
          all_os[os_obj.name] = {}
1753
          for nname in good_nodes:
1754
            all_os[os_obj.name][nname] = []
1755
        all_os[os_obj.name][node_name].append(os_obj)
1756
    return all_os
1757

    
1758
  def Exec(self, feedback_fn):
1759
    """Compute the list of OSes.
1760

1761
    """
1762
    valid_nodes = [node for node in self.cfg.GetOnlineNodeList()]
1763
    node_data = self.rpc.call_os_diagnose(valid_nodes)
1764
    if node_data == False:
1765
      raise errors.OpExecError("Can't gather the list of OSes")
1766
    pol = self._DiagnoseByOS(valid_nodes, node_data)
1767
    output = []
1768
    for os_name, os_data in pol.iteritems():
1769
      row = []
1770
      for field in self.op.output_fields:
1771
        if field == "name":
1772
          val = os_name
1773
        elif field == "valid":
1774
          val = utils.all([osl and osl[0] for osl in os_data.values()])
1775
        elif field == "node_status":
1776
          val = {}
1777
          for node_name, nos_list in os_data.iteritems():
1778
            val[node_name] = [(v.status, v.path) for v in nos_list]
1779
        else:
1780
          raise errors.ParameterError(field)
1781
        row.append(val)
1782
      output.append(row)
1783

    
1784
    return output
1785

    
1786

    
1787
class LURemoveNode(LogicalUnit):
1788
  """Logical unit for removing a node.
1789

1790
  """
1791
  HPATH = "node-remove"
1792
  HTYPE = constants.HTYPE_NODE
1793
  _OP_REQP = ["node_name"]
1794

    
1795
  def BuildHooksEnv(self):
1796
    """Build hooks env.
1797

1798
    This doesn't run on the target node in the pre phase as a failed
1799
    node would then be impossible to remove.
1800

1801
    """
1802
    env = {
1803
      "OP_TARGET": self.op.node_name,
1804
      "NODE_NAME": self.op.node_name,
1805
      }
1806
    all_nodes = self.cfg.GetNodeList()
1807
    all_nodes.remove(self.op.node_name)
1808
    return env, all_nodes, all_nodes
1809

    
1810
  def CheckPrereq(self):
1811
    """Check prerequisites.
1812

1813
    This checks:
1814
     - the node exists in the configuration
1815
     - it does not have primary or secondary instances
1816
     - it's not the master
1817

1818
    Any errors are signalled by raising errors.OpPrereqError.
1819

1820
    """
1821
    node = self.cfg.GetNodeInfo(self.cfg.ExpandNodeName(self.op.node_name))
1822
    if node is None:
1823
      raise errors.OpPrereqError, ("Node '%s' is unknown." % self.op.node_name)
1824

    
1825
    instance_list = self.cfg.GetInstanceList()
1826

    
1827
    masternode = self.cfg.GetMasterNode()
1828
    if node.name == masternode:
1829
      raise errors.OpPrereqError("Node is the master node,"
1830
                                 " you need to failover first.")
1831

    
1832
    for instance_name in instance_list:
1833
      instance = self.cfg.GetInstanceInfo(instance_name)
1834
      if node.name in instance.all_nodes:
1835
        raise errors.OpPrereqError("Instance %s is still running on the node,"
1836
                                   " please remove first." % instance_name)
1837
    self.op.node_name = node.name
1838
    self.node = node
1839

    
1840
  def Exec(self, feedback_fn):
1841
    """Removes the node from the cluster.
1842

1843
    """
1844
    node = self.node
1845
    logging.info("Stopping the node daemon and removing configs from node %s",
1846
                 node.name)
1847

    
1848
    self.context.RemoveNode(node.name)
1849

    
1850
    self.rpc.call_node_leave_cluster(node.name)
1851

    
1852
    # Promote nodes to master candidate as needed
1853
    _AdjustCandidatePool(self)
1854

    
1855

    
1856
class LUQueryNodes(NoHooksLU):
1857
  """Logical unit for querying nodes.
1858

1859
  """
1860
  _OP_REQP = ["output_fields", "names", "use_locking"]
1861
  REQ_BGL = False
1862
  _FIELDS_DYNAMIC = utils.FieldSet(
1863
    "dtotal", "dfree",
1864
    "mtotal", "mnode", "mfree",
1865
    "bootid",
1866
    "ctotal", "cnodes", "csockets",
1867
    )
1868

    
1869
  _FIELDS_STATIC = utils.FieldSet(
1870
    "name", "pinst_cnt", "sinst_cnt",
1871
    "pinst_list", "sinst_list",
1872
    "pip", "sip", "tags",
1873
    "serial_no",
1874
    "master_candidate",
1875
    "master",
1876
    "offline",
1877
    "drained",
1878
    "role",
1879
    )
1880

    
1881
  def ExpandNames(self):
1882
    _CheckOutputFields(static=self._FIELDS_STATIC,
1883
                       dynamic=self._FIELDS_DYNAMIC,
1884
                       selected=self.op.output_fields)
1885

    
1886
    self.needed_locks = {}
1887
    self.share_locks[locking.LEVEL_NODE] = 1
1888

    
1889
    if self.op.names:
1890
      self.wanted = _GetWantedNodes(self, self.op.names)
1891
    else:
1892
      self.wanted = locking.ALL_SET
1893

    
1894
    self.do_node_query = self._FIELDS_STATIC.NonMatching(self.op.output_fields)
1895
    self.do_locking = self.do_node_query and self.op.use_locking
1896
    if self.do_locking:
1897
      # if we don't request only static fields, we need to lock the nodes
1898
      self.needed_locks[locking.LEVEL_NODE] = self.wanted
1899

    
1900

    
1901
  def CheckPrereq(self):
1902
    """Check prerequisites.
1903

1904
    """
1905
    # The validation of the node list is done in the _GetWantedNodes,
1906
    # if non empty, and if empty, there's no validation to do
1907
    pass
1908

    
1909
  def Exec(self, feedback_fn):
1910
    """Computes the list of nodes and their attributes.
1911

1912
    """
1913
    all_info = self.cfg.GetAllNodesInfo()
1914
    if self.do_locking:
1915
      nodenames = self.acquired_locks[locking.LEVEL_NODE]
1916
    elif self.wanted != locking.ALL_SET:
1917
      nodenames = self.wanted
1918
      missing = set(nodenames).difference(all_info.keys())
1919
      if missing:
1920
        raise errors.OpExecError(
1921
          "Some nodes were removed before retrieving their data: %s" % missing)
1922
    else:
1923
      nodenames = all_info.keys()
1924

    
1925
    nodenames = utils.NiceSort(nodenames)
1926
    nodelist = [all_info[name] for name in nodenames]
1927

    
1928
    # begin data gathering
1929

    
1930
    if self.do_node_query:
1931
      live_data = {}
1932
      node_data = self.rpc.call_node_info(nodenames, self.cfg.GetVGName(),
1933
                                          self.cfg.GetHypervisorType())
1934
      for name in nodenames:
1935
        nodeinfo = node_data[name]
1936
        if not nodeinfo.failed and nodeinfo.data:
1937
          nodeinfo = nodeinfo.data
1938
          fn = utils.TryConvert
1939
          live_data[name] = {
1940
            "mtotal": fn(int, nodeinfo.get('memory_total', None)),
1941
            "mnode": fn(int, nodeinfo.get('memory_dom0', None)),
1942
            "mfree": fn(int, nodeinfo.get('memory_free', None)),
1943
            "dtotal": fn(int, nodeinfo.get('vg_size', None)),
1944
            "dfree": fn(int, nodeinfo.get('vg_free', None)),
1945
            "ctotal": fn(int, nodeinfo.get('cpu_total', None)),
1946
            "bootid": nodeinfo.get('bootid', None),
1947
            "cnodes": fn(int, nodeinfo.get('cpu_nodes', None)),
1948
            "csockets": fn(int, nodeinfo.get('cpu_sockets', None)),
1949
            }
1950
        else:
1951
          live_data[name] = {}
1952
    else:
1953
      live_data = dict.fromkeys(nodenames, {})
1954

    
1955
    node_to_primary = dict([(name, set()) for name in nodenames])
1956
    node_to_secondary = dict([(name, set()) for name in nodenames])
1957

    
1958
    inst_fields = frozenset(("pinst_cnt", "pinst_list",
1959
                             "sinst_cnt", "sinst_list"))
1960
    if inst_fields & frozenset(self.op.output_fields):
1961
      instancelist = self.cfg.GetInstanceList()
1962

    
1963
      for instance_name in instancelist:
1964
        inst = self.cfg.GetInstanceInfo(instance_name)
1965
        if inst.primary_node in node_to_primary:
1966
          node_to_primary[inst.primary_node].add(inst.name)
1967
        for secnode in inst.secondary_nodes:
1968
          if secnode in node_to_secondary:
1969
            node_to_secondary[secnode].add(inst.name)
1970

    
1971
    master_node = self.cfg.GetMasterNode()
1972

    
1973
    # end data gathering
1974

    
1975
    output = []
1976
    for node in nodelist:
1977
      node_output = []
1978
      for field in self.op.output_fields:
1979
        if field == "name":
1980
          val = node.name
1981
        elif field == "pinst_list":
1982
          val = list(node_to_primary[node.name])
1983
        elif field == "sinst_list":
1984
          val = list(node_to_secondary[node.name])
1985
        elif field == "pinst_cnt":
1986
          val = len(node_to_primary[node.name])
1987
        elif field == "sinst_cnt":
1988
          val = len(node_to_secondary[node.name])
1989
        elif field == "pip":
1990
          val = node.primary_ip
1991
        elif field == "sip":
1992
          val = node.secondary_ip
1993
        elif field == "tags":
1994
          val = list(node.GetTags())
1995
        elif field == "serial_no":
1996
          val = node.serial_no
1997
        elif field == "master_candidate":
1998
          val = node.master_candidate
1999
        elif field == "master":
2000
          val = node.name == master_node
2001
        elif field == "offline":
2002
          val = node.offline
2003
        elif field == "drained":
2004
          val = node.drained
2005
        elif self._FIELDS_DYNAMIC.Matches(field):
2006
          val = live_data[node.name].get(field, None)
2007
        elif field == "role":
2008
          if node.name == master_node:
2009
            val = "M"
2010
          elif node.master_candidate:
2011
            val = "C"
2012
          elif node.drained:
2013
            val = "D"
2014
          elif node.offline:
2015
            val = "O"
2016
          else:
2017
            val = "R"
2018
        else:
2019
          raise errors.ParameterError(field)
2020
        node_output.append(val)
2021
      output.append(node_output)
2022

    
2023
    return output
2024

    
2025

    
2026
class LUQueryNodeVolumes(NoHooksLU):
2027
  """Logical unit for getting volumes on node(s).
2028

2029
  """
2030
  _OP_REQP = ["nodes", "output_fields"]
2031
  REQ_BGL = False
2032
  _FIELDS_DYNAMIC = utils.FieldSet("phys", "vg", "name", "size", "instance")
2033
  _FIELDS_STATIC = utils.FieldSet("node")
2034

    
2035
  def ExpandNames(self):
2036
    _CheckOutputFields(static=self._FIELDS_STATIC,
2037
                       dynamic=self._FIELDS_DYNAMIC,
2038
                       selected=self.op.output_fields)
2039

    
2040
    self.needed_locks = {}
2041
    self.share_locks[locking.LEVEL_NODE] = 1
2042
    if not self.op.nodes:
2043
      self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
2044
    else:
2045
      self.needed_locks[locking.LEVEL_NODE] = \
2046
        _GetWantedNodes(self, self.op.nodes)
2047

    
2048
  def CheckPrereq(self):
2049
    """Check prerequisites.
2050

2051
    This checks that the fields required are valid output fields.
2052

2053
    """
2054
    self.nodes = self.acquired_locks[locking.LEVEL_NODE]
2055

    
2056
  def Exec(self, feedback_fn):
2057
    """Computes the list of nodes and their attributes.
2058

2059
    """
2060
    nodenames = self.nodes
2061
    volumes = self.rpc.call_node_volumes(nodenames)
2062

    
2063
    ilist = [self.cfg.GetInstanceInfo(iname) for iname
2064
             in self.cfg.GetInstanceList()]
2065

    
2066
    lv_by_node = dict([(inst, inst.MapLVsByNode()) for inst in ilist])
2067

    
2068
    output = []
2069
    for node in nodenames:
2070
      if node not in volumes or volumes[node].failed or not volumes[node].data:
2071
        continue
2072

    
2073
      node_vols = volumes[node].data[:]
2074
      node_vols.sort(key=lambda vol: vol['dev'])
2075

    
2076
      for vol in node_vols:
2077
        node_output = []
2078
        for field in self.op.output_fields:
2079
          if field == "node":
2080
            val = node
2081
          elif field == "phys":
2082
            val = vol['dev']
2083
          elif field == "vg":
2084
            val = vol['vg']
2085
          elif field == "name":
2086
            val = vol['name']
2087
          elif field == "size":
2088
            val = int(float(vol['size']))
2089
          elif field == "instance":
2090
            for inst in ilist:
2091
              if node not in lv_by_node[inst]:
2092
                continue
2093
              if vol['name'] in lv_by_node[inst][node]:
2094
                val = inst.name
2095
                break
2096
            else:
2097
              val = '-'
2098
          else:
2099
            raise errors.ParameterError(field)
2100
          node_output.append(str(val))
2101

    
2102
        output.append(node_output)
2103

    
2104
    return output
2105

    
2106

    
2107
class LUAddNode(LogicalUnit):
2108
  """Logical unit for adding node to the cluster.
2109

2110
  """
2111
  HPATH = "node-add"
2112
  HTYPE = constants.HTYPE_NODE
2113
  _OP_REQP = ["node_name"]
2114

    
2115
  def BuildHooksEnv(self):
2116
    """Build hooks env.
2117

2118
    This will run on all nodes before, and on all nodes + the new node after.
2119

2120
    """
2121
    env = {
2122
      "OP_TARGET": self.op.node_name,
2123
      "NODE_NAME": self.op.node_name,
2124
      "NODE_PIP": self.op.primary_ip,
2125
      "NODE_SIP": self.op.secondary_ip,
2126
      }
2127
    nodes_0 = self.cfg.GetNodeList()
2128
    nodes_1 = nodes_0 + [self.op.node_name, ]
2129
    return env, nodes_0, nodes_1
2130

    
2131
  def CheckPrereq(self):
2132
    """Check prerequisites.
2133

2134
    This checks:
2135
     - the new node is not already in the config
2136
     - it is resolvable
2137
     - its parameters (single/dual homed) matches the cluster
2138

2139
    Any errors are signalled by raising errors.OpPrereqError.
2140

2141
    """
2142
    node_name = self.op.node_name
2143
    cfg = self.cfg
2144

    
2145
    dns_data = utils.HostInfo(node_name)
2146

    
2147
    node = dns_data.name
2148
    primary_ip = self.op.primary_ip = dns_data.ip
2149
    secondary_ip = getattr(self.op, "secondary_ip", None)
2150
    if secondary_ip is None:
2151
      secondary_ip = primary_ip
2152
    if not utils.IsValidIP(secondary_ip):
2153
      raise errors.OpPrereqError("Invalid secondary IP given")
2154
    self.op.secondary_ip = secondary_ip
2155

    
2156
    node_list = cfg.GetNodeList()
2157
    if not self.op.readd and node in node_list:
2158
      raise errors.OpPrereqError("Node %s is already in the configuration" %
2159
                                 node)
2160
    elif self.op.readd and node not in node_list:
2161
      raise errors.OpPrereqError("Node %s is not in the configuration" % node)
2162

    
2163
    for existing_node_name in node_list:
2164
      existing_node = cfg.GetNodeInfo(existing_node_name)
2165

    
2166
      if self.op.readd and node == existing_node_name:
2167
        if (existing_node.primary_ip != primary_ip or
2168
            existing_node.secondary_ip != secondary_ip):
2169
          raise errors.OpPrereqError("Readded node doesn't have the same IP"
2170
                                     " address configuration as before")
2171
        continue
2172

    
2173
      if (existing_node.primary_ip == primary_ip or
2174
          existing_node.secondary_ip == primary_ip or
2175
          existing_node.primary_ip == secondary_ip or
2176
          existing_node.secondary_ip == secondary_ip):
2177
        raise errors.OpPrereqError("New node ip address(es) conflict with"
2178
                                   " existing node %s" % existing_node.name)
2179

    
2180
    # check that the type of the node (single versus dual homed) is the
2181
    # same as for the master
2182
    myself = cfg.GetNodeInfo(self.cfg.GetMasterNode())
2183
    master_singlehomed = myself.secondary_ip == myself.primary_ip
2184
    newbie_singlehomed = secondary_ip == primary_ip
2185
    if master_singlehomed != newbie_singlehomed:
2186
      if master_singlehomed:
2187
        raise errors.OpPrereqError("The master has no private ip but the"
2188
                                   " new node has one")
2189
      else:
2190
        raise errors.OpPrereqError("The master has a private ip but the"
2191
                                   " new node doesn't have one")
2192

    
2193
    # checks reachablity
2194
    if not utils.TcpPing(primary_ip, constants.DEFAULT_NODED_PORT):
2195
      raise errors.OpPrereqError("Node not reachable by ping")
2196

    
2197
    if not newbie_singlehomed:
2198
      # check reachability from my secondary ip to newbie's secondary ip
2199
      if not utils.TcpPing(secondary_ip, constants.DEFAULT_NODED_PORT,
2200
                           source=myself.secondary_ip):
2201
        raise errors.OpPrereqError("Node secondary ip not reachable by TCP"
2202
                                   " based ping to noded port")
2203

    
2204
    cp_size = self.cfg.GetClusterInfo().candidate_pool_size
2205
    mc_now, _ = self.cfg.GetMasterCandidateStats()
2206
    master_candidate = mc_now < cp_size
2207

    
2208
    self.new_node = objects.Node(name=node,
2209
                                 primary_ip=primary_ip,
2210
                                 secondary_ip=secondary_ip,
2211
                                 master_candidate=master_candidate,
2212
                                 offline=False, drained=False)
2213

    
2214
  def Exec(self, feedback_fn):
2215
    """Adds the new node to the cluster.
2216

2217
    """
2218
    new_node = self.new_node
2219
    node = new_node.name
2220

    
2221
    # check connectivity
2222
    result = self.rpc.call_version([node])[node]
2223
    result.Raise()
2224
    if result.data:
2225
      if constants.PROTOCOL_VERSION == result.data:
2226
        logging.info("Communication to node %s fine, sw version %s match",
2227
                     node, result.data)
2228
      else:
2229
        raise errors.OpExecError("Version mismatch master version %s,"
2230
                                 " node version %s" %
2231
                                 (constants.PROTOCOL_VERSION, result.data))
2232
    else:
2233
      raise errors.OpExecError("Cannot get version from the new node")
2234

    
2235
    # setup ssh on node
2236
    logging.info("Copy ssh key to node %s", node)
2237
    priv_key, pub_key, _ = ssh.GetUserFiles(constants.GANETI_RUNAS)
2238
    keyarray = []
2239
    keyfiles = [constants.SSH_HOST_DSA_PRIV, constants.SSH_HOST_DSA_PUB,
2240
                constants.SSH_HOST_RSA_PRIV, constants.SSH_HOST_RSA_PUB,
2241
                priv_key, pub_key]
2242

    
2243
    for i in keyfiles:
2244
      f = open(i, 'r')
2245
      try:
2246
        keyarray.append(f.read())
2247
      finally:
2248
        f.close()
2249

    
2250
    result = self.rpc.call_node_add(node, keyarray[0], keyarray[1],
2251
                                    keyarray[2],
2252
                                    keyarray[3], keyarray[4], keyarray[5])
2253

    
2254
    msg = result.RemoteFailMsg()
2255
    if msg:
2256
      raise errors.OpExecError("Cannot transfer ssh keys to the"
2257
                               " new node: %s" % msg)
2258

    
2259
    # Add node to our /etc/hosts, and add key to known_hosts
2260
    utils.AddHostToEtcHosts(new_node.name)
2261

    
2262
    if new_node.secondary_ip != new_node.primary_ip:
2263
      result = self.rpc.call_node_has_ip_address(new_node.name,
2264
                                                 new_node.secondary_ip)
2265
      if result.failed or not result.data:
2266
        raise errors.OpExecError("Node claims it doesn't have the secondary ip"
2267
                                 " you gave (%s). Please fix and re-run this"
2268
                                 " command." % new_node.secondary_ip)
2269

    
2270
    node_verify_list = [self.cfg.GetMasterNode()]
2271
    node_verify_param = {
2272
      'nodelist': [node],
2273
      # TODO: do a node-net-test as well?
2274
    }
2275

    
2276
    result = self.rpc.call_node_verify(node_verify_list, node_verify_param,
2277
                                       self.cfg.GetClusterName())
2278
    for verifier in node_verify_list:
2279
      if result[verifier].failed or not result[verifier].data:
2280
        raise errors.OpExecError("Cannot communicate with %s's node daemon"
2281
                                 " for remote verification" % verifier)
2282
      if result[verifier].data['nodelist']:
2283
        for failed in result[verifier].data['nodelist']:
2284
          feedback_fn("ssh/hostname verification failed %s -> %s" %
2285
                      (verifier, result[verifier].data['nodelist'][failed]))
2286
        raise errors.OpExecError("ssh/hostname verification failed.")
2287

    
2288
    # Distribute updated /etc/hosts and known_hosts to all nodes,
2289
    # including the node just added
2290
    myself = self.cfg.GetNodeInfo(self.cfg.GetMasterNode())
2291
    dist_nodes = self.cfg.GetNodeList()
2292
    if not self.op.readd:
2293
      dist_nodes.append(node)
2294
    if myself.name in dist_nodes:
2295
      dist_nodes.remove(myself.name)
2296

    
2297
    logging.debug("Copying hosts and known_hosts to all nodes")
2298
    for fname in (constants.ETC_HOSTS, constants.SSH_KNOWN_HOSTS_FILE):
2299
      result = self.rpc.call_upload_file(dist_nodes, fname)
2300
      for to_node, to_result in result.iteritems():
2301
        if to_result.failed or not to_result.data:
2302
          logging.error("Copy of file %s to node %s failed", fname, to_node)
2303

    
2304
    to_copy = []
2305
    enabled_hypervisors = self.cfg.GetClusterInfo().enabled_hypervisors
2306
    if constants.HTS_COPY_VNC_PASSWORD.intersection(enabled_hypervisors):
2307
      to_copy.append(constants.VNC_PASSWORD_FILE)
2308

    
2309
    for fname in to_copy:
2310
      result = self.rpc.call_upload_file([node], fname)
2311
      if result[node].failed or not result[node]:
2312
        logging.error("Could not copy file %s to node %s", fname, node)
2313

    
2314
    if self.op.readd:
2315
      self.context.ReaddNode(new_node)
2316
    else:
2317
      self.context.AddNode(new_node)
2318

    
2319

    
2320
class LUSetNodeParams(LogicalUnit):
2321
  """Modifies the parameters of a node.
2322

2323
  """
2324
  HPATH = "node-modify"
2325
  HTYPE = constants.HTYPE_NODE
2326
  _OP_REQP = ["node_name"]
2327
  REQ_BGL = False
2328

    
2329
  def CheckArguments(self):
2330
    node_name = self.cfg.ExpandNodeName(self.op.node_name)
2331
    if node_name is None:
2332
      raise errors.OpPrereqError("Invalid node name '%s'" % self.op.node_name)
2333
    self.op.node_name = node_name
2334
    _CheckBooleanOpField(self.op, 'master_candidate')
2335
    _CheckBooleanOpField(self.op, 'offline')
2336
    _CheckBooleanOpField(self.op, 'drained')
2337
    all_mods = [self.op.offline, self.op.master_candidate, self.op.drained]
2338
    if all_mods.count(None) == 3:
2339
      raise errors.OpPrereqError("Please pass at least one modification")
2340
    if all_mods.count(True) > 1:
2341
      raise errors.OpPrereqError("Can't set the node into more than one"
2342
                                 " state at the same time")
2343

    
2344
  def ExpandNames(self):
2345
    self.needed_locks = {locking.LEVEL_NODE: self.op.node_name}
2346

    
2347
  def BuildHooksEnv(self):
2348
    """Build hooks env.
2349

2350
    This runs on the master node.
2351

2352
    """
2353
    env = {
2354
      "OP_TARGET": self.op.node_name,
2355
      "MASTER_CANDIDATE": str(self.op.master_candidate),
2356
      "OFFLINE": str(self.op.offline),
2357
      "DRAINED": str(self.op.drained),
2358
      }
2359
    nl = [self.cfg.GetMasterNode(),
2360
          self.op.node_name]
2361
    return env, nl, nl
2362

    
2363
  def CheckPrereq(self):
2364
    """Check prerequisites.
2365

2366
    This only checks the instance list against the existing names.
2367

2368
    """
2369
    node = self.node = self.cfg.GetNodeInfo(self.op.node_name)
2370

    
2371
    if ((self.op.master_candidate == False or self.op.offline == True or
2372
         self.op.drained == True) and node.master_candidate):
2373
      # we will demote the node from master_candidate
2374
      if self.op.node_name == self.cfg.GetMasterNode():
2375
        raise errors.OpPrereqError("The master node has to be a"
2376
                                   " master candidate, online and not drained")
2377
      cp_size = self.cfg.GetClusterInfo().candidate_pool_size
2378
      num_candidates, _ = self.cfg.GetMasterCandidateStats()
2379
      if num_candidates <= cp_size:
2380
        msg = ("Not enough master candidates (desired"
2381
               " %d, new value will be %d)" % (cp_size, num_candidates-1))
2382
        if self.op.force:
2383
          self.LogWarning(msg)
2384
        else:
2385
          raise errors.OpPrereqError(msg)
2386

    
2387
    if (self.op.master_candidate == True and
2388
        ((node.offline and not self.op.offline == False) or
2389
         (node.drained and not self.op.drained == False))):
2390
      raise errors.OpPrereqError("Node '%s' is offline or drained, can't set"
2391
                                 " to master_candidate" % node.name)
2392

    
2393
    return
2394

    
2395
  def Exec(self, feedback_fn):
2396
    """Modifies a node.
2397

2398
    """
2399
    node = self.node
2400

    
2401
    result = []
2402
    changed_mc = False
2403

    
2404
    if self.op.offline is not None:
2405
      node.offline = self.op.offline
2406
      result.append(("offline", str(self.op.offline)))
2407
      if self.op.offline == True:
2408
        if node.master_candidate:
2409
          node.master_candidate = False
2410
          changed_mc = True
2411
          result.append(("master_candidate", "auto-demotion due to offline"))
2412
        if node.drained:
2413
          node.drained = False
2414
          result.append(("drained", "clear drained status due to offline"))
2415

    
2416
    if self.op.master_candidate is not None:
2417
      node.master_candidate = self.op.master_candidate
2418
      changed_mc = True
2419
      result.append(("master_candidate", str(self.op.master_candidate)))
2420
      if self.op.master_candidate == False:
2421
        rrc = self.rpc.call_node_demote_from_mc(node.name)
2422
        msg = rrc.RemoteFailMsg()
2423
        if msg:
2424
          self.LogWarning("Node failed to demote itself: %s" % msg)
2425

    
2426
    if self.op.drained is not None:
2427
      node.drained = self.op.drained
2428
      result.append(("drained", str(self.op.drained)))
2429
      if self.op.drained == True:
2430
        if node.master_candidate:
2431
          node.master_candidate = False
2432
          changed_mc = True
2433
          result.append(("master_candidate", "auto-demotion due to drain"))
2434
        if node.offline:
2435
          node.offline = False
2436
          result.append(("offline", "clear offline status due to drain"))
2437

    
2438
    # this will trigger configuration file update, if needed
2439
    self.cfg.Update(node)
2440
    # this will trigger job queue propagation or cleanup
2441
    if changed_mc:
2442
      self.context.ReaddNode(node)
2443

    
2444
    return result
2445

    
2446

    
2447
class LUQueryClusterInfo(NoHooksLU):
2448
  """Query cluster configuration.
2449

2450
  """
2451
  _OP_REQP = []
2452
  REQ_BGL = False
2453

    
2454
  def ExpandNames(self):
2455
    self.needed_locks = {}
2456

    
2457
  def CheckPrereq(self):
2458
    """No prerequsites needed for this LU.
2459

2460
    """
2461
    pass
2462

    
2463
  def Exec(self, feedback_fn):
2464
    """Return cluster config.
2465

2466
    """
2467
    cluster = self.cfg.GetClusterInfo()
2468
    result = {
2469
      "software_version": constants.RELEASE_VERSION,
2470
      "protocol_version": constants.PROTOCOL_VERSION,
2471
      "config_version": constants.CONFIG_VERSION,
2472
      "os_api_version": constants.OS_API_VERSION,
2473
      "export_version": constants.EXPORT_VERSION,
2474
      "architecture": (platform.architecture()[0], platform.machine()),
2475
      "name": cluster.cluster_name,
2476
      "master": cluster.master_node,
2477
      "default_hypervisor": cluster.default_hypervisor,
2478
      "enabled_hypervisors": cluster.enabled_hypervisors,
2479
      "hvparams": dict([(hypervisor, cluster.hvparams[hypervisor])
2480
                        for hypervisor in cluster.enabled_hypervisors]),
2481
      "beparams": cluster.beparams,
2482
      "candidate_pool_size": cluster.candidate_pool_size,
2483
      "default_bridge": cluster.default_bridge,
2484
      "master_netdev": cluster.master_netdev,
2485
      "volume_group_name": cluster.volume_group_name,
2486
      "file_storage_dir": cluster.file_storage_dir,
2487
      }
2488

    
2489
    return result
2490

    
2491

    
2492
class LUQueryConfigValues(NoHooksLU):
2493
  """Return configuration values.
2494

2495
  """
2496
  _OP_REQP = []
2497
  REQ_BGL = False
2498
  _FIELDS_DYNAMIC = utils.FieldSet()
2499
  _FIELDS_STATIC = utils.FieldSet("cluster_name", "master_node", "drain_flag")
2500

    
2501
  def ExpandNames(self):
2502
    self.needed_locks = {}
2503

    
2504
    _CheckOutputFields(static=self._FIELDS_STATIC,
2505
                       dynamic=self._FIELDS_DYNAMIC,
2506
                       selected=self.op.output_fields)
2507

    
2508
  def CheckPrereq(self):
2509
    """No prerequisites.
2510

2511
    """
2512
    pass
2513

    
2514
  def Exec(self, feedback_fn):
2515
    """Dump a representation of the cluster config to the standard output.
2516

2517
    """
2518
    values = []
2519
    for field in self.op.output_fields:
2520
      if field == "cluster_name":
2521
        entry = self.cfg.GetClusterName()
2522
      elif field == "master_node":
2523
        entry = self.cfg.GetMasterNode()
2524
      elif field == "drain_flag":
2525
        entry = os.path.exists(constants.JOB_QUEUE_DRAIN_FILE)
2526
      else:
2527
        raise errors.ParameterError(field)
2528
      values.append(entry)
2529
    return values
2530

    
2531

    
2532
class LUActivateInstanceDisks(NoHooksLU):
2533
  """Bring up an instance's disks.
2534

2535
  """
2536
  _OP_REQP = ["instance_name"]
2537
  REQ_BGL = False
2538

    
2539
  def ExpandNames(self):
2540
    self._ExpandAndLockInstance()
2541
    self.needed_locks[locking.LEVEL_NODE] = []
2542
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
2543

    
2544
  def DeclareLocks(self, level):
2545
    if level == locking.LEVEL_NODE:
2546
      self._LockInstancesNodes()
2547

    
2548
  def CheckPrereq(self):
2549
    """Check prerequisites.
2550

2551
    This checks that the instance is in the cluster.
2552

2553
    """
2554
    self.instance = self.cfg.GetInstanceInfo(self.op.instance_name)
2555
    assert self.instance is not None, \
2556
      "Cannot retrieve locked instance %s" % self.op.instance_name
2557
    _CheckNodeOnline(self, self.instance.primary_node)
2558

    
2559
  def Exec(self, feedback_fn):
2560
    """Activate the disks.
2561

2562
    """
2563
    disks_ok, disks_info = _AssembleInstanceDisks(self, self.instance)
2564
    if not disks_ok:
2565
      raise errors.OpExecError("Cannot activate block devices")
2566

    
2567
    return disks_info
2568

    
2569

    
2570
def _AssembleInstanceDisks(lu, instance, ignore_secondaries=False):
2571
  """Prepare the block devices for an instance.
2572

2573
  This sets up the block devices on all nodes.
2574

2575
  @type lu: L{LogicalUnit}
2576
  @param lu: the logical unit on whose behalf we execute
2577
  @type instance: L{objects.Instance}
2578
  @param instance: the instance for whose disks we assemble
2579
  @type ignore_secondaries: boolean
2580
  @param ignore_secondaries: if true, errors on secondary nodes
2581
      won't result in an error return from the function
2582
  @return: False if the operation failed, otherwise a list of
2583
      (host, instance_visible_name, node_visible_name)
2584
      with the mapping from node devices to instance devices
2585

2586
  """
2587
  device_info = []
2588
  disks_ok = True
2589
  iname = instance.name
2590
  # With the two passes mechanism we try to reduce the window of
2591
  # opportunity for the race condition of switching DRBD to primary
2592
  # before handshaking occured, but we do not eliminate it
2593

    
2594
  # The proper fix would be to wait (with some limits) until the
2595
  # connection has been made and drbd transitions from WFConnection
2596
  # into any other network-connected state (Connected, SyncTarget,
2597
  # SyncSource, etc.)
2598

    
2599
  # 1st pass, assemble on all nodes in secondary mode
2600
  for inst_disk in instance.disks:
2601
    for node, node_disk in inst_disk.ComputeNodeTree(instance.primary_node):
2602
      lu.cfg.SetDiskID(node_disk, node)
2603
      result = lu.rpc.call_blockdev_assemble(node, node_disk, iname, False)
2604
      msg = result.RemoteFailMsg()
2605
      if msg:
2606
        lu.proc.LogWarning("Could not prepare block device %s on node %s"
2607
                           " (is_primary=False, pass=1): %s",
2608
                           inst_disk.iv_name, node, msg)
2609
        if not ignore_secondaries:
2610
          disks_ok = False
2611

    
2612
  # FIXME: race condition on drbd migration to primary
2613

    
2614
  # 2nd pass, do only the primary node
2615
  for inst_disk in instance.disks:
2616
    for node, node_disk in inst_disk.ComputeNodeTree(instance.primary_node):
2617
      if node != instance.primary_node:
2618
        continue
2619
      lu.cfg.SetDiskID(node_disk, node)
2620
      result = lu.rpc.call_blockdev_assemble(node, node_disk, iname, True)
2621
      msg = result.RemoteFailMsg()
2622
      if msg:
2623
        lu.proc.LogWarning("Could not prepare block device %s on node %s"
2624
                           " (is_primary=True, pass=2): %s",
2625
                           inst_disk.iv_name, node, msg)
2626
        disks_ok = False
2627
    device_info.append((instance.primary_node, inst_disk.iv_name,
2628
                        result.payload))
2629

    
2630
  # leave the disks configured for the primary node
2631
  # this is a workaround that would be fixed better by
2632
  # improving the logical/physical id handling
2633
  for disk in instance.disks:
2634
    lu.cfg.SetDiskID(disk, instance.primary_node)
2635

    
2636
  return disks_ok, device_info
2637

    
2638

    
2639
def _StartInstanceDisks(lu, instance, force):
2640
  """Start the disks of an instance.
2641

2642
  """
2643
  disks_ok, dummy = _AssembleInstanceDisks(lu, instance,
2644
                                           ignore_secondaries=force)
2645
  if not disks_ok:
2646
    _ShutdownInstanceDisks(lu, instance)
2647
    if force is not None and not force:
2648
      lu.proc.LogWarning("", hint="If the message above refers to a"
2649
                         " secondary node,"
2650
                         " you can retry the operation using '--force'.")
2651
    raise errors.OpExecError("Disk consistency error")
2652

    
2653

    
2654
class LUDeactivateInstanceDisks(NoHooksLU):
2655
  """Shutdown an instance's disks.
2656

2657
  """
2658
  _OP_REQP = ["instance_name"]
2659
  REQ_BGL = False
2660

    
2661
  def ExpandNames(self):
2662
    self._ExpandAndLockInstance()
2663
    self.needed_locks[locking.LEVEL_NODE] = []
2664
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
2665

    
2666
  def DeclareLocks(self, level):
2667
    if level == locking.LEVEL_NODE:
2668
      self._LockInstancesNodes()
2669

    
2670
  def CheckPrereq(self):
2671
    """Check prerequisites.
2672

2673
    This checks that the instance is in the cluster.
2674

2675
    """
2676
    self.instance = self.cfg.GetInstanceInfo(self.op.instance_name)
2677
    assert self.instance is not None, \
2678
      "Cannot retrieve locked instance %s" % self.op.instance_name
2679

    
2680
  def Exec(self, feedback_fn):
2681
    """Deactivate the disks
2682

2683
    """
2684
    instance = self.instance
2685
    _SafeShutdownInstanceDisks(self, instance)
2686

    
2687

    
2688
def _SafeShutdownInstanceDisks(lu, instance):
2689
  """Shutdown block devices of an instance.
2690

2691
  This function checks if an instance is running, before calling
2692
  _ShutdownInstanceDisks.
2693

2694
  """
2695
  ins_l = lu.rpc.call_instance_list([instance.primary_node],
2696
                                      [instance.hypervisor])
2697
  ins_l = ins_l[instance.primary_node]
2698
  if ins_l.failed or not isinstance(ins_l.data, list):
2699
    raise errors.OpExecError("Can't contact node '%s'" %
2700
                             instance.primary_node)
2701

    
2702
  if instance.name in ins_l.data:
2703
    raise errors.OpExecError("Instance is running, can't shutdown"
2704
                             " block devices.")
2705

    
2706
  _ShutdownInstanceDisks(lu, instance)
2707

    
2708

    
2709
def _ShutdownInstanceDisks(lu, instance, ignore_primary=False):
2710
  """Shutdown block devices of an instance.
2711

2712
  This does the shutdown on all nodes of the instance.
2713

2714
  If the ignore_primary is false, errors on the primary node are
2715
  ignored.
2716

2717
  """
2718
  all_result = True
2719
  for disk in instance.disks:
2720
    for node, top_disk in disk.ComputeNodeTree(instance.primary_node):
2721
      lu.cfg.SetDiskID(top_disk, node)
2722
      result = lu.rpc.call_blockdev_shutdown(node, top_disk)
2723
      msg = result.RemoteFailMsg()
2724
      if msg:
2725
        lu.LogWarning("Could not shutdown block device %s on node %s: %s",
2726
                      disk.iv_name, node, msg)
2727
        if not ignore_primary or node != instance.primary_node:
2728
          all_result = False
2729
  return all_result
2730

    
2731

    
2732
def _CheckNodeFreeMemory(lu, node, reason, requested, hypervisor_name):
2733
  """Checks if a node has enough free memory.
2734

2735
  This function check if a given node has the needed amount of free
2736
  memory. In case the node has less memory or we cannot get the
2737
  information from the node, this function raise an OpPrereqError
2738
  exception.
2739

2740
  @type lu: C{LogicalUnit}
2741
  @param lu: a logical unit from which we get configuration data
2742
  @type node: C{str}
2743
  @param node: the node to check
2744
  @type reason: C{str}
2745
  @param reason: string to use in the error message
2746
  @type requested: C{int}
2747
  @param requested: the amount of memory in MiB to check for
2748
  @type hypervisor_name: C{str}
2749
  @param hypervisor_name: the hypervisor to ask for memory stats
2750
  @raise errors.OpPrereqError: if the node doesn't have enough memory, or
2751
      we cannot check the node
2752

2753
  """
2754
  nodeinfo = lu.rpc.call_node_info([node], lu.cfg.GetVGName(), hypervisor_name)
2755
  nodeinfo[node].Raise()
2756
  free_mem = nodeinfo[node].data.get('memory_free')
2757
  if not isinstance(free_mem, int):
2758
    raise errors.OpPrereqError("Can't compute free memory on node %s, result"
2759
                             " was '%s'" % (node, free_mem))
2760
  if requested > free_mem:
2761
    raise errors.OpPrereqError("Not enough memory on node %s for %s:"
2762
                             " needed %s MiB, available %s MiB" %
2763
                             (node, reason, requested, free_mem))
2764

    
2765

    
2766
class LUStartupInstance(LogicalUnit):
2767
  """Starts an instance.
2768

2769
  """
2770
  HPATH = "instance-start"
2771
  HTYPE = constants.HTYPE_INSTANCE
2772
  _OP_REQP = ["instance_name", "force"]
2773
  REQ_BGL = False
2774

    
2775
  def ExpandNames(self):
2776
    self._ExpandAndLockInstance()
2777

    
2778
  def BuildHooksEnv(self):
2779
    """Build hooks env.
2780

2781
    This runs on master, primary and secondary nodes of the instance.
2782

2783
    """
2784
    env = {
2785
      "FORCE": self.op.force,
2786
      }
2787
    env.update(_BuildInstanceHookEnvByObject(self, self.instance))
2788
    nl = [self.cfg.GetMasterNode()] + list(self.instance.all_nodes)
2789
    return env, nl, nl
2790

    
2791
  def CheckPrereq(self):
2792
    """Check prerequisites.
2793

2794
    This checks that the instance is in the cluster.
2795

2796
    """
2797
    self.instance = instance = self.cfg.GetInstanceInfo(self.op.instance_name)
2798
    assert self.instance is not None, \
2799
      "Cannot retrieve locked instance %s" % self.op.instance_name
2800

    
2801
    # extra beparams
2802
    self.beparams = getattr(self.op, "beparams", {})
2803
    if self.beparams:
2804
      if not isinstance(self.beparams, dict):
2805
        raise errors.OpPrereqError("Invalid beparams passed: %s, expected"
2806
                                   " dict" % (type(self.beparams), ))
2807
      # fill the beparams dict
2808
      utils.ForceDictType(self.beparams, constants.BES_PARAMETER_TYPES)
2809
      self.op.beparams = self.beparams
2810

    
2811
    # extra hvparams
2812
    self.hvparams = getattr(self.op, "hvparams", {})
2813
    if self.hvparams:
2814
      if not isinstance(self.hvparams, dict):
2815
        raise errors.OpPrereqError("Invalid hvparams passed: %s, expected"
2816
                                   " dict" % (type(self.hvparams), ))
2817

    
2818
      # check hypervisor parameter syntax (locally)
2819
      cluster = self.cfg.GetClusterInfo()
2820
      utils.ForceDictType(self.hvparams, constants.HVS_PARAMETER_TYPES)
2821
      filled_hvp = cluster.FillDict(cluster.hvparams[instance.hypervisor],
2822
                                    instance.hvparams)
2823
      filled_hvp.update(self.hvparams)
2824
      hv_type = hypervisor.GetHypervisor(instance.hypervisor)
2825
      hv_type.CheckParameterSyntax(filled_hvp)
2826
      _CheckHVParams(self, instance.all_nodes, instance.hypervisor, filled_hvp)
2827
      self.op.hvparams = self.hvparams
2828

    
2829
    _CheckNodeOnline(self, instance.primary_node)
2830

    
2831
    bep = self.cfg.GetClusterInfo().FillBE(instance)
2832
    # check bridges existance
2833
    _CheckInstanceBridgesExist(self, instance)
2834

    
2835
    remote_info = self.rpc.call_instance_info(instance.primary_node,
2836
                                              instance.name,
2837
                                              instance.hypervisor)
2838
    remote_info.Raise()
2839
    if not remote_info.data:
2840
      _CheckNodeFreeMemory(self, instance.primary_node,
2841
                           "starting instance %s" % instance.name,
2842
                           bep[constants.BE_MEMORY], instance.hypervisor)
2843

    
2844
  def Exec(self, feedback_fn):
2845
    """Start the instance.
2846

2847
    """
2848
    instance = self.instance
2849
    force = self.op.force
2850

    
2851
    self.cfg.MarkInstanceUp(instance.name)
2852

    
2853
    node_current = instance.primary_node
2854

    
2855
    _StartInstanceDisks(self, instance, force)
2856

    
2857
    result = self.rpc.call_instance_start(node_current, instance,
2858
                                          self.hvparams, self.beparams)
2859
    msg = result.RemoteFailMsg()
2860
    if msg:
2861
      _ShutdownInstanceDisks(self, instance)
2862
      raise errors.OpExecError("Could not start instance: %s" % msg)
2863

    
2864

    
2865
class LURebootInstance(LogicalUnit):
2866
  """Reboot an instance.
2867

2868
  """
2869
  HPATH = "instance-reboot"
2870
  HTYPE = constants.HTYPE_INSTANCE
2871
  _OP_REQP = ["instance_name", "ignore_secondaries", "reboot_type"]
2872
  REQ_BGL = False
2873

    
2874
  def ExpandNames(self):
2875
    if self.op.reboot_type not in [constants.INSTANCE_REBOOT_SOFT,
2876
                                   constants.INSTANCE_REBOOT_HARD,
2877
                                   constants.INSTANCE_REBOOT_FULL]:
2878
      raise errors.ParameterError("reboot type not in [%s, %s, %s]" %
2879
                                  (constants.INSTANCE_REBOOT_SOFT,
2880
                                   constants.INSTANCE_REBOOT_HARD,
2881
                                   constants.INSTANCE_REBOOT_FULL))
2882
    self._ExpandAndLockInstance()
2883

    
2884
  def BuildHooksEnv(self):
2885
    """Build hooks env.
2886

2887
    This runs on master, primary and secondary nodes of the instance.
2888

2889
    """
2890
    env = {
2891
      "IGNORE_SECONDARIES": self.op.ignore_secondaries,
2892
      "REBOOT_TYPE": self.op.reboot_type,
2893
      }
2894
    env.update(_BuildInstanceHookEnvByObject(self, self.instance))
2895
    nl = [self.cfg.GetMasterNode()] + list(self.instance.all_nodes)
2896
    return env, nl, nl
2897

    
2898
  def CheckPrereq(self):
2899
    """Check prerequisites.
2900

2901
    This checks that the instance is in the cluster.
2902

2903
    """
2904
    self.instance = instance = self.cfg.GetInstanceInfo(self.op.instance_name)
2905
    assert self.instance is not None, \
2906
      "Cannot retrieve locked instance %s" % self.op.instance_name
2907

    
2908
    _CheckNodeOnline(self, instance.primary_node)
2909

    
2910
    # check bridges existance
2911
    _CheckInstanceBridgesExist(self, instance)
2912

    
2913
  def Exec(self, feedback_fn):
2914
    """Reboot the instance.
2915

2916
    """
2917
    instance = self.instance
2918
    ignore_secondaries = self.op.ignore_secondaries
2919
    reboot_type = self.op.reboot_type
2920

    
2921
    node_current = instance.primary_node
2922

    
2923
    if reboot_type in [constants.INSTANCE_REBOOT_SOFT,
2924
                       constants.INSTANCE_REBOOT_HARD]:
2925
      for disk in instance.disks:
2926
        self.cfg.SetDiskID(disk, node_current)
2927
      result = self.rpc.call_instance_reboot(node_current, instance,
2928
                                             reboot_type)
2929
      msg = result.RemoteFailMsg()
2930
      if msg:
2931
        raise errors.OpExecError("Could not reboot instance: %s" % msg)
2932
    else:
2933
      result = self.rpc.call_instance_shutdown(node_current, instance)
2934
      msg = result.RemoteFailMsg()
2935
      if msg:
2936
        raise errors.OpExecError("Could not shutdown instance for"
2937
                                 " full reboot: %s" % msg)
2938
      _ShutdownInstanceDisks(self, instance)
2939
      _StartInstanceDisks(self, instance, ignore_secondaries)
2940
      result = self.rpc.call_instance_start(node_current, instance, None, None)
2941
      msg = result.RemoteFailMsg()
2942
      if msg:
2943
        _ShutdownInstanceDisks(self, instance)
2944
        raise errors.OpExecError("Could not start instance for"
2945
                                 " full reboot: %s" % msg)
2946

    
2947
    self.cfg.MarkInstanceUp(instance.name)
2948

    
2949

    
2950
class LUShutdownInstance(LogicalUnit):
2951
  """Shutdown an instance.
2952

2953
  """
2954
  HPATH = "instance-stop"
2955
  HTYPE = constants.HTYPE_INSTANCE
2956
  _OP_REQP = ["instance_name"]
2957
  REQ_BGL = False
2958

    
2959
  def ExpandNames(self):
2960
    self._ExpandAndLockInstance()
2961

    
2962
  def BuildHooksEnv(self):
2963
    """Build hooks env.
2964

2965
    This runs on master, primary and secondary nodes of the instance.
2966

2967
    """
2968
    env = _BuildInstanceHookEnvByObject(self, self.instance)
2969
    nl = [self.cfg.GetMasterNode()] + list(self.instance.all_nodes)
2970
    return env, nl, nl
2971

    
2972
  def CheckPrereq(self):
2973
    """Check prerequisites.
2974

2975
    This checks that the instance is in the cluster.
2976

2977
    """
2978
    self.instance = self.cfg.GetInstanceInfo(self.op.instance_name)
2979
    assert self.instance is not None, \
2980
      "Cannot retrieve locked instance %s" % self.op.instance_name
2981
    _CheckNodeOnline(self, self.instance.primary_node)
2982

    
2983
  def Exec(self, feedback_fn):
2984
    """Shutdown the instance.
2985

2986
    """
2987
    instance = self.instance
2988
    node_current = instance.primary_node
2989
    self.cfg.MarkInstanceDown(instance.name)
2990
    result = self.rpc.call_instance_shutdown(node_current, instance)
2991
    msg = result.RemoteFailMsg()
2992
    if msg:
2993
      self.proc.LogWarning("Could not shutdown instance: %s" % msg)
2994

    
2995
    _ShutdownInstanceDisks(self, instance)
2996

    
2997

    
2998
class LUReinstallInstance(LogicalUnit):
2999
  """Reinstall an instance.
3000

3001
  """
3002
  HPATH = "instance-reinstall"
3003
  HTYPE = constants.HTYPE_INSTANCE
3004
  _OP_REQP = ["instance_name"]
3005
  REQ_BGL = False
3006

    
3007
  def ExpandNames(self):
3008
    self._ExpandAndLockInstance()
3009

    
3010
  def BuildHooksEnv(self):
3011
    """Build hooks env.
3012

3013
    This runs on master, primary and secondary nodes of the instance.
3014

3015
    """
3016
    env = _BuildInstanceHookEnvByObject(self, self.instance)
3017
    nl = [self.cfg.GetMasterNode()] + list(self.instance.all_nodes)
3018
    return env, nl, nl
3019

    
3020
  def CheckPrereq(self):
3021
    """Check prerequisites.
3022

3023
    This checks that the instance is in the cluster and is not running.
3024

3025
    """
3026
    instance = self.cfg.GetInstanceInfo(self.op.instance_name)
3027
    assert instance is not None, \
3028
      "Cannot retrieve locked instance %s" % self.op.instance_name
3029
    _CheckNodeOnline(self, instance.primary_node)
3030

    
3031
    if instance.disk_template == constants.DT_DISKLESS:
3032
      raise errors.OpPrereqError("Instance '%s' has no disks" %
3033
                                 self.op.instance_name)
3034
    if instance.admin_up:
3035
      raise errors.OpPrereqError("Instance '%s' is marked to be up" %
3036
                                 self.op.instance_name)
3037
    remote_info = self.rpc.call_instance_info(instance.primary_node,
3038
                                              instance.name,
3039
                                              instance.hypervisor)
3040
    remote_info.Raise()
3041
    if remote_info.data:
3042
      raise errors.OpPrereqError("Instance '%s' is running on the node %s" %
3043
                                 (self.op.instance_name,
3044
                                  instance.primary_node))
3045

    
3046
    self.op.os_type = getattr(self.op, "os_type", None)
3047
    if self.op.os_type is not None:
3048
      # OS verification
3049
      pnode = self.cfg.GetNodeInfo(
3050
        self.cfg.ExpandNodeName(instance.primary_node))
3051
      if pnode is None:
3052
        raise errors.OpPrereqError("Primary node '%s' is unknown" %
3053
                                   self.op.pnode)
3054
      result = self.rpc.call_os_get(pnode.name, self.op.os_type)
3055
      result.Raise()
3056
      if not isinstance(result.data, objects.OS):
3057
        raise errors.OpPrereqError("OS '%s' not in supported OS list for"
3058
                                   " primary node"  % self.op.os_type)
3059

    
3060
    self.instance = instance
3061

    
3062
  def Exec(self, feedback_fn):
3063
    """Reinstall the instance.
3064

3065
    """
3066
    inst = self.instance
3067

    
3068
    if self.op.os_type is not None:
3069
      feedback_fn("Changing OS to '%s'..." % self.op.os_type)
3070
      inst.os = self.op.os_type
3071
      self.cfg.Update(inst)
3072

    
3073
    _StartInstanceDisks(self, inst, None)
3074
    try:
3075
      feedback_fn("Running the instance OS create scripts...")
3076
      result = self.rpc.call_instance_os_add(inst.primary_node, inst)
3077
      msg = result.RemoteFailMsg()
3078
      if msg:
3079
        raise errors.OpExecError("Could not install OS for instance %s"
3080
                                 " on node %s: %s" %
3081
                                 (inst.name, inst.primary_node, msg))
3082
    finally:
3083
      _ShutdownInstanceDisks(self, inst)
3084

    
3085

    
3086
class LURenameInstance(LogicalUnit):
3087
  """Rename an instance.
3088

3089
  """
3090
  HPATH = "instance-rename"
3091
  HTYPE = constants.HTYPE_INSTANCE
3092
  _OP_REQP = ["instance_name", "new_name"]
3093

    
3094
  def BuildHooksEnv(self):
3095
    """Build hooks env.
3096

3097
    This runs on master, primary and secondary nodes of the instance.
3098

3099
    """
3100
    env = _BuildInstanceHookEnvByObject(self, self.instance)
3101
    env["INSTANCE_NEW_NAME"] = self.op.new_name
3102
    nl = [self.cfg.GetMasterNode()] + list(self.instance.all_nodes)
3103
    return env, nl, nl
3104

    
3105
  def CheckPrereq(self):
3106
    """Check prerequisites.
3107

3108
    This checks that the instance is in the cluster and is not running.
3109

3110
    """
3111
    instance = self.cfg.GetInstanceInfo(
3112
      self.cfg.ExpandInstanceName(self.op.instance_name))
3113
    if instance is None:
3114
      raise errors.OpPrereqError("Instance '%s' not known" %
3115
                                 self.op.instance_name)
3116
    _CheckNodeOnline(self, instance.primary_node)
3117

    
3118
    if instance.admin_up:
3119
      raise errors.OpPrereqError("Instance '%s' is marked to be up" %
3120
                                 self.op.instance_name)
3121
    remote_info = self.rpc.call_instance_info(instance.primary_node,
3122
                                              instance.name,
3123
                                              instance.hypervisor)
3124
    remote_info.Raise()
3125
    if remote_info.data:
3126
      raise errors.OpPrereqError("Instance '%s' is running on the node %s" %
3127
                                 (self.op.instance_name,
3128
                                  instance.primary_node))
3129
    self.instance = instance
3130

    
3131
    # new name verification
3132
    name_info = utils.HostInfo(self.op.new_name)
3133

    
3134
    self.op.new_name = new_name = name_info.name
3135
    instance_list = self.cfg.GetInstanceList()
3136
    if new_name in instance_list:
3137
      raise errors.OpPrereqError("Instance '%s' is already in the cluster" %
3138
                                 new_name)
3139

    
3140
    if not getattr(self.op, "ignore_ip", False):
3141
      if utils.TcpPing(name_info.ip, constants.DEFAULT_NODED_PORT):
3142
        raise errors.OpPrereqError("IP %s of instance %s already in use" %
3143
                                   (name_info.ip, new_name))
3144

    
3145

    
3146
  def Exec(self, feedback_fn):
3147
    """Reinstall the instance.
3148

3149
    """
3150
    inst = self.instance
3151
    old_name = inst.name
3152

    
3153
    if inst.disk_template == constants.DT_FILE:
3154
      old_file_storage_dir = os.path.dirname(inst.disks[0].logical_id[1])
3155

    
3156
    self.cfg.RenameInstance(inst.name, self.op.new_name)
3157
    # Change the instance lock. This is definitely safe while we hold the BGL
3158
    self.context.glm.remove(locking.LEVEL_INSTANCE, old_name)
3159
    self.context.glm.add(locking.LEVEL_INSTANCE, self.op.new_name)
3160

    
3161
    # re-read the instance from the configuration after rename
3162
    inst = self.cfg.GetInstanceInfo(self.op.new_name)
3163

    
3164
    if inst.disk_template == constants.DT_FILE:
3165
      new_file_storage_dir = os.path.dirname(inst.disks[0].logical_id[1])
3166
      result = self.rpc.call_file_storage_dir_rename(inst.primary_node,
3167
                                                     old_file_storage_dir,
3168
                                                     new_file_storage_dir)
3169
      result.Raise()
3170
      if not result.data:
3171
        raise errors.OpExecError("Could not connect to node '%s' to rename"
3172
                                 " directory '%s' to '%s' (but the instance"
3173
                                 " has been renamed in Ganeti)" % (
3174
                                 inst.primary_node, old_file_storage_dir,
3175
                                 new_file_storage_dir))
3176

    
3177
      if not result.data[0]:
3178
        raise errors.OpExecError("Could not rename directory '%s' to '%s'"
3179
                                 " (but the instance has been renamed in"
3180
                                 " Ganeti)" % (old_file_storage_dir,
3181
                                               new_file_storage_dir))
3182

    
3183
    _StartInstanceDisks(self, inst, None)
3184
    try:
3185
      result = self.rpc.call_instance_run_rename(inst.primary_node, inst,
3186
                                                 old_name)
3187
      msg = result.RemoteFailMsg()
3188
      if msg:
3189
        msg = ("Could not run OS rename script for instance %s on node %s"
3190
               " (but the instance has been renamed in Ganeti): %s" %
3191
               (inst.name, inst.primary_node, msg))
3192
        self.proc.LogWarning(msg)
3193
    finally:
3194
      _ShutdownInstanceDisks(self, inst)
3195

    
3196

    
3197
class LURemoveInstance(LogicalUnit):
3198
  """Remove an instance.
3199

3200
  """
3201
  HPATH = "instance-remove"
3202
  HTYPE = constants.HTYPE_INSTANCE
3203
  _OP_REQP = ["instance_name", "ignore_failures"]
3204
  REQ_BGL = False
3205

    
3206
  def ExpandNames(self):
3207
    self._ExpandAndLockInstance()
3208
    self.needed_locks[locking.LEVEL_NODE] = []
3209
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
3210

    
3211
  def DeclareLocks(self, level):
3212
    if level == locking.LEVEL_NODE:
3213
      self._LockInstancesNodes()
3214

    
3215
  def BuildHooksEnv(self):
3216
    """Build hooks env.
3217

3218
    This runs on master, primary and secondary nodes of the instance.
3219

3220
    """
3221
    env = _BuildInstanceHookEnvByObject(self, self.instance)
3222
    nl = [self.cfg.GetMasterNode()]
3223
    return env, nl, nl
3224

    
3225
  def CheckPrereq(self):
3226
    """Check prerequisites.
3227

3228
    This checks that the instance is in the cluster.
3229

3230
    """
3231
    self.instance = self.cfg.GetInstanceInfo(self.op.instance_name)
3232
    assert self.instance is not None, \
3233
      "Cannot retrieve locked instance %s" % self.op.instance_name
3234

    
3235
  def Exec(self, feedback_fn):
3236
    """Remove the instance.
3237

3238
    """
3239
    instance = self.instance
3240
    logging.info("Shutting down instance %s on node %s",
3241
                 instance.name, instance.primary_node)
3242

    
3243
    result = self.rpc.call_instance_shutdown(instance.primary_node, instance)
3244
    msg = result.RemoteFailMsg()
3245
    if msg:
3246
      if self.op.ignore_failures:
3247
        feedback_fn("Warning: can't shutdown instance: %s" % msg)
3248
      else:
3249
        raise errors.OpExecError("Could not shutdown instance %s on"
3250
                                 " node %s: %s" %
3251
                                 (instance.name, instance.primary_node, msg))
3252

    
3253
    logging.info("Removing block devices for instance %s", instance.name)
3254

    
3255
    if not _RemoveDisks(self, instance):
3256
      if self.op.ignore_failures:
3257
        feedback_fn("Warning: can't remove instance's disks")
3258
      else:
3259
        raise errors.OpExecError("Can't remove instance's disks")
3260

    
3261
    logging.info("Removing instance %s out of cluster config", instance.name)
3262

    
3263
    self.cfg.RemoveInstance(instance.name)
3264
    self.remove_locks[locking.LEVEL_INSTANCE] = instance.name
3265

    
3266

    
3267
class LUQueryInstances(NoHooksLU):
3268
  """Logical unit for querying instances.
3269

3270
  """
3271
  _OP_REQP = ["output_fields", "names", "use_locking"]
3272
  REQ_BGL = False
3273
  _FIELDS_STATIC = utils.FieldSet(*["name", "os", "pnode", "snodes",
3274
                                    "admin_state",
3275
                                    "disk_template", "ip", "mac", "bridge",
3276
                                    "sda_size", "sdb_size", "vcpus", "tags",
3277
                                    "network_port", "beparams",
3278
                                    r"(disk)\.(size)/([0-9]+)",
3279
                                    r"(disk)\.(sizes)", "disk_usage",
3280
                                    r"(nic)\.(mac|ip|bridge)/([0-9]+)",
3281
                                    r"(nic)\.(macs|ips|bridges)",
3282
                                    r"(disk|nic)\.(count)",
3283
                                    "serial_no", "hypervisor", "hvparams",] +
3284
                                  ["hv/%s" % name
3285
                                   for name in constants.HVS_PARAMETERS] +
3286
                                  ["be/%s" % name
3287
                                   for name in constants.BES_PARAMETERS])
3288
  _FIELDS_DYNAMIC = utils.FieldSet("oper_state", "oper_ram", "status")
3289

    
3290

    
3291
  def ExpandNames(self):
3292
    _CheckOutputFields(static=self._FIELDS_STATIC,
3293
                       dynamic=self._FIELDS_DYNAMIC,
3294
                       selected=self.op.output_fields)
3295

    
3296
    self.needed_locks = {}
3297
    self.share_locks[locking.LEVEL_INSTANCE] = 1
3298
    self.share_locks[locking.LEVEL_NODE] = 1
3299

    
3300
    if self.op.names:
3301
      self.wanted = _GetWantedInstances(self, self.op.names)
3302
    else:
3303
      self.wanted = locking.ALL_SET
3304

    
3305
    self.do_node_query = self._FIELDS_STATIC.NonMatching(self.op.output_fields)
3306
    self.do_locking = self.do_node_query and self.op.use_locking
3307
    if self.do_locking:
3308
      self.needed_locks[locking.LEVEL_INSTANCE] = self.wanted
3309
      self.needed_locks[locking.LEVEL_NODE] = []
3310
      self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
3311

    
3312
  def DeclareLocks(self, level):
3313
    if level == locking.LEVEL_NODE and self.do_locking:
3314
      self._LockInstancesNodes()
3315

    
3316
  def CheckPrereq(self):
3317
    """Check prerequisites.
3318

3319
    """
3320
    pass
3321

    
3322
  def Exec(self, feedback_fn):
3323
    """Computes the list of nodes and their attributes.
3324

3325
    """
3326
    all_info = self.cfg.GetAllInstancesInfo()
3327
    if self.wanted == locking.ALL_SET:
3328
      # caller didn't specify instance names, so ordering is not important
3329
      if self.do_locking:
3330
        instance_names = self.acquired_locks[locking.LEVEL_INSTANCE]
3331
      else:
3332
        instance_names = all_info.keys()
3333
      instance_names = utils.NiceSort(instance_names)
3334
    else:
3335
      # caller did specify names, so we must keep the ordering
3336
      if self.do_locking:
3337
        tgt_set = self.acquired_locks[locking.LEVEL_INSTANCE]
3338
      else:
3339
        tgt_set = all_info.keys()
3340
      missing = set(self.wanted).difference(tgt_set)
3341
      if missing:
3342
        raise errors.OpExecError("Some instances were removed before"
3343
                                 " retrieving their data: %s" % missing)
3344
      instance_names = self.wanted
3345

    
3346
    instance_list = [all_info[iname] for iname in instance_names]
3347

    
3348
    # begin data gathering
3349

    
3350
    nodes = frozenset([inst.primary_node for inst in instance_list])
3351
    hv_list = list(set([inst.hypervisor for inst in instance_list]))
3352

    
3353
    bad_nodes = []
3354
    off_nodes = []
3355
    if self.do_node_query:
3356
      live_data = {}
3357
      node_data = self.rpc.call_all_instances_info(nodes, hv_list)
3358
      for name in nodes:
3359
        result = node_data[name]
3360
        if result.offline:
3361
          # offline nodes will be in both lists
3362
          off_nodes.append(name)
3363
        if result.failed:
3364
          bad_nodes.append(name)
3365
        else:
3366
          if result.data:
3367
            live_data.update(result.data)
3368
            # else no instance is alive
3369
    else:
3370
      live_data = dict([(name, {}) for name in instance_names])
3371

    
3372
    # end data gathering
3373

    
3374
    HVPREFIX = "hv/"
3375
    BEPREFIX = "be/"
3376
    output = []
3377
    for instance in instance_list:
3378
      iout = []
3379
      i_hv = self.cfg.GetClusterInfo().FillHV(instance)
3380
      i_be = self.cfg.GetClusterInfo().FillBE(instance)
3381
      for field in self.op.output_fields:
3382
        st_match = self._FIELDS_STATIC.Matches(field)
3383
        if field == "name":
3384
          val = instance.name
3385
        elif field == "os":
3386
          val = instance.os
3387
        elif field == "pnode":
3388
          val = instance.primary_node
3389
        elif field == "snodes":
3390
          val = list(instance.secondary_nodes)
3391
        elif field == "admin_state":
3392
          val = instance.admin_up
3393
        elif field == "oper_state":
3394
          if instance.primary_node in bad_nodes:
3395
            val = None
3396
          else:
3397
            val = bool(live_data.get(instance.name))
3398
        elif field == "status":
3399
          if instance.primary_node in off_nodes:
3400
            val = "ERROR_nodeoffline"
3401
          elif instance.primary_node in bad_nodes:
3402
            val = "ERROR_nodedown"
3403
          else:
3404
            running = bool(live_data.get(instance.name))
3405
            if running:
3406
              if instance.admin_up:
3407
                val = "running"
3408
              else:
3409
                val = "ERROR_up"
3410
            else:
3411
              if instance.admin_up:
3412
                val = "ERROR_down"
3413
              else:
3414
                val = "ADMIN_down"
3415
        elif field == "oper_ram":
3416
          if instance.primary_node in bad_nodes:
3417
            val = None
3418
          elif instance.name in live_data:
3419
            val = live_data[instance.name].get("memory", "?")
3420
          else:
3421
            val = "-"
3422
        elif field == "vcpus":
3423
          val = i_be[constants.BE_VCPUS]
3424
        elif field == "disk_template":
3425
          val = instance.disk_template
3426
        elif field == "ip":
3427
          if instance.nics:
3428
            val = instance.nics[0].ip
3429
          else:
3430
            val = None
3431
        elif field == "bridge":
3432
          if instance.nics:
3433
            val = instance.nics[0].bridge
3434
          else:
3435
            val = None
3436
        elif field == "mac":
3437
          if instance.nics:
3438
            val = instance.nics[0].mac
3439
          else:
3440
            val = None
3441
        elif field == "sda_size" or field == "sdb_size":
3442
          idx = ord(field[2]) - ord('a')
3443
          try:
3444
            val = instance.FindDisk(idx).size
3445
          except errors.OpPrereqError:
3446
            val = None
3447
        elif field == "disk_usage": # total disk usage per node
3448
          disk_sizes = [{'size': disk.size} for disk in instance.disks]
3449
          val = _ComputeDiskSize(instance.disk_template, disk_sizes)
3450
        elif field == "tags":
3451
          val = list(instance.GetTags())
3452
        elif field == "serial_no":
3453
          val = instance.serial_no
3454
        elif field == "network_port":
3455
          val = instance.network_port
3456
        elif field == "hypervisor":
3457
          val = instance.hypervisor
3458
        elif field == "hvparams":
3459
          val = i_hv
3460
        elif (field.startswith(HVPREFIX) and
3461
              field[len(HVPREFIX):] in constants.HVS_PARAMETERS):
3462
          val = i_hv.get(field[len(HVPREFIX):], None)
3463
        elif field == "beparams":
3464
          val = i_be
3465
        elif (field.startswith(BEPREFIX) and
3466
              field[len(BEPREFIX):] in constants.BES_PARAMETERS):
3467
          val = i_be.get(field[len(BEPREFIX):], None)
3468
        elif st_match and st_match.groups():
3469
          # matches a variable list
3470
          st_groups = st_match.groups()
3471
          if st_groups and st_groups[0] == "disk":
3472
            if st_groups[1] == "count":
3473
              val = len(instance.disks)
3474
            elif st_groups[1] == "sizes":
3475
              val = [disk.size for disk in instance.disks]
3476
            elif st_groups[1] == "size":
3477
              try:
3478
                val = instance.FindDisk(st_groups[2]).size
3479
              except errors.OpPrereqError:
3480
                val = None
3481
            else:
3482
              assert False, "Unhandled disk parameter"
3483
          elif st_groups[0] == "nic":
3484
            if st_groups[1] == "count":
3485
              val = len(instance.nics)
3486
            elif st_groups[1] == "macs":
3487
              val = [nic.mac for nic in instance.nics]
3488
            elif st_groups[1] == "ips":
3489
              val = [nic.ip for nic in instance.nics]
3490
            elif st_groups[1] == "bridges":
3491
              val = [nic.bridge for nic in instance.nics]
3492
            else:
3493
              # index-based item
3494
              nic_idx = int(st_groups[2])
3495
              if nic_idx >= len(instance.nics):
3496
                val = None
3497
              else:
3498
                if st_groups[1] == "mac":
3499
                  val = instance.nics[nic_idx].mac
3500
                elif st_groups[1] == "ip":
3501
                  val = instance.nics[nic_idx].ip
3502
                elif st_groups[1] == "bridge":
3503
                  val = instance.nics[nic_idx].bridge
3504
                else:
3505
                  assert False, "Unhandled NIC parameter"
3506
          else:
3507
            assert False, ("Declared but unhandled variable parameter '%s'" %
3508
                           field)
3509
        else:
3510
          assert False, "Declared but unhandled parameter '%s'" % field
3511
        iout.append(val)
3512
      output.append(iout)
3513

    
3514
    return output
3515

    
3516

    
3517
class LUFailoverInstance(LogicalUnit):
3518
  """Failover an instance.
3519

3520
  """
3521
  HPATH = "instance-failover"
3522
  HTYPE = constants.HTYPE_INSTANCE
3523
  _OP_REQP = ["instance_name", "ignore_consistency"]
3524
  REQ_BGL = False
3525

    
3526
  def ExpandNames(self):
3527
    self._ExpandAndLockInstance()
3528
    self.needed_locks[locking.LEVEL_NODE] = []
3529
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
3530

    
3531
  def DeclareLocks(self, level):
3532
    if level == locking.LEVEL_NODE:
3533
      self._LockInstancesNodes()
3534

    
3535
  def BuildHooksEnv(self):
3536
    """Build hooks env.
3537

3538
    This runs on master, primary and secondary nodes of the instance.
3539

3540
    """
3541
    env = {
3542
      "IGNORE_CONSISTENCY": self.op.ignore_consistency,
3543
      }
3544
    env.update(_BuildInstanceHookEnvByObject(self, self.instance))
3545
    nl = [self.cfg.GetMasterNode()] + list(self.instance.secondary_nodes)
3546
    return env, nl, nl
3547

    
3548
  def CheckPrereq(self):
3549
    """Check prerequisites.
3550

3551
    This checks that the instance is in the cluster.
3552

3553
    """
3554
    self.instance = instance = self.cfg.GetInstanceInfo(self.op.instance_name)
3555
    assert self.instance is not None, \
3556
      "Cannot retrieve locked instance %s" % self.op.instance_name
3557

    
3558
    bep = self.cfg.GetClusterInfo().FillBE(instance)
3559
    if instance.disk_template not in constants.DTS_NET_MIRROR:
3560
      raise errors.OpPrereqError("Instance's disk layout is not"
3561
                                 " network mirrored, cannot failover.")
3562

    
3563
    secondary_nodes = instance.secondary_nodes
3564
    if not secondary_nodes:
3565
      raise errors.ProgrammerError("no secondary node but using "
3566
                                   "a mirrored disk template")
3567

    
3568
    target_node = secondary_nodes[0]
3569
    _CheckNodeOnline(self, target_node)
3570
    _CheckNodeNotDrained(self, target_node)
3571

    
3572
    if instance.admin_up:
3573
      # check memory requirements on the secondary node
3574
      _CheckNodeFreeMemory(self, target_node, "failing over instance %s" %
3575
                           instance.name, bep[constants.BE_MEMORY],
3576
                           instance.hypervisor)
3577
    else:
3578
      self.LogInfo("Not checking memory on the secondary node as"
3579
                   " instance will not be started")
3580

    
3581
    # check bridge existance
3582
    brlist = [nic.bridge for nic in instance.nics]
3583
    result = self.rpc.call_bridges_exist(target_node, brlist)
3584
    result.Raise()
3585
    if not result.data:
3586
      raise errors.OpPrereqError("One or more target bridges %s does not"
3587
                                 " exist on destination node '%s'" %
3588
                                 (brlist, target_node))
3589

    
3590
  def Exec(self, feedback_fn):
3591
    """Failover an instance.
3592

3593
    The failover is done by shutting it down on its present node and
3594
    starting it on the secondary.
3595

3596
    """
3597
    instance = self.instance
3598

    
3599
    source_node = instance.primary_node
3600
    target_node = instance.secondary_nodes[0]
3601

    
3602
    feedback_fn("* checking disk consistency between source and target")
3603
    for dev in instance.disks:
3604
      # for drbd, these are drbd over lvm
3605
      if not _CheckDiskConsistency(self, dev, target_node, False):
3606
        if instance.admin_up and not self.op.ignore_consistency:
3607
          raise errors.OpExecError("Disk %s is degraded on target node,"
3608
                                   " aborting failover." % dev.iv_name)
3609

    
3610
    feedback_fn("* shutting down instance on source node")
3611
    logging.info("Shutting down instance %s on node %s",
3612
                 instance.name, source_node)
3613

    
3614
    result = self.rpc.call_instance_shutdown(source_node, instance)
3615
    msg = result.RemoteFailMsg()
3616
    if msg:
3617
      if self.op.ignore_consistency:
3618
        self.proc.LogWarning("Could not shutdown instance %s on node %s."
3619
                             " Proceeding anyway. Please make sure node"
3620
                             " %s is down. Error details: %s",
3621
                             instance.name, source_node, source_node, msg)
3622
      else:
3623
        raise errors.OpExecError("Could not shutdown instance %s on"
3624
                                 " node %s: %s" %
3625
                                 (instance.name, source_node, msg))
3626

    
3627
    feedback_fn("* deactivating the instance's disks on source node")
3628
    if not _ShutdownInstanceDisks(self, instance, ignore_primary=True):
3629
      raise errors.OpExecError("Can't shut down the instance's disks.")
3630

    
3631
    instance.primary_node = target_node
3632
    # distribute new instance config to the other nodes
3633
    self.cfg.Update(instance)
3634

    
3635
    # Only start the instance if it's marked as up
3636
    if instance.admin_up:
3637
      feedback_fn("* activating the instance's disks on target node")
3638
      logging.info("Starting instance %s on node %s",
3639
                   instance.name, target_node)
3640

    
3641
      disks_ok, dummy = _AssembleInstanceDisks(self, instance,
3642
                                               ignore_secondaries=True)
3643
      if not disks_ok:
3644
        _ShutdownInstanceDisks(self, instance)
3645
        raise errors.OpExecError("Can't activate the instance's disks")
3646

    
3647
      feedback_fn("* starting the instance on the target node")
3648
      result = self.rpc.call_instance_start(target_node, instance, None, None)
3649
      msg = result.RemoteFailMsg()
3650
      if msg:
3651
        _ShutdownInstanceDisks(self, instance)
3652
        raise errors.OpExecError("Could not start instance %s on node %s: %s" %
3653
                                 (instance.name, target_node, msg))
3654

    
3655

    
3656
class LUMigrateInstance(LogicalUnit):
3657
  """Migrate an instance.
3658

3659
  This is migration without shutting down, compared to the failover,
3660
  which is done with shutdown.
3661

3662
  """
3663
  HPATH = "instance-migrate"
3664
  HTYPE = constants.HTYPE_INSTANCE
3665
  _OP_REQP = ["instance_name", "live", "cleanup"]
3666

    
3667
  REQ_BGL = False
3668

    
3669
  def ExpandNames(self):
3670
    self._ExpandAndLockInstance()
3671
    self.needed_locks[locking.LEVEL_NODE] = []
3672
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
3673

    
3674
  def DeclareLocks(self, level):
3675
    if level == locking.LEVEL_NODE:
3676
      self._LockInstancesNodes()
3677

    
3678
  def BuildHooksEnv(self):
3679
    """Build hooks env.
3680

3681
    This runs on master, primary and secondary nodes of the instance.
3682

3683
    """
3684
    env = _BuildInstanceHookEnvByObject(self, self.instance)
3685
    env["MIGRATE_LIVE"] = self.op.live
3686
    env["MIGRATE_CLEANUP"] = self.op.cleanup
3687
    nl = [self.cfg.GetMasterNode()] + list(self.instance.secondary_nodes)
3688
    return env, nl, nl
3689

    
3690
  def CheckPrereq(self):
3691
    """Check prerequisites.
3692

3693
    This checks that the instance is in the cluster.
3694

3695
    """
3696
    instance = self.cfg.GetInstanceInfo(
3697
      self.cfg.ExpandInstanceName(self.op.instance_name))
3698
    if instance is None:
3699
      raise errors.OpPrereqError("Instance '%s' not known" %
3700
                                 self.op.instance_name)
3701

    
3702
    if instance.disk_template != constants.DT_DRBD8:
3703
      raise errors.OpPrereqError("Instance's disk layout is not"
3704
                                 " drbd8, cannot migrate.")
3705

    
3706
    secondary_nodes = instance.secondary_nodes
3707
    if not secondary_nodes:
3708
      raise errors.ConfigurationError("No secondary node but using"
3709
                                      " drbd8 disk template")
3710

    
3711
    i_be = self.cfg.GetClusterInfo().FillBE(instance)
3712

    
3713
    target_node = secondary_nodes[0]
3714
    # check memory requirements on the secondary node
3715
    _CheckNodeFreeMemory(self, target_node, "migrating instance %s" %
3716
                         instance.name, i_be[constants.BE_MEMORY],
3717
                         instance.hypervisor)
3718

    
3719
    # check bridge existance
3720
    brlist = [nic.bridge for nic in instance.nics]
3721
    result = self.rpc.call_bridges_exist(target_node, brlist)
3722
    if result.failed or not result.data:
3723
      raise errors.OpPrereqError("One or more target bridges %s does not"
3724
                                 " exist on destination node '%s'" %
3725
                                 (brlist, target_node))
3726

    
3727
    if not self.op.cleanup:
3728
      _CheckNodeNotDrained(self, target_node)
3729
      result = self.rpc.call_instance_migratable(instance.primary_node,
3730
                                                 instance)
3731
      msg = result.RemoteFailMsg()
3732
      if msg:
3733
        raise errors.OpPrereqError("Can't migrate: %s - please use failover" %
3734
                                   msg)
3735

    
3736
    self.instance = instance
3737

    
3738
  def _WaitUntilSync(self):
3739
    """Poll with custom rpc for disk sync.
3740

3741
    This uses our own step-based rpc call.
3742

3743
    """
3744
    self.feedback_fn("* wait until resync is done")
3745
    all_done = False
3746
    while not all_done:
3747
      all_done = True
3748
      result = self.rpc.call_drbd_wait_sync(self.all_nodes,
3749
                                            self.nodes_ip,
3750
                                            self.instance.disks)
3751
      min_percent = 100
3752
      for node, nres in result.items():
3753
        msg = nres.RemoteFailMsg()
3754
        if msg:
3755
          raise errors.OpExecError("Cannot resync disks on node %s: %s" %
3756
                                   (node, msg))
3757
        node_done, node_percent = nres.payload
3758
        all_done = all_done and node_done
3759
        if node_percent is not None:
3760
          min_percent = min(min_percent, node_percent)
3761
      if not all_done:
3762
        if min_percent < 100:
3763
          self.feedback_fn("   - progress: %.1f%%" % min_percent)
3764
        time.sleep(2)
3765

    
3766
  def _EnsureSecondary(self, node):
3767
    """Demote a node to secondary.
3768

3769
    """
3770
    self.feedback_fn("* switching node %s to secondary mode" % node)
3771

    
3772
    for dev in self.instance.disks:
3773
      self.cfg.SetDiskID(dev, node)
3774

    
3775
    result = self.rpc.call_blockdev_close(node, self.instance.name,
3776
                                          self.instance.disks)
3777
    msg = result.RemoteFailMsg()
3778
    if msg:
3779
      raise errors.OpExecError("Cannot change disk to secondary on node %s,"
3780
                               " error %s" % (node, msg))
3781

    
3782
  def _GoStandalone(self):
3783
    """Disconnect from the network.
3784

3785
    """
3786
    self.feedback_fn("* changing into standalone mode")
3787
    result = self.rpc.call_drbd_disconnect_net(self.all_nodes, self.nodes_ip,
3788
                                               self.instance.disks)
3789
    for node, nres in result.items():
3790
      msg = nres.RemoteFailMsg()
3791
      if msg:
3792
        raise errors.OpExecError("Cannot disconnect disks node %s,"
3793
                                 " error %s" % (node, msg))
3794

    
3795
  def _GoReconnect(self, multimaster):
3796
    """Reconnect to the network.
3797

3798
    """
3799
    if multimaster:
3800
      msg = "dual-master"
3801
    else:
3802
      msg = "single-master"
3803
    self.feedback_fn("* changing disks into %s mode" % msg)
3804
    result = self.rpc.call_drbd_attach_net(self.all_nodes, self.nodes_ip,
3805
                                           self.instance.disks,
3806
                                           self.instance.name, multimaster)
3807
    for node, nres in result.items():
3808
      msg = nres.RemoteFailMsg()
3809
      if msg:
3810
        raise errors.OpExecError("Cannot change disks config on node %s,"
3811
                                 " error: %s" % (node, msg))
3812

    
3813
  def _ExecCleanup(self):
3814
    """Try to cleanup after a failed migration.
3815

3816
    The cleanup is done by:
3817
      - check that the instance is running only on one node
3818
        (and update the config if needed)
3819
      - change disks on its secondary node to secondary
3820
      - wait until disks are fully synchronized
3821
      - disconnect from the network
3822
      - change disks into single-master mode
3823
      - wait again until disks are fully synchronized
3824

3825
    """
3826
    instance = self.instance
3827
    target_node = self.target_node
3828
    source_node = self.source_node
3829

    
3830
    # check running on only one node
3831
    self.feedback_fn("* checking where the instance actually runs"
3832
                     " (if this hangs, the hypervisor might be in"
3833
                     " a bad state)")
3834
    ins_l = self.rpc.call_instance_list(self.all_nodes, [instance.hypervisor])
3835
    for node, result in ins_l.items():
3836
      result.Raise()
3837
      if not isinstance(result.data, list):
3838
        raise errors.OpExecError("Can't contact node '%s'" % node)
3839

    
3840
    runningon_source = instance.name in ins_l[source_node].data
3841
    runningon_target = instance.name in ins_l[target_node].data
3842

    
3843
    if runningon_source and runningon_target:
3844
      raise errors.OpExecError("Instance seems to be running on two nodes,"
3845
                               " or the hypervisor is confused. You will have"
3846
                               " to ensure manually that it runs only on one"
3847
                               " and restart this operation.")
3848

    
3849
    if not (runningon_source or runningon_target):
3850
      raise errors.OpExecError("Instance does not seem to be running at all."
3851
                               " In this case, it's safer to repair by"
3852
                               " running 'gnt-instance stop' to ensure disk"
3853
                               " shutdown, and then restarting it.")
3854

    
3855
    if runningon_target:
3856
      # the migration has actually succeeded, we need to update the config
3857
      self.feedback_fn("* instance running on secondary node (%s),"
3858
                       " updating config" % target_node)
3859
      instance.primary_node = target_node
3860
      self.cfg.Update(instance)
3861
      demoted_node = source_node
3862
    else:
3863
      self.feedback_fn("* instance confirmed to be running on its"
3864
                       " primary node (%s)" % source_node)
3865
      demoted_node = target_node
3866

    
3867
    self._EnsureSecondary(demoted_node)
3868
    try:
3869
      self._WaitUntilSync()
3870
    except errors.OpExecError:
3871
      # we ignore here errors, since if the device is standalone, it
3872
      # won't be able to sync
3873
      pass
3874
    self._GoStandalone()
3875
    self._GoReconnect(False)
3876
    self._WaitUntilSync()
3877

    
3878
    self.feedback_fn("* done")
3879

    
3880
  def _RevertDiskStatus(self):
3881
    """Try to revert the disk status after a failed migration.
3882

3883
    """
3884
    target_node = self.target_node
3885
    try:
3886
      self._EnsureSecondary(target_node)
3887
      self._GoStandalone()
3888
      self._GoReconnect(False)
3889
      self._WaitUntilSync()
3890
    except errors.OpExecError, err:
3891
      self.LogWarning("Migration failed and I can't reconnect the"
3892
                      " drives: error '%s'\n"
3893
                      "Please look and recover the instance status" %
3894
                      str(err))
3895

    
3896
  def _AbortMigration(self):
3897
    """Call the hypervisor code to abort a started migration.
3898

3899
    """
3900
    instance = self.instance
3901
    target_node = self.target_node
3902
    migration_info = self.migration_info
3903

    
3904
    abort_result = self.rpc.call_finalize_migration(target_node,
3905
                                                    instance,
3906
                                                    migration_info,
3907
                                                    False)
3908
    abort_msg = abort_result.RemoteFailMsg()
3909
    if abort_msg:
3910
      logging.error("Aborting migration failed on target node %s: %s" %
3911
                    (target_node, abort_msg))
3912
      # Don't raise an exception here, as we stil have to try to revert the
3913
      # disk status, even if this step failed.
3914

    
3915
  def _ExecMigration(self):
3916
    """Migrate an instance.
3917

3918
    The migrate is done by:
3919
      - change the disks into dual-master mode
3920
      - wait until disks are fully synchronized again
3921
      - migrate the instance
3922
      - change disks on the new secondary node (the old primary) to secondary
3923
      - wait until disks are fully synchronized
3924
      - change disks into single-master mode
3925

3926
    """
3927
    instance = self.instance
3928
    target_node = self.target_node
3929
    source_node = self.source_node
3930

    
3931
    self.feedback_fn("* checking disk consistency between source and target")
3932
    for dev in instance.disks:
3933
      if not _CheckDiskConsistency(self, dev, target_node, False):
3934
        raise errors.OpExecError("Disk %s is degraded or not fully"
3935
                                 " synchronized on target node,"
3936
                                 " aborting migrate." % dev.iv_name)
3937

    
3938
    # First get the migration information from the remote node
3939
    result = self.rpc.call_migration_info(source_node, instance)
3940
    msg = result.RemoteFailMsg()
3941
    if msg:
3942
      log_err = ("Failed fetching source migration information from %s: %s" %
3943
                 (source_node, msg))
3944
      logging.error(log_err)
3945
      raise errors.OpExecError(log_err)
3946

    
3947
    self.migration_info = migration_info = result.payload
3948

    
3949
    # Then switch the disks to master/master mode
3950
    self._EnsureSecondary(target_node)
3951
    self._GoStandalone()
3952
    self._GoReconnect(True)
3953
    self._WaitUntilSync()
3954

    
3955
    self.feedback_fn("* preparing %s to accept the instance" % target_node)
3956
    result = self.rpc.call_accept_instance(target_node,
3957
                                           instance,
3958
                                           migration_info,
3959
                                           self.nodes_ip[target_node])
3960

    
3961
    msg = result.RemoteFailMsg()
3962
    if msg:
3963
      logging.error("Instance pre-migration failed, trying to revert"
3964
                    " disk status: %s", msg)
3965
      self._AbortMigration()
3966
      self._RevertDiskStatus()
3967
      raise errors.OpExecError("Could not pre-migrate instance %s: %s" %
3968
                               (instance.name, msg))
3969

    
3970
    self.feedback_fn("* migrating instance to %s" % target_node)
3971
    time.sleep(10)
3972
    result = self.rpc.call_instance_migrate(source_node, instance,
3973
                                            self.nodes_ip[target_node],
3974
                                            self.op.live)
3975
    msg = result.RemoteFailMsg()
3976
    if msg:
3977
      logging.error("Instance migration failed, trying to revert"
3978
                    " disk status: %s", msg)
3979
      self._AbortMigration()
3980
      self._RevertDiskStatus()
3981
      raise errors.OpExecError("Could not migrate instance %s: %s" %
3982
                               (instance.name, msg))
3983
    time.sleep(10)
3984

    
3985
    instance.primary_node = target_node
3986
    # distribute new instance config to the other nodes
3987
    self.cfg.Update(instance)
3988

    
3989
    result = self.rpc.call_finalize_migration(target_node,
3990
                                              instance,
3991
                                              migration_info,
3992
                                              True)
3993
    msg = result.RemoteFailMsg()
3994
    if msg:
3995
      logging.error("Instance migration succeeded, but finalization failed:"
3996
                    " %s" % msg)
3997
      raise errors.OpExecError("Could not finalize instance migration: %s" %
3998
                               msg)
3999

    
4000
    self._EnsureSecondary(source_node)
4001
    self._WaitUntilSync()
4002
    self._GoStandalone()
4003
    self._GoReconnect(False)
4004
    self._WaitUntilSync()
4005

    
4006
    self.feedback_fn("* done")
4007

    
4008
  def Exec(self, feedback_fn):
4009
    """Perform the migration.
4010

4011
    """
4012
    self.feedback_fn = feedback_fn
4013

    
4014
    self.source_node = self.instance.primary_node
4015
    self.target_node = self.instance.secondary_nodes[0]
4016
    self.all_nodes = [self.source_node, self.target_node]
4017
    self.nodes_ip = {
4018
      self.source_node: self.cfg.GetNodeInfo(self.source_node).secondary_ip,
4019
      self.target_node: self.cfg.GetNodeInfo(self.target_node).secondary_ip,
4020
      }
4021
    if self.op.cleanup:
4022
      return self._ExecCleanup()
4023
    else:
4024
      return self._ExecMigration()
4025

    
4026

    
4027
def _CreateBlockDev(lu, node, instance, device, force_create,
4028
                    info, force_open):
4029
  """Create a tree of block devices on a given node.
4030

4031
  If this device type has to be created on secondaries, create it and
4032
  all its children.
4033

4034
  If not, just recurse to children keeping the same 'force' value.
4035

4036
  @param lu: the lu on whose behalf we execute
4037
  @param node: the node on which to create the device
4038
  @type instance: L{objects.Instance}
4039
  @param instance: the instance which owns the device
4040
  @type device: L{objects.Disk}
4041
  @param device: the device to create
4042
  @type force_create: boolean
4043
  @param force_create: whether to force creation of this device; this
4044
      will be change to True whenever we find a device which has
4045
      CreateOnSecondary() attribute
4046
  @param info: the extra 'metadata' we should attach to the device
4047
      (this will be represented as a LVM tag)
4048
  @type force_open: boolean
4049
  @param force_open: this parameter will be passes to the
4050
      L{backend.BlockdevCreate} function where it specifies
4051
      whether we run on primary or not, and it affects both
4052
      the child assembly and the device own Open() execution
4053

4054
  """
4055
  if device.CreateOnSecondary():
4056
    force_create = True
4057

    
4058
  if device.children:
4059
    for child in device.children:
4060
      _CreateBlockDev(lu, node, instance, child, force_create,
4061
                      info, force_open)
4062

    
4063
  if not force_create:
4064
    return
4065

    
4066
  _CreateSingleBlockDev(lu, node, instance, device, info, force_open)
4067

    
4068

    
4069
def _CreateSingleBlockDev(lu, node, instance, device, info, force_open):
4070
  """Create a single block device on a given node.
4071

4072
  This will not recurse over children of the device, so they must be
4073
  created in advance.
4074

4075
  @param lu: the lu on whose behalf we execute
4076
  @param node: the node on which to create the device
4077
  @type instance: L{objects.Instance}
4078
  @param instance: the instance which owns the device
4079
  @type device: L{objects.Disk}
4080
  @param device: the device to create
4081
  @param info: the extra 'metadata' we should attach to the device
4082
      (this will be represented as a LVM tag)
4083
  @type force_open: boolean
4084
  @param force_open: this parameter will be passes to the
4085
      L{backend.BlockdevCreate} function where it specifies
4086
      whether we run on primary or not, and it affects both
4087
      the child assembly and the device own Open() execution
4088

4089
  """
4090
  lu.cfg.SetDiskID(device, node)
4091
  result = lu.rpc.call_blockdev_create(node, device, device.size,
4092
                                       instance.name, force_open, info)
4093
  msg = result.RemoteFailMsg()
4094
  if msg:
4095
    raise errors.OpExecError("Can't create block device %s on"
4096
                             " node %s for instance %s: %s" %
4097
                             (device, node, instance.name, msg))
4098
  if device.physical_id is None:
4099
    device.physical_id = result.payload
4100

    
4101

    
4102
def _GenerateUniqueNames(lu, exts):
4103
  """Generate a suitable LV name.
4104

4105
  This will generate a logical volume name for the given instance.
4106

4107
  """
4108
  results = []
4109
  for val in exts:
4110
    new_id = lu.cfg.GenerateUniqueID()
4111
    results.append("%s%s" % (new_id, val))
4112
  return results
4113

    
4114

    
4115
def _GenerateDRBD8Branch(lu, primary, secondary, size, names, iv_name,
4116
                         p_minor, s_minor):
4117
  """Generate a drbd8 device complete with its children.
4118

4119
  """
4120
  port = lu.cfg.AllocatePort()
4121
  vgname = lu.cfg.GetVGName()
4122
  shared_secret = lu.cfg.GenerateDRBDSecret()
4123
  dev_data = objects.Disk(dev_type=constants.LD_LV, size=size,
4124
                          logical_id=(vgname, names[0]))
4125
  dev_meta = objects.Disk(dev_type=constants.LD_LV, size=128,
4126
                          logical_id=(vgname, names[1]))
4127
  drbd_dev = objects.Disk(dev_type=constants.LD_DRBD8, size=size,
4128
                          logical_id=(primary, secondary, port,
4129
                                      p_minor, s_minor,
4130
                                      shared_secret),
4131
                          children=[dev_data, dev_meta],
4132
                          iv_name=iv_name)
4133
  return drbd_dev
4134

    
4135

    
4136
def _GenerateDiskTemplate(lu, template_name,
4137
                          instance_name, primary_node,
4138
                          secondary_nodes, disk_info,
4139
                          file_storage_dir, file_driver,
4140
                          base_index):
4141
  """Generate the entire disk layout for a given template type.
4142

4143
  """
4144
  #TODO: compute space requirements
4145

    
4146
  vgname = lu.cfg.GetVGName()
4147
  disk_count = len(disk_info)
4148
  disks = []
4149
  if template_name == constants.DT_DISKLESS:
4150
    pass
4151
  elif template_name == constants.DT_PLAIN:
4152
    if len(secondary_nodes) != 0:
4153
      raise errors.ProgrammerError("Wrong template configuration")
4154

    
4155
    names = _GenerateUniqueNames(lu, [".disk%d" % i
4156
                                      for i in range(disk_count)])
4157
    for idx, disk in enumerate(disk_info):
4158
      disk_index = idx + base_index
4159
      disk_dev = objects.Disk(dev_type=constants.LD_LV, size=disk["size"],
4160
                              logical_id=(vgname, names[idx]),
4161
                              iv_name="disk/%d" % disk_index,
4162
                              mode=disk["mode"])
4163
      disks.append(disk_dev)
4164
  elif template_name == constants.DT_DRBD8:
4165
    if len(secondary_nodes) != 1:
4166
      raise errors.ProgrammerError("Wrong template configuration")
4167
    remote_node = secondary_nodes[0]
4168
    minors = lu.cfg.AllocateDRBDMinor(
4169
      [primary_node, remote_node] * len(disk_info), instance_name)
4170

    
4171
    names = []
4172
    for lv_prefix in _GenerateUniqueNames(lu, [".disk%d" % i
4173
                                               for i in range(disk_count)]):
4174
      names.append(lv_prefix + "_data")
4175
      names.append(lv_prefix + "_meta")
4176
    for idx, disk in enumerate(disk_info):
4177
      disk_index = idx + base_index
4178
      disk_dev = _GenerateDRBD8Branch(lu, primary_node, remote_node,
4179
                                      disk["size"], names[idx*2:idx*2+2],
4180
                                      "disk/%d" % disk_index,
4181
                                      minors[idx*2], minors[idx*2+1])
4182
      disk_dev.mode = disk["mode"]
4183
      disks.append(disk_dev)
4184
  elif template_name == constants.DT_FILE:
4185
    if len(secondary_nodes) != 0:
4186
      raise errors.ProgrammerError("Wrong template configuration")
4187

    
4188
    for idx, disk in enumerate(disk_info):
4189
      disk_index = idx + base_index
4190
      disk_dev = objects.Disk(dev_type=constants.LD_FILE, size=disk["size"],
4191
                              iv_name="disk/%d" % disk_index,
4192
                              logical_id=(file_driver,
4193
                                          "%s/disk%d" % (file_storage_dir,
4194
                                                         disk_index)),
4195
                              mode=disk["mode"])
4196
      disks.append(disk_dev)
4197
  else:
4198
    raise errors.ProgrammerError("Invalid disk template '%s'" % template_name)
4199
  return disks
4200

    
4201

    
4202
def _GetInstanceInfoText(instance):
4203
  """Compute that text that should be added to the disk's metadata.
4204

4205
  """
4206
  return "originstname+%s" % instance.name
4207

    
4208

    
4209
def _CreateDisks(lu, instance):
4210
  """Create all disks for an instance.
4211

4212
  This abstracts away some work from AddInstance.
4213

4214
  @type lu: L{LogicalUnit}
4215
  @param lu: the logical unit on whose behalf we execute
4216
  @type instance: L{objects.Instance}
4217
  @param instance: the instance whose disks we should create
4218
  @rtype: boolean
4219
  @return: the success of the creation
4220

4221
  """
4222
  info = _GetInstanceInfoText(instance)
4223
  pnode = instance.primary_node
4224

    
4225
  if instance.disk_template == constants.DT_FILE:
4226
    file_storage_dir = os.path.dirname(instance.disks[0].logical_id[1])
4227
    result = lu.rpc.call_file_storage_dir_create(pnode, file_storage_dir)
4228

    
4229
    if result.failed or not result.data:
4230
      raise errors.OpExecError("Could not connect to node '%s'" % pnode)
4231

    
4232
    if not result.data[0]:
4233
      raise errors.OpExecError("Failed to create directory '%s'" %
4234
                               file_storage_dir)
4235

    
4236
  # Note: this needs to be kept in sync with adding of disks in
4237
  # LUSetInstanceParams
4238
  for device in instance.disks:
4239
    logging.info("Creating volume %s for instance %s",
4240
                 device.iv_name, instance.name)
4241
    #HARDCODE
4242
    for node in instance.all_nodes:
4243
      f_create = node == pnode
4244
      _CreateBlockDev(lu, node, instance, device, f_create, info, f_create)
4245

    
4246

    
4247
def _RemoveDisks(lu, instance):
4248
  """Remove all disks for an instance.
4249

4250
  This abstracts away some work from `AddInstance()` and
4251
  `RemoveInstance()`. Note that in case some of the devices couldn't
4252
  be removed, the removal will continue with the other ones (compare
4253
  with `_CreateDisks()`).
4254

4255
  @type lu: L{LogicalUnit}
4256
  @param lu: the logical unit on whose behalf we execute
4257
  @type instance: L{objects.Instance}
4258
  @param instance: the instance whose disks we should remove
4259
  @rtype: boolean
4260
  @return: the success of the removal
4261

4262
  """
4263
  logging.info("Removing block devices for instance %s", instance.name)
4264

    
4265
  all_result = True
4266
  for device in instance.disks:
4267
    for node, disk in device.ComputeNodeTree(instance.primary_node):
4268
      lu.cfg.SetDiskID(disk, node)
4269
      msg = lu.rpc.call_blockdev_remove(node, disk).RemoteFailMsg()
4270
      if msg:
4271
        lu.LogWarning("Could not remove block device %s on node %s,"
4272
                      " continuing anyway: %s", device.iv_name, node, msg)
4273
        all_result = False
4274

    
4275
  if instance.disk_template == constants.DT_FILE:
4276
    file_storage_dir = os.path.dirname(instance.disks[0].logical_id[1])
4277
    result = lu.rpc.call_file_storage_dir_remove(instance.primary_node,
4278
                                                 file_storage_dir)
4279
    if result.failed or not result.data:
4280
      logging.error("Could not remove directory '%s'", file_storage_dir)
4281
      all_result = False
4282

    
4283
  return all_result
4284

    
4285

    
4286
def _ComputeDiskSize(disk_template, disks):
4287
  """Compute disk size requirements in the volume group
4288

4289
  """
4290
  # Required free disk space as a function of disk and swap space
4291
  req_size_dict = {
4292
    constants.DT_DISKLESS: None,
4293
    constants.DT_PLAIN: sum(d["size"] for d in disks),
4294
    # 128 MB are added for drbd metadata for each disk
4295
    constants.DT_DRBD8: sum(d["size"] + 128 for d in disks),
4296
    constants.DT_FILE: None,
4297
  }
4298

    
4299
  if disk_template not in req_size_dict:
4300
    raise errors.ProgrammerError("Disk template '%s' size requirement"
4301
                                 " is unknown" %  disk_template)
4302

    
4303
  return req_size_dict[disk_template]
4304

    
4305

    
4306
def _CheckHVParams(lu, nodenames, hvname, hvparams):
4307
  """Hypervisor parameter validation.
4308

4309
  This function abstract the hypervisor parameter validation to be
4310
  used in both instance create and instance modify.
4311

4312
  @type lu: L{LogicalUnit}
4313
  @param lu: the logical unit for which we check
4314
  @type nodenames: list
4315
  @param nodenames: the list of nodes on which we should check
4316
  @type hvname: string
4317
  @param hvname: the name of the hypervisor we should use
4318
  @type hvparams: dict
4319
  @param hvparams: the parameters which we need to check
4320
  @raise errors.OpPrereqError: if the parameters are not valid
4321

4322
  """
4323
  hvinfo = lu.rpc.call_hypervisor_validate_params(nodenames,
4324
                                                  hvname,
4325
                                                  hvparams)
4326
  for node in nodenames:
4327
    info = hvinfo[node]
4328
    if info.offline:
4329
      continue
4330
    msg = info.RemoteFailMsg()
4331
    if msg:
4332
      raise errors.OpPrereqError("Hypervisor parameter validation"
4333
                                 " failed on node %s: %s" % (node, msg))
4334

    
4335

    
4336
class LUCreateInstance(LogicalUnit):
4337
  """Create an instance.
4338

4339
  """
4340
  HPATH = "instance-add"
4341
  HTYPE = constants.HTYPE_INSTANCE
4342
  _OP_REQP = ["instance_name", "disks", "disk_template",
4343
              "mode", "start",
4344
              "wait_for_sync", "ip_check", "nics",
4345
              "hvparams", "beparams"]
4346
  REQ_BGL = False
4347

    
4348
  def _ExpandNode(self, node):
4349
    """Expands and checks one node name.
4350

4351
    """
4352
    node_full = self.cfg.ExpandNodeName(node)
4353
    if node_full is None:
4354
      raise errors.OpPrereqError("Unknown node %s" % node)
4355
    return node_full
4356

    
4357
  def ExpandNames(self):
4358
    """ExpandNames for CreateInstance.
4359

4360
    Figure out the right locks for instance creation.
4361

4362
    """
4363
    self.needed_locks = {}
4364

    
4365
    # set optional parameters to none if they don't exist
4366
    for attr in ["pnode", "snode", "iallocator", "hypervisor"]:
4367
      if not hasattr(self.op, attr):
4368
        setattr(self.op, attr, None)
4369

    
4370
    # cheap checks, mostly valid constants given
4371

    
4372
    # verify creation mode
4373
    if self.op.mode not in (constants.INSTANCE_CREATE,
4374
                            constants.INSTANCE_IMPORT):
4375
      raise errors.OpPrereqError("Invalid instance creation mode '%s'" %
4376
                                 self.op.mode)
4377

    
4378
    # disk template and mirror node verification
4379
    if self.op.disk_template not in constants.DISK_TEMPLATES:
4380
      raise errors.OpPrereqError("Invalid disk template name")
4381

    
4382
    if self.op.hypervisor is None:
4383
      self.op.hypervisor = self.cfg.GetHypervisorType()
4384

    
4385
    cluster = self.cfg.GetClusterInfo()
4386
    enabled_hvs = cluster.enabled_hypervisors
4387
    if self.op.hypervisor not in enabled_hvs:
4388
      raise errors.OpPrereqError("Selected hypervisor (%s) not enabled in the"
4389
                                 " cluster (%s)" % (self.op.hypervisor,
4390
                                  ",".join(enabled_hvs)))
4391

    
4392
    # check hypervisor parameter syntax (locally)
4393
    utils.ForceDictType(self.op.hvparams, constants.HVS_PARAMETER_TYPES)
4394
    filled_hvp = cluster.FillDict(cluster.hvparams[self.op.hypervisor],
4395
                                  self.op.hvparams)
4396
    hv_type = hypervisor.GetHypervisor(self.op.hypervisor)
4397
    hv_type.CheckParameterSyntax(filled_hvp)
4398
    self.hv_full = filled_hvp
4399

    
4400
    # fill and remember the beparams dict
4401
    utils.ForceDictType(self.op.beparams, constants.BES_PARAMETER_TYPES)
4402
    self.be_full = cluster.FillDict(cluster.beparams[constants.BEGR_DEFAULT],
4403
                                    self.op.beparams)
4404

    
4405
    #### instance parameters check
4406

    
4407
    # instance name verification
4408
    hostname1 = utils.HostInfo(self.op.instance_name)
4409
    self.op.instance_name = instance_name = hostname1.name
4410

    
4411
    # this is just a preventive check, but someone might still add this
4412
    # instance in the meantime, and creation will fail at lock-add time
4413
    if instance_name in self.cfg.GetInstanceList():
4414
      raise errors.OpPrereqError("Instance '%s' is already in the cluster" %
4415
                                 instance_name)
4416

    
4417
    self.add_locks[locking.LEVEL_INSTANCE] = instance_name
4418

    
4419
    # NIC buildup
4420
    self.nics = []
4421
    for nic in self.op.nics:
4422
      # ip validity checks
4423
      ip = nic.get("ip", None)
4424
      if ip is None or ip.lower() == "none":
4425
        nic_ip = None
4426
      elif ip.lower() == constants.VALUE_AUTO:
4427
        nic_ip = hostname1.ip
4428
      else:
4429
        if not utils.IsValidIP(ip):
4430
          raise errors.OpPrereqError("Given IP address '%s' doesn't look"
4431
                                     " like a valid IP" % ip)
4432
        nic_ip = ip
4433

    
4434
      # MAC address verification
4435
      mac = nic.get("mac", constants.VALUE_AUTO)
4436
      if mac not in (constants.VALUE_AUTO, constants.VALUE_GENERATE):
4437
        if not utils.IsValidMac(mac.lower()):
4438
          raise errors.OpPrereqError("Invalid MAC address specified: %s" %
4439
                                     mac)
4440
      # bridge verification
4441
      bridge = nic.get("bridge", None)
4442
      if bridge is None:
4443
        bridge = self.cfg.GetDefBridge()
4444
      self.nics.append(objects.NIC(mac=mac, ip=nic_ip, bridge=bridge))
4445

    
4446
    # disk checks/pre-build
4447
    self.disks = []
4448
    for disk in self.op.disks:
4449
      mode = disk.get("mode", constants.DISK_RDWR)
4450
      if mode not in constants.DISK_ACCESS_SET:
4451
        raise errors.OpPrereqError("Invalid disk access mode '%s'" %
4452
                                   mode)
4453
      size = disk.get("size", None)
4454
      if size is None:
4455
        raise errors.OpPrereqError("Missing disk size")
4456
      try:
4457
        size = int(size)
4458
      except ValueError:
4459
        raise errors.OpPrereqError("Invalid disk size '%s'" % size)
4460
      self.disks.append({"size": size, "mode": mode})
4461

    
4462
    # used in CheckPrereq for ip ping check
4463
    self.check_ip = hostname1.ip
4464

    
4465
    # file storage checks
4466
    if (self.op.file_driver and
4467
        not self.op.file_driver in constants.FILE_DRIVER):
4468
      raise errors.OpPrereqError("Invalid file driver name '%s'" %
4469
                                 self.op.file_driver)
4470

    
4471
    if self.op.file_storage_dir and os.path.isabs(self.op.file_storage_dir):
4472
      raise errors.OpPrereqError("File storage directory path not absolute")
4473

    
4474
    ### Node/iallocator related checks
4475
    if [self.op.iallocator, self.op.pnode].count(None) != 1:
4476
      raise errors.OpPrereqError("One and only one of iallocator and primary"
4477
                                 " node must be given")
4478

    
4479
    if self.op.iallocator:
4480
      self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
4481
    else:
4482
      self.op.pnode = self._ExpandNode(self.op.pnode)
4483
      nodelist = [self.op.pnode]
4484
      if self.op.snode is not None:
4485
        self.op.snode = self._ExpandNode(self.op.snode)
4486
        nodelist.append(self.op.snode)
4487
      self.needed_locks[locking.LEVEL_NODE] = nodelist
4488

    
4489
    # in case of import lock the source node too
4490
    if self.op.mode == constants.INSTANCE_IMPORT:
4491
      src_node = getattr(self.op, "src_node", None)
4492
      src_path = getattr(self.op, "src_path", None)
4493

    
4494
      if src_path is None:
4495
        self.op.src_path = src_path = self.op.instance_name
4496

    
4497
      if src_node is None:
4498
        self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
4499
        self.op.src_node = None
4500
        if os.path.isabs(src_path):
4501
          raise errors.OpPrereqError("Importing an instance from an absolute"
4502
                                     " path requires a source node option.")
4503
      else:
4504
        self.op.src_node = src_node = self._ExpandNode(src_node)
4505
        if self.needed_locks[locking.LEVEL_NODE] is not locking.ALL_SET:
4506
          self.needed_locks[locking.LEVEL_NODE].append(src_node)
4507
        if not os.path.isabs(src_path):
4508
          self.op.src_path = src_path = \
4509
            os.path.join(constants.EXPORT_DIR, src_path)
4510

    
4511
    else: # INSTANCE_CREATE
4512
      if getattr(self.op, "os_type", None) is None:
4513
        raise errors.OpPrereqError("No guest OS specified")
4514

    
4515
  def _RunAllocator(self):
4516
    """Run the allocator based on input opcode.
4517

4518
    """
4519
    nics = [n.ToDict() for n in self.nics]
4520
    ial = IAllocator(self,
4521
                     mode=constants.IALLOCATOR_MODE_ALLOC,
4522
                     name=self.op.instance_name,
4523
                     disk_template=self.op.disk_template,
4524
                     tags=[],
4525
                     os=self.op.os_type,
4526
                     vcpus=self.be_full[constants.BE_VCPUS],
4527
                     mem_size=self.be_full[constants.BE_MEMORY],
4528
                     disks=self.disks,
4529
                     nics=nics,
4530
                     hypervisor=self.op.hypervisor,
4531
                     )
4532

    
4533
    ial.Run(self.op.iallocator)
4534

    
4535
    if not ial.success:
4536
      raise errors.OpPrereqError("Can't compute nodes using"
4537
                                 " iallocator '%s': %s" % (self.op.iallocator,
4538
                                                           ial.info))
4539
    if len(ial.nodes) != ial.required_nodes:
4540
      raise errors.OpPrereqError("iallocator '%s' returned invalid number"
4541
                                 " of nodes (%s), required %s" %
4542
                                 (self.op.iallocator, len(ial.nodes),
4543
                                  ial.required_nodes))
4544
    self.op.pnode = ial.nodes[0]
4545
    self.LogInfo("Selected nodes for instance %s via iallocator %s: %s",
4546
                 self.op.instance_name, self.op.iallocator,
4547
                 ", ".join(ial.nodes))
4548
    if ial.required_nodes == 2:
4549
      self.op.snode = ial.nodes[1]
4550

    
4551
  def BuildHooksEnv(self):
4552
    """Build hooks env.
4553

4554
    This runs on master, primary and secondary nodes of the instance.
4555

4556
    """
4557
    env = {
4558
      "ADD_MODE": self.op.mode,
4559
      }
4560
    if self.op.mode == constants.INSTANCE_IMPORT:
4561
      env["SRC_NODE"] = self.op.src_node
4562
      env["SRC_PATH"] = self.op.src_path
4563
      env["SRC_IMAGES"] = self.src_images
4564

    
4565
    env.update(_BuildInstanceHookEnv(
4566
      name=self.op.instance_name,
4567
      primary_node=self.op.pnode,
4568
      secondary_nodes=self.secondaries,
4569
      status=self.op.start,
4570
      os_type=self.op.os_type,
4571
      memory=self.be_full[constants.BE_MEMORY],
4572
      vcpus=self.be_full[constants.BE_VCPUS],
4573
      nics=[(n.ip, n.bridge, n.mac) for n in self.nics],
4574
      disk_template=self.op.disk_template,
4575
      disks=[(d["size"], d["mode"]) for d in self.disks],
4576
      bep=self.be_full,
4577
      hvp=self.hv_full,
4578
      hypervisor=self.op.hypervisor,
4579
    ))
4580

    
4581
    nl = ([self.cfg.GetMasterNode(), self.op.pnode] +
4582
          self.secondaries)
4583
    return env, nl, nl
4584

    
4585

    
4586
  def CheckPrereq(self):
4587
    """Check prerequisites.
4588

4589
    """
4590
    if (not self.cfg.GetVGName() and
4591
        self.op.disk_template not in constants.DTS_NOT_LVM):
4592
      raise errors.OpPrereqError("Cluster does not support lvm-based"
4593
                                 " instances")
4594

    
4595
    if self.op.mode == constants.INSTANCE_IMPORT:
4596
      src_node = self.op.src_node
4597
      src_path = self.op.src_path
4598

    
4599
      if src_node is None:
4600
        exp_list = self.rpc.call_export_list(
4601
          self.acquired_locks[locking.LEVEL_NODE])
4602
        found = False
4603
        for node in exp_list:
4604
          if not exp_list[node].failed and src_path in exp_list[node].data:
4605
            found = True
4606
            self.op.src_node = src_node = node
4607
            self.op.src_path = src_path = os.path.join(constants.EXPORT_DIR,
4608
                                                       src_path)
4609
            break
4610
        if not found:
4611
          raise errors.OpPrereqError("No export found for relative path %s" %
4612
                                      src_path)
4613

    
4614
      _CheckNodeOnline(self, src_node)
4615
      result = self.rpc.call_export_info(src_node, src_path)
4616
      result.Raise()
4617
      if not result.data:
4618
        raise errors.OpPrereqError("No export found in dir %s" % src_path)
4619

    
4620
      export_info = result.data
4621
      if not export_info.has_section(constants.INISECT_EXP):
4622
        raise errors.ProgrammerError("Corrupted export config")
4623

    
4624
      ei_version = export_info.get(constants.INISECT_EXP, 'version')
4625
      if (int(ei_version) != constants.EXPORT_VERSION):
4626
        raise errors.OpPrereqError("Wrong export version %s (wanted %d)" %
4627
                                   (ei_version, constants.EXPORT_VERSION))
4628

    
4629
      # Check that the new instance doesn't have less disks than the export
4630
      instance_disks = len(self.disks)
4631
      export_disks = export_info.getint(constants.INISECT_INS, 'disk_count')
4632
      if instance_disks < export_disks:
4633
        raise errors.OpPrereqError("Not enough disks to import."
4634
                                   " (instance: %d, export: %d)" %
4635
                                   (instance_disks, export_disks))
4636

    
4637
      self.op.os_type = export_info.get(constants.INISECT_EXP, 'os')
4638
      disk_images = []
4639
      for idx in range(export_disks):
4640
        option = 'disk%d_dump' % idx
4641
        if export_info.has_option(constants.INISECT_INS, option):
4642
          # FIXME: are the old os-es, disk sizes, etc. useful?
4643
          export_name = export_info.get(constants.INISECT_INS, option)
4644
          image = os.path.join(src_path, export_name)
4645
          disk_images.append(image)
4646
        else:
4647
          disk_images.append(False)
4648

    
4649
      self.src_images = disk_images
4650

    
4651
      old_name = export_info.get(constants.INISECT_INS, 'name')
4652
      # FIXME: int() here could throw a ValueError on broken exports
4653
      exp_nic_count = int(export_info.get(constants.INISECT_INS, 'nic_count'))
4654
      if self.op.instance_name == old_name:
4655
        for idx, nic in enumerate(self.nics):
4656
          if nic.mac == constants.VALUE_AUTO and exp_nic_count >= idx:
4657
            nic_mac_ini = 'nic%d_mac' % idx
4658
            nic.mac = export_info.get(constants.INISECT_INS, nic_mac_ini)
4659

    
4660
    # ENDIF: self.op.mode == constants.INSTANCE_IMPORT
4661
    # ip ping checks (we use the same ip that was resolved in ExpandNames)
4662
    if self.op.start and not self.op.ip_check:
4663
      raise errors.OpPrereqError("Cannot ignore IP address conflicts when"
4664
                                 " adding an instance in start mode")
4665

    
4666
    if self.op.ip_check:
4667
      if utils.TcpPing(self.check_ip, constants.DEFAULT_NODED_PORT):
4668
        raise errors.OpPrereqError("IP %s of instance %s already in use" %
4669
                                   (self.check_ip, self.op.instance_name))
4670

    
4671
    #### mac address generation
4672
    # By generating here the mac address both the allocator and the hooks get
4673
    # the real final mac address rather than the 'auto' or 'generate' value.
4674
    # There is a race condition between the generation and the instance object
4675
    # creation, which means that we know the mac is valid now, but we're not
4676
    # sure it will be when we actually add the instance. If things go bad
4677
    # adding the instance will abort because of a duplicate mac, and the
4678
    # creation job will fail.
4679
    for nic in self.nics:
4680
      if nic.mac in (constants.VALUE_AUTO, constants.VALUE_GENERATE):
4681
        nic.mac = self.cfg.GenerateMAC()
4682

    
4683
    #### allocator run
4684

    
4685
    if self.op.iallocator is not None:
4686
      self._RunAllocator()
4687

    
4688
    #### node related checks
4689

    
4690
    # check primary node
4691
    self.pnode = pnode = self.cfg.GetNodeInfo(self.op.pnode)
4692
    assert self.pnode is not None, \
4693
      "Cannot retrieve locked node %s" % self.op.pnode
4694
    if pnode.offline:
4695
      raise errors.OpPrereqError("Cannot use offline primary node '%s'" %
4696
                                 pnode.name)
4697
    if pnode.drained:
4698
      raise errors.OpPrereqError("Cannot use drained primary node '%s'" %
4699
                                 pnode.name)
4700

    
4701
    self.secondaries = []
4702

    
4703
    # mirror node verification
4704
    if self.op.disk_template in constants.DTS_NET_MIRROR:
4705
      if self.op.snode is None:
4706
        raise errors.OpPrereqError("The networked disk templates need"
4707
                                   " a mirror node")
4708
      if self.op.snode == pnode.name:
4709
        raise errors.OpPrereqError("The secondary node cannot be"
4710
                                   " the primary node.")
4711
      _CheckNodeOnline(self, self.op.snode)
4712
      _CheckNodeNotDrained(self, self.op.snode)
4713
      self.secondaries.append(self.op.snode)
4714

    
4715
    nodenames = [pnode.name] + self.secondaries
4716

    
4717
    req_size = _ComputeDiskSize(self.op.disk_template,
4718
                                self.disks)
4719

    
4720
    # Check lv size requirements
4721
    if req_size is not None:
4722
      nodeinfo = self.rpc.call_node_info(nodenames, self.cfg.GetVGName(),
4723
                                         self.op.hypervisor)
4724
      for node in nodenames:
4725
        info = nodeinfo[node]
4726
        info.Raise()
4727
        info = info.data
4728
        if not info:
4729
          raise errors.OpPrereqError("Cannot get current information"
4730
                                     " from node '%s'" % node)
4731
        vg_free = info.get('vg_free', None)
4732
        if not isinstance(vg_free, int):
4733
          raise errors.OpPrereqError("Can't compute free disk space on"
4734
                                     " node %s" % node)
4735
        if req_size > info['vg_free']:
4736
          raise errors.OpPrereqError("Not enough disk space on target node %s."
4737
                                     " %d MB available, %d MB required" %
4738
                                     (node, info['vg_free'], req_size))
4739

    
4740
    _CheckHVParams(self, nodenames, self.op.hypervisor, self.op.hvparams)
4741

    
4742
    # os verification
4743
    result = self.rpc.call_os_get(pnode.name, self.op.os_type)
4744
    result.Raise()
4745
    if not isinstance(result.data, objects.OS) or not result.data:
4746
      raise errors.OpPrereqError("OS '%s' not in supported os list for"
4747
                                 " primary node"  % self.op.os_type)
4748

    
4749
    # bridge check on primary node
4750
    bridges = [n.bridge for n in self.nics]
4751
    result = self.rpc.call_bridges_exist(self.pnode.name, bridges)
4752
    result.Raise()
4753
    if not result.data:
4754
      raise errors.OpPrereqError("One of the target bridges '%s' does not"
4755
                                 " exist on destination node '%s'" %
4756
                                 (",".join(bridges), pnode.name))
4757

    
4758
    # memory check on primary node
4759
    if self.op.start:
4760
      _CheckNodeFreeMemory(self, self.pnode.name,
4761
                           "creating instance %s" % self.op.instance_name,
4762
                           self.be_full[constants.BE_MEMORY],
4763
                           self.op.hypervisor)
4764

    
4765
  def Exec(self, feedback_fn):
4766
    """Create and add the instance to the cluster.
4767

4768
    """
4769
    instance = self.op.instance_name
4770
    pnode_name = self.pnode.name
4771

    
4772
    ht_kind = self.op.hypervisor
4773
    if ht_kind in constants.HTS_REQ_PORT:
4774
      network_port = self.cfg.AllocatePort()
4775
    else:
4776
      network_port = None
4777

    
4778
    ##if self.op.vnc_bind_address is None:
4779
    ##  self.op.vnc_bind_address = constants.VNC_DEFAULT_BIND_ADDRESS
4780

    
4781
    # this is needed because os.path.join does not accept None arguments
4782
    if self.op.file_storage_dir is None:
4783
      string_file_storage_dir = ""
4784
    else:
4785
      string_file_storage_dir = self.op.file_storage_dir
4786

    
4787
    # build the full file storage dir path
4788
    file_storage_dir = os.path.normpath(os.path.join(
4789
                                        self.cfg.GetFileStorageDir(),
4790
                                        string_file_storage_dir, instance))
4791

    
4792

    
4793
    disks = _GenerateDiskTemplate(self,
4794
                                  self.op.disk_template,
4795
                                  instance, pnode_name,
4796
                                  self.secondaries,
4797
                                  self.disks,
4798
                                  file_storage_dir,
4799
                                  self.op.file_driver,
4800
                                  0)
4801

    
4802
    iobj = objects.Instance(name=instance, os=self.op.os_type,
4803
                            primary_node=pnode_name,
4804
                            nics=self.nics, disks=disks,
4805
                            disk_template=self.op.disk_template,
4806
                            admin_up=False,
4807
                            network_port=network_port,
4808
                            beparams=self.op.beparams,
4809
                            hvparams=self.op.hvparams,
4810
                            hypervisor=self.op.hypervisor,
4811
                            )
4812

    
4813
    feedback_fn("* creating instance disks...")
4814
    try:
4815
      _CreateDisks(self, iobj)
4816
    except errors.OpExecError:
4817
      self.LogWarning("Device creation failed, reverting...")
4818
      try:
4819
        _RemoveDisks(self, iobj)
4820
      finally:
4821
        self.cfg.ReleaseDRBDMinors(instance)
4822
        raise
4823

    
4824
    feedback_fn("adding instance %s to cluster config" % instance)
4825

    
4826
    self.cfg.AddInstance(iobj)
4827
    # Declare that we don't want to remove the instance lock anymore, as we've
4828
    # added the instance to the config
4829
    del self.remove_locks[locking.LEVEL_INSTANCE]
4830
    # Unlock all the nodes
4831
    if self.op.mode == constants.INSTANCE_IMPORT:
4832
      nodes_keep = [self.op.src_node]
4833
      nodes_release = [node for node in self.acquired_locks[locking.LEVEL_NODE]
4834
                       if node != self.op.src_node]
4835
      self.context.glm.release(locking.LEVEL_NODE, nodes_release)
4836
      self.acquired_locks[locking.LEVEL_NODE] = nodes_keep
4837
    else:
4838
      self.context.glm.release(locking.LEVEL_NODE)
4839
      del self.acquired_locks[locking.LEVEL_NODE]
4840

    
4841
    if self.op.wait_for_sync:
4842
      disk_abort = not _WaitForSync(self, iobj)
4843
    elif iobj.disk_template in constants.DTS_NET_MIRROR:
4844
      # make sure the disks are not degraded (still sync-ing is ok)
4845
      time.sleep(15)
4846
      feedback_fn("* checking mirrors status")
4847
      disk_abort = not _WaitForSync(self, iobj, oneshot=True)
4848
    else:
4849
      disk_abort = False
4850

    
4851
    if disk_abort:
4852
      _RemoveDisks(self, iobj)
4853
      self.cfg.RemoveInstance(iobj.name)
4854
      # Make sure the instance lock gets removed
4855
      self.remove_locks[locking.LEVEL_INSTANCE] = iobj.name
4856
      raise errors.OpExecError("There are some degraded disks for"
4857
                               " this instance")
4858

    
4859
    feedback_fn("creating os for instance %s on node %s" %
4860
                (instance, pnode_name))
4861

    
4862
    if iobj.disk_template != constants.DT_DISKLESS:
4863
      if self.op.mode == constants.INSTANCE_CREATE:
4864
        feedback_fn("* running the instance OS create scripts...")
4865
        result = self.rpc.call_instance_os_add(pnode_name, iobj)
4866
        msg = result.RemoteFailMsg()
4867
        if msg:
4868
          raise errors.OpExecError("Could not add os for instance %s"
4869
                                   " on node %s: %s" %
4870
                                   (instance, pnode_name, msg))
4871

    
4872
      elif self.op.mode == constants.INSTANCE_IMPORT:
4873
        feedback_fn("* running the instance OS import scripts...")
4874
        src_node = self.op.src_node
4875
        src_images = self.src_images
4876
        cluster_name = self.cfg.GetClusterName()
4877
        import_result = self.rpc.call_instance_os_import(pnode_name, iobj,
4878
                                                         src_node, src_images,
4879
                                                         cluster_name)
4880
        import_result.Raise()
4881
        for idx, result in enumerate(import_result.data):
4882
          if not result:
4883
            self.LogWarning("Could not import the image %s for instance"
4884
                            " %s, disk %d, on node %s" %
4885
                            (src_images[idx], instance, idx, pnode_name))
4886
      else:
4887
        # also checked in the prereq part
4888
        raise errors.ProgrammerError("Unknown OS initialization mode '%s'"
4889
                                     % self.op.mode)
4890

    
4891
    if self.op.start:
4892
      iobj.admin_up = True
4893
      self.cfg.Update(iobj)
4894
      logging.info("Starting instance %s on node %s", instance, pnode_name)
4895
      feedback_fn("* starting instance...")
4896
      result = self.rpc.call_instance_start(pnode_name, iobj, None, None)
4897
      msg = result.RemoteFailMsg()
4898
      if msg:
4899
        raise errors.OpExecError("Could not start instance: %s" % msg)
4900

    
4901

    
4902
class LUConnectConsole(NoHooksLU):
4903
  """Connect to an instance's console.
4904

4905
  This is somewhat special in that it returns the command line that
4906
  you need to run on the master node in order to connect to the
4907
  console.
4908

4909
  """
4910
  _OP_REQP = ["instance_name"]
4911
  REQ_BGL = False
4912

    
4913
  def ExpandNames(self):
4914
    self._ExpandAndLockInstance()
4915

    
4916
  def CheckPrereq(self):
4917
    """Check prerequisites.
4918

4919
    This checks that the instance is in the cluster.
4920

4921
    """
4922
    self.instance = self.cfg.GetInstanceInfo(self.op.instance_name)
4923
    assert self.instance is not None, \
4924
      "Cannot retrieve locked instance %s" % self.op.instance_name
4925
    _CheckNodeOnline(self, self.instance.primary_node)
4926

    
4927
  def Exec(self, feedback_fn):
4928
    """Connect to the console of an instance
4929

4930
    """
4931
    instance = self.instance
4932
    node = instance.primary_node
4933

    
4934
    node_insts = self.rpc.call_instance_list([node],
4935
                                             [instance.hypervisor])[node]
4936
    node_insts.Raise()
4937

    
4938
    if instance.name not in node_insts.data:
4939
      raise errors.OpExecError("Instance %s is not running." % instance.name)
4940

    
4941
    logging.debug("Connecting to console of %s on %s", instance.name, node)
4942

    
4943
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
4944
    cluster = self.cfg.GetClusterInfo()
4945
    # beparams and hvparams are passed separately, to avoid editing the
4946
    # instance and then saving the defaults in the instance itself.
4947
    hvparams = cluster.FillHV(instance)
4948
    beparams = cluster.FillBE(instance)
4949
    console_cmd = hyper.GetShellCommandForConsole(instance, hvparams, beparams)
4950

    
4951
    # build ssh cmdline
4952
    return self.ssh.BuildCmd(node, "root", console_cmd, batch=True, tty=True)
4953

    
4954

    
4955
class LUReplaceDisks(LogicalUnit):
4956
  """Replace the disks of an instance.
4957

4958
  """
4959
  HPATH = "mirrors-replace"
4960
  HTYPE = constants.HTYPE_INSTANCE
4961
  _OP_REQP = ["instance_name", "mode", "disks"]
4962
  REQ_BGL = False
4963

    
4964
  def CheckArguments(self):
4965
    if not hasattr(self.op, "remote_node"):
4966
      self.op.remote_node = None
4967
    if not hasattr(self.op, "iallocator"):
4968
      self.op.iallocator = None
4969

    
4970
    # check for valid parameter combination
4971
    cnt = [self.op.remote_node, self.op.iallocator].count(None)
4972
    if self.op.mode == constants.REPLACE_DISK_CHG:
4973
      if cnt == 2:
4974
        raise errors.OpPrereqError("When changing the secondary either an"
4975
                                   " iallocator script must be used or the"
4976
                                   " new node given")
4977
      elif cnt == 0:
4978
        raise errors.OpPrereqError("Give either the iallocator or the new"
4979
                                   " secondary, not both")
4980
    else: # not replacing the secondary
4981
      if cnt != 2:
4982
        raise errors.OpPrereqError("The iallocator and new node options can"
4983
                                   " be used only when changing the"
4984
                                   " secondary node")
4985

    
4986
  def ExpandNames(self):
4987
    self._ExpandAndLockInstance()
4988

    
4989
    if self.op.iallocator is not None:
4990
      self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
4991
    elif self.op.remote_node is not None:
4992
      remote_node = self.cfg.ExpandNodeName(self.op.remote_node)
4993
      if remote_node is None:
4994
        raise errors.OpPrereqError("Node '%s' not known" %
4995
                                   self.op.remote_node)
4996
      self.op.remote_node = remote_node
4997
      # Warning: do not remove the locking of the new secondary here
4998
      # unless DRBD8.AddChildren is changed to work in parallel;
4999
      # currently it doesn't since parallel invocations of
5000
      # FindUnusedMinor will conflict
5001
      self.needed_locks[locking.LEVEL_NODE] = [remote_node]
5002
      self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_APPEND
5003
    else:
5004
      self.needed_locks[locking.LEVEL_NODE] = []
5005
      self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
5006

    
5007
  def DeclareLocks(self, level):
5008
    # If we're not already locking all nodes in the set we have to declare the
5009
    # instance's primary/secondary nodes.
5010
    if (level == locking.LEVEL_NODE and
5011
        self.needed_locks[locking.LEVEL_NODE] is not locking.ALL_SET):
5012
      self._LockInstancesNodes()
5013

    
5014
  def _RunAllocator(self):
5015
    """Compute a new secondary node using an IAllocator.
5016

5017
    """
5018
    ial = IAllocator(self,
5019
                     mode=constants.IALLOCATOR_MODE_RELOC,
5020
                     name=self.op.instance_name,
5021
                     relocate_from=[self.sec_node])
5022

    
5023
    ial.Run(self.op.iallocator)
5024

    
5025
    if not ial.success:
5026
      raise errors.OpPrereqError("Can't compute nodes using"
5027
                                 " iallocator '%s': %s" % (self.op.iallocator,
5028
                                                           ial.info))
5029
    if len(ial.nodes) != ial.required_nodes:
5030
      raise errors.OpPrereqError("iallocator '%s' returned invalid number"
5031
                                 " of nodes (%s), required %s" %
5032
                                 (len(ial.nodes), ial.required_nodes))
5033
    self.op.remote_node = ial.nodes[0]
5034
    self.LogInfo("Selected new secondary for the instance: %s",
5035
                 self.op.remote_node)
5036

    
5037
  def BuildHooksEnv(self):
5038
    """Build hooks env.
5039

5040
    This runs on the master, the primary and all the secondaries.
5041

5042
    """
5043
    env = {
5044
      "MODE": self.op.mode,
5045
      "NEW_SECONDARY": self.op.remote_node,
5046
      "OLD_SECONDARY": self.instance.secondary_nodes[0],
5047
      }
5048
    env.update(_BuildInstanceHookEnvByObject(self, self.instance))
5049
    nl = [
5050
      self.cfg.GetMasterNode(),
5051
      self.instance.primary_node,
5052
      ]
5053
    if self.op.remote_node is not None:
5054
      nl.append(self.op.remote_node)
5055
    return env, nl, nl
5056

    
5057
  def CheckPrereq(self):
5058
    """Check prerequisites.
5059

5060
    This checks that the instance is in the cluster.
5061

5062
    """
5063
    instance = self.cfg.GetInstanceInfo(self.op.instance_name)
5064
    assert instance is not None, \
5065
      "Cannot retrieve locked instance %s" % self.op.instance_name
5066
    self.instance = instance
5067

    
5068
    if instance.disk_template != constants.DT_DRBD8:
5069
      raise errors.OpPrereqError("Can only run replace disks for DRBD8-based"
5070
                                 " instances")
5071

    
5072
    if len(instance.secondary_nodes) != 1:
5073
      raise errors.OpPrereqError("The instance has a strange layout,"
5074
                                 " expected one secondary but found %d" %
5075
                                 len(instance.secondary_nodes))
5076

    
5077
    self.sec_node = instance.secondary_nodes[0]
5078

    
5079
    if self.op.iallocator is not None:
5080
      self._RunAllocator()
5081

    
5082
    remote_node = self.op.remote_node
5083
    if remote_node is not None:
5084
      self.remote_node_info = self.cfg.GetNodeInfo(remote_node)
5085
      assert self.remote_node_info is not None, \
5086
        "Cannot retrieve locked node %s" % remote_node
5087
    else:
5088
      self.remote_node_info = None
5089
    if remote_node == instance.primary_node:
5090
      raise errors.OpPrereqError("The specified node is the primary node of"
5091
                                 " the instance.")
5092
    elif remote_node == self.sec_node:
5093
      raise errors.OpPrereqError("The specified node is already the"
5094
                                 " secondary node of the instance.")
5095

    
5096
    if self.op.mode == constants.REPLACE_DISK_PRI:
5097
      n1 = self.tgt_node = instance.primary_node
5098
      n2 = self.oth_node = self.sec_node
5099
    elif self.op.mode == constants.REPLACE_DISK_SEC:
5100
      n1 = self.tgt_node = self.sec_node
5101
      n2 = self.oth_node = instance.primary_node
5102
    elif self.op.mode == constants.REPLACE_DISK_CHG:
5103
      n1 = self.new_node = remote_node
5104
      n2 = self.oth_node = instance.primary_node
5105
      self.tgt_node = self.sec_node
5106
      _CheckNodeNotDrained(self, remote_node)
5107
    else:
5108
      raise errors.ProgrammerError("Unhandled disk replace mode")
5109

    
5110
    _CheckNodeOnline(self, n1)
5111
    _CheckNodeOnline(self, n2)
5112

    
5113
    if not self.op.disks:
5114
      self.op.disks = range(len(instance.disks))
5115

    
5116
    for disk_idx in self.op.disks:
5117
      instance.FindDisk(disk_idx)
5118

    
5119
  def _ExecD8DiskOnly(self, feedback_fn):
5120
    """Replace a disk on the primary or secondary for dbrd8.
5121

5122
    The algorithm for replace is quite complicated:
5123

5124
      1. for each disk to be replaced:
5125

5126
        1. create new LVs on the target node with unique names
5127
        1. detach old LVs from the drbd device
5128
        1. rename old LVs to name_replaced.<time_t>
5129
        1. rename new LVs to old LVs
5130
        1. attach the new LVs (with the old names now) to the drbd device
5131

5132
      1. wait for sync across all devices
5133

5134
      1. for each modified disk:
5135

5136
        1. remove old LVs (which have the name name_replaces.<time_t>)
5137

5138
    Failures are not very well handled.
5139

5140
    """
5141
    steps_total = 6
5142
    warning, info = (self.proc.LogWarning, self.proc.LogInfo)
5143
    instance = self.instance
5144
    iv_names = {}
5145
    vgname = self.cfg.GetVGName()
5146
    # start of work
5147
    cfg = self.cfg
5148
    tgt_node = self.tgt_node
5149
    oth_node = self.oth_node
5150

    
5151
    # Step: check device activation
5152
    self.proc.LogStep(1, steps_total, "check device existence")
5153
    info("checking volume groups")
5154
    my_vg = cfg.GetVGName()
5155
    results = self.rpc.call_vg_list([oth_node, tgt_node])
5156
    if not results:
5157
      raise errors.OpExecError("Can't list volume groups on the nodes")
5158
    for node in oth_node, tgt_node:
5159
      res = results[node]
5160
      if res.failed or not res.data or my_vg not in res.data:
5161
        raise errors.OpExecError("Volume group '%s' not found on %s" %
5162
                                 (my_vg, node))
5163
    for idx, dev in enumerate(instance.disks):
5164
      if idx not in self.op.disks:
5165
        continue
5166
      for node in tgt_node, oth_node:
5167
        info("checking disk/%d on %s" % (idx, node))
5168
        cfg.SetDiskID(dev, node)
5169
        result = self.rpc.call_blockdev_find(node, dev)
5170
        msg = result.RemoteFailMsg()
5171
        if not msg and not result.payload:
5172
          msg = "disk not found"
5173
        if msg:
5174
          raise errors.OpExecError("Can't find disk/%d on node %s: %s" %
5175
                                   (idx, node, msg))
5176

    
5177
    # Step: check other node consistency
5178
    self.proc.LogStep(2, steps_total, "check peer consistency")
5179
    for idx, dev in enumerate(instance.disks):
5180
      if idx not in self.op.disks:
5181
        continue
5182
      info("checking disk/%d consistency on %s" % (idx, oth_node))
5183
      if not _CheckDiskConsistency(self, dev, oth_node,
5184
                                   oth_node==instance.primary_node):
5185
        raise errors.OpExecError("Peer node (%s) has degraded storage, unsafe"
5186
                                 " to replace disks on this node (%s)" %
5187
                                 (oth_node, tgt_node))
5188

    
5189
    # Step: create new storage
5190
    self.proc.LogStep(3, steps_total, "allocate new storage")
5191
    for idx, dev in enumerate(instance.disks):
5192
      if idx not in self.op.disks:
5193
        continue
5194
      size = dev.size
5195
      cfg.SetDiskID(dev, tgt_node)
5196
      lv_names = [".disk%d_%s" % (idx, suf)
5197
                  for suf in ["data", "meta"]]
5198
      names = _GenerateUniqueNames(self, lv_names)
5199
      lv_data = objects.Disk(dev_type=constants.LD_LV, size=size,
5200
                             logical_id=(vgname, names[0]))
5201
      lv_meta = objects.Disk(dev_type=constants.LD_LV, size=128,
5202
                             logical_id=(vgname, names[1]))
5203
      new_lvs = [lv_data, lv_meta]
5204
      old_lvs = dev.children
5205
      iv_names[dev.iv_name] = (dev, old_lvs, new_lvs)
5206
      info("creating new local storage on %s for %s" %
5207
           (tgt_node, dev.iv_name))
5208
      # we pass force_create=True to force the LVM creation
5209
      for new_lv in new_lvs:
5210
        _CreateBlockDev(self, tgt_node, instance, new_lv, True,
5211
                        _GetInstanceInfoText(instance), False)
5212

    
5213
    # Step: for each lv, detach+rename*2+attach
5214
    self.proc.LogStep(4, steps_total, "change drbd configuration")
5215
    for dev, old_lvs, new_lvs in iv_names.itervalues():
5216
      info("detaching %s drbd from local storage" % dev.iv_name)
5217
      result = self.rpc.call_blockdev_removechildren(tgt_node, dev, old_lvs)
5218
      result.Raise()
5219
      if not result.data:
5220
        raise errors.OpExecError("Can't detach drbd from local storage on node"
5221
                                 " %s for device %s" % (tgt_node, dev.iv_name))
5222
      #dev.children = []
5223
      #cfg.Update(instance)
5224

    
5225
      # ok, we created the new LVs, so now we know we have the needed
5226
      # storage; as such, we proceed on the target node to rename
5227
      # old_lv to _old, and new_lv to old_lv; note that we rename LVs
5228
      # using the assumption that logical_id == physical_id (which in
5229
      # turn is the unique_id on that node)
5230

    
5231
      # FIXME(iustin): use a better name for the replaced LVs
5232
      temp_suffix = int(time.time())
5233
      ren_fn = lambda d, suff: (d.physical_id[0],
5234
                                d.physical_id[1] + "_replaced-%s" % suff)
5235
      # build the rename list based on what LVs exist on the node
5236
      rlist = []
5237
      for to_ren in old_lvs:
5238
        result = self.rpc.call_blockdev_find(tgt_node, to_ren)
5239
        if not result.RemoteFailMsg() and result.payload:
5240
          # device exists
5241
          rlist.append((to_ren, ren_fn(to_ren, temp_suffix)))
5242

    
5243
      info("renaming the old LVs on the target node")
5244
      result = self.rpc.call_blockdev_rename(tgt_node, rlist)
5245
      result.Raise()
5246
      if not result.data:
5247
        raise errors.OpExecError("Can't rename old LVs on node %s" % tgt_node)
5248
      # now we rename the new LVs to the old LVs
5249
      info("renaming the new LVs on the target node")
5250
      rlist = [(new, old.physical_id) for old, new in zip(old_lvs, new_lvs)]
5251
      result = self.rpc.call_blockdev_rename(tgt_node, rlist)
5252
      result.Raise()
5253
      if not result.data:
5254
        raise errors.OpExecError("Can't rename new LVs on node %s" % tgt_node)
5255

    
5256
      for old, new in zip(old_lvs, new_lvs):
5257
        new.logical_id = old.logical_id
5258
        cfg.SetDiskID(new, tgt_node)
5259

    
5260
      for disk in old_lvs:
5261
        disk.logical_id = ren_fn(disk, temp_suffix)
5262
        cfg.SetDiskID(disk, tgt_node)
5263

    
5264
      # now that the new lvs have the old name, we can add them to the device
5265
      info("adding new mirror component on %s" % tgt_node)
5266
      result = self.rpc.call_blockdev_addchildren(tgt_node, dev, new_lvs)
5267
      if result.failed or not result.data:
5268
        for new_lv in new_lvs:
5269
          msg = self.rpc.call_blockdev_remove(tgt_node, new_lv).RemoteFailMsg()
5270
          if msg:
5271
            warning("Can't rollback device %s: %s", dev, msg,
5272
                    hint="cleanup manually the unused logical volumes")
5273
        raise errors.OpExecError("Can't add local storage to drbd")
5274

    
5275
      dev.children = new_lvs
5276
      cfg.Update(instance)
5277

    
5278
    # Step: wait for sync
5279

    
5280
    # this can fail as the old devices are degraded and _WaitForSync
5281
    # does a combined result over all disks, so we don't check its
5282
    # return value
5283
    self.proc.LogStep(5, steps_total, "sync devices")
5284
    _WaitForSync(self, instance, unlock=True)
5285

    
5286
    # so check manually all the devices
5287
    for name, (dev, old_lvs, new_lvs) in iv_names.iteritems():
5288
      cfg.SetDiskID(dev, instance.primary_node)
5289
      result = self.rpc.call_blockdev_find(instance.primary_node, dev)
5290
      msg = result.RemoteFailMsg()
5291
      if not msg and not result.payload:
5292
        msg = "disk not found"
5293
      if msg:
5294
        raise errors.OpExecError("Can't find DRBD device %s: %s" %
5295
                                 (name, msg))
5296
      if result.payload[5]:
5297
        raise errors.OpExecError("DRBD device %s is degraded!" % name)
5298

    
5299
    # Step: remove old storage
5300
    self.proc.LogStep(6, steps_total, "removing old storage")
5301
    for name, (dev, old_lvs, new_lvs) in iv_names.iteritems():
5302
      info("remove logical volumes for %s" % name)
5303
      for lv in old_lvs:
5304
        cfg.SetDiskID(lv, tgt_node)
5305
        msg = self.rpc.call_blockdev_remove(tgt_node, lv).RemoteFailMsg()
5306
        if msg:
5307
          warning("Can't remove old LV: %s" % msg,
5308
                  hint="manually remove unused LVs")
5309
          continue
5310

    
5311
  def _ExecD8Secondary(self, feedback_fn):
5312
    """Replace the secondary node for drbd8.
5313

5314
    The algorithm for replace is quite complicated:
5315
      - for all disks of the instance:
5316
        - create new LVs on the new node with same names
5317
        - shutdown the drbd device on the old secondary
5318
        - disconnect the drbd network on the primary
5319
        - create the drbd device on the new secondary
5320
        - network attach the drbd on the primary, using an artifice:
5321
          the drbd code for Attach() will connect to the network if it
5322
          finds a device which is connected to the good local disks but
5323
          not network enabled
5324
      - wait for sync across all devices
5325
      - remove all disks from the old secondary
5326

5327
    Failures are not very well handled.
5328

5329
    """
5330
    steps_total = 6
5331
    warning, info = (self.proc.LogWarning, self.proc.LogInfo)
5332
    instance = self.instance
5333
    iv_names = {}
5334
    # start of work
5335
    cfg = self.cfg
5336
    old_node = self.tgt_node
5337
    new_node = self.new_node
5338
    pri_node = instance.primary_node
5339
    nodes_ip = {
5340
      old_node: self.cfg.GetNodeInfo(old_node).secondary_ip,
5341
      new_node: self.cfg.GetNodeInfo(new_node).secondary_ip,
5342
      pri_node: self.cfg.GetNodeInfo(pri_node).secondary_ip,
5343
      }
5344

    
5345
    # Step: check device activation
5346
    self.proc.LogStep(1, steps_total, "check device existence")
5347
    info("checking volume groups")
5348
    my_vg = cfg.GetVGName()
5349
    results = self.rpc.call_vg_list([pri_node, new_node])
5350
    for node in pri_node, new_node:
5351
      res = results[node]
5352
      if res.failed or not res.data or my_vg not in res.data:
5353
        raise errors.OpExecError("Volume group '%s' not found on %s" %
5354
                                 (my_vg, node))
5355
    for idx, dev in enumerate(instance.disks):
5356
      if idx not in self.op.disks:
5357
        continue
5358
      info("checking disk/%d on %s" % (idx, pri_node))
5359
      cfg.SetDiskID(dev, pri_node)
5360
      result = self.rpc.call_blockdev_find(pri_node, dev)
5361
      msg = result.RemoteFailMsg()
5362
      if not msg and not result.payload:
5363
        msg = "disk not found"
5364
      if msg:
5365
        raise errors.OpExecError("Can't find disk/%d on node %s: %s" %
5366
                                 (idx, pri_node, msg))
5367

    
5368
    # Step: check other node consistency
5369
    self.proc.LogStep(2, steps_total, "check peer consistency")
5370
    for idx, dev in enumerate(instance.disks):
5371
      if idx not in self.op.disks:
5372
        continue
5373
      info("checking disk/%d consistency on %s" % (idx, pri_node))
5374
      if not _CheckDiskConsistency(self, dev, pri_node, True, ldisk=True):
5375
        raise errors.OpExecError("Primary node (%s) has degraded storage,"
5376
                                 " unsafe to replace the secondary" %
5377
                                 pri_node)
5378

    
5379
    # Step: create new storage
5380
    self.proc.LogStep(3, steps_total, "allocate new storage")
5381
    for idx, dev in enumerate(instance.disks):
5382
      info("adding new local storage on %s for disk/%d" %
5383
           (new_node, idx))
5384
      # we pass force_create=True to force LVM creation
5385
      for new_lv in dev.children:
5386
        _CreateBlockDev(self, new_node, instance, new_lv, True,
5387
                        _GetInstanceInfoText(instance), False)
5388

    
5389
    # Step 4: dbrd minors and drbd setups changes
5390
    # after this, we must manually remove the drbd minors on both the
5391
    # error and the success paths
5392
    minors = cfg.AllocateDRBDMinor([new_node for dev in instance.disks],
5393
                                   instance.name)
5394
    logging.debug("Allocated minors %s" % (minors,))
5395
    self.proc.LogStep(4, steps_total, "changing drbd configuration")
5396
    for idx, (dev, new_minor) in enumerate(zip(instance.disks, minors)):
5397
      size = dev.size
5398
      info("activating a new drbd on %s for disk/%d" % (new_node, idx))
5399
      # create new devices on new_node; note that we create two IDs:
5400
      # one without port, so the drbd will be activated without
5401
      # networking information on the new node at this stage, and one
5402
      # with network, for the latter activation in step 4
5403
      (o_node1, o_node2, o_port, o_minor1, o_minor2, o_secret) = dev.logical_id
5404
      if pri_node == o_node1:
5405
        p_minor = o_minor1
5406
      else:
5407
        p_minor = o_minor2
5408

    
5409
      new_alone_id = (pri_node, new_node, None, p_minor, new_minor, o_secret)
5410
      new_net_id = (pri_node, new_node, o_port, p_minor, new_minor, o_secret)
5411

    
5412
      iv_names[idx] = (dev, dev.children, new_net_id)
5413
      logging.debug("Allocated new_minor: %s, new_logical_id: %s", new_minor,
5414
                    new_net_id)
5415
      new_drbd = objects.Disk(dev_type=constants.LD_DRBD8,
5416
                              logical_id=new_alone_id,
5417
                              children=dev.children,
5418
                              size=dev.size)
5419
      try:
5420
        _CreateSingleBlockDev(self, new_node, instance, new_drbd,
5421
                              _GetInstanceInfoText(instance), False)
5422
      except errors.GenericError:
5423
        self.cfg.ReleaseDRBDMinors(instance.name)
5424
        raise
5425

    
5426
    for idx, dev in enumerate(instance.disks):
5427
      # we have new devices, shutdown the drbd on the old secondary
5428
      info("shutting down drbd for disk/%d on old node" % idx)
5429
      cfg.SetDiskID(dev, old_node)
5430
      msg = self.rpc.call_blockdev_shutdown(old_node, dev).RemoteFailMsg()
5431
      if msg:
5432
        warning("Failed to shutdown drbd for disk/%d on old node: %s" %
5433
                (idx, msg),
5434
                hint="Please cleanup this device manually as soon as possible")
5435

    
5436
    info("detaching primary drbds from the network (=> standalone)")
5437
    result = self.rpc.call_drbd_disconnect_net([pri_node], nodes_ip,
5438
                                               instance.disks)[pri_node]
5439

    
5440
    msg = result.RemoteFailMsg()
5441
    if msg:
5442
      # detaches didn't succeed (unlikely)
5443
      self.cfg.ReleaseDRBDMinors(instance.name)
5444
      raise errors.OpExecError("Can't detach the disks from the network on"
5445
                               " old node: %s" % (msg,))
5446

    
5447
    # if we managed to detach at least one, we update all the disks of
5448
    # the instance to point to the new secondary
5449
    info("updating instance configuration")
5450
    for dev, _, new_logical_id in iv_names.itervalues():
5451
      dev.logical_id = new_logical_id
5452
      cfg.SetDiskID(dev, pri_node)
5453
    cfg.Update(instance)
5454

    
5455
    # and now perform the drbd attach
5456
    info("attaching primary drbds to new secondary (standalone => connected)")
5457
    result = self.rpc.call_drbd_attach_net([pri_node, new_node], nodes_ip,
5458
                                           instance.disks, instance.name,
5459
                                           False)
5460
    for to_node, to_result in result.items():
5461
      msg = to_result.RemoteFailMsg()
5462
      if msg:
5463
        warning("can't attach drbd disks on node %s: %s", to_node, msg,
5464
                hint="please do a gnt-instance info to see the"
5465
                " status of disks")
5466

    
5467
    # this can fail as the old devices are degraded and _WaitForSync
5468
    # does a combined result over all disks, so we don't check its
5469
    # return value
5470
    self.proc.LogStep(5, steps_total, "sync devices")
5471
    _WaitForSync(self, instance, unlock=True)
5472

    
5473
    # so check manually all the devices
5474
    for idx, (dev, old_lvs, _) in iv_names.iteritems():
5475
      cfg.SetDiskID(dev, pri_node)
5476
      result = self.rpc.call_blockdev_find(pri_node, dev)
5477
      msg = result.RemoteFailMsg()
5478
      if not msg and not result.payload:
5479
        msg = "disk not found"
5480
      if msg:
5481
        raise errors.OpExecError("Can't find DRBD device disk/%d: %s" %
5482
                                 (idx, msg))
5483
      if result.payload[5]:
5484
        raise errors.OpExecError("DRBD device disk/%d is degraded!" % idx)
5485

    
5486
    self.proc.LogStep(6, steps_total, "removing old storage")
5487
    for idx, (dev, old_lvs, _) in iv_names.iteritems():
5488
      info("remove logical volumes for disk/%d" % idx)
5489
      for lv in old_lvs:
5490
        cfg.SetDiskID(lv, old_node)
5491
        msg = self.rpc.call_blockdev_remove(old_node, lv).RemoteFailMsg()
5492
        if msg:
5493
          warning("Can't remove LV on old secondary: %s", msg,
5494
                  hint="Cleanup stale volumes by hand")
5495

    
5496
  def Exec(self, feedback_fn):
5497
    """Execute disk replacement.
5498

5499
    This dispatches the disk replacement to the appropriate handler.
5500

5501
    """
5502
    instance = self.instance
5503

    
5504
    # Activate the instance disks if we're replacing them on a down instance
5505
    if not instance.admin_up:
5506
      _StartInstanceDisks(self, instance, True)
5507

    
5508
    if self.op.mode == constants.REPLACE_DISK_CHG:
5509
      fn = self._ExecD8Secondary
5510
    else:
5511
      fn = self._ExecD8DiskOnly
5512

    
5513
    ret = fn(feedback_fn)
5514

    
5515
    # Deactivate the instance disks if we're replacing them on a down instance
5516
    if not instance.admin_up:
5517
      _SafeShutdownInstanceDisks(self, instance)
5518

    
5519
    return ret
5520

    
5521

    
5522
class LUGrowDisk(LogicalUnit):
5523
  """Grow a disk of an instance.
5524

5525
  """
5526
  HPATH = "disk-grow"
5527
  HTYPE = constants.HTYPE_INSTANCE
5528
  _OP_REQP = ["instance_name", "disk", "amount", "wait_for_sync"]
5529
  REQ_BGL = False
5530

    
5531
  def ExpandNames(self):
5532
    self._ExpandAndLockInstance()
5533
    self.needed_locks[locking.LEVEL_NODE] = []
5534
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
5535

    
5536
  def DeclareLocks(self, level):
5537
    if level == locking.LEVEL_NODE:
5538
      self._LockInstancesNodes()
5539

    
5540
  def BuildHooksEnv(self):
5541
    """Build hooks env.
5542

5543
    This runs on the master, the primary and all the secondaries.
5544

5545
    """
5546
    env = {
5547
      "DISK": self.op.disk,
5548
      "AMOUNT": self.op.amount,
5549
      }
5550
    env.update(_BuildInstanceHookEnvByObject(self, self.instance))
5551
    nl = [
5552
      self.cfg.GetMasterNode(),
5553
      self.instance.primary_node,
5554
      ]
5555
    return env, nl, nl
5556

    
5557
  def CheckPrereq(self):
5558
    """Check prerequisites.
5559

5560
    This checks that the instance is in the cluster.
5561

5562
    """
5563
    instance = self.cfg.GetInstanceInfo(self.op.instance_name)
5564
    assert instance is not None, \
5565
      "Cannot retrieve locked instance %s" % self.op.instance_name
5566
    nodenames = list(instance.all_nodes)
5567
    for node in nodenames:
5568
      _CheckNodeOnline(self, node)
5569

    
5570

    
5571
    self.instance = instance
5572

    
5573
    if instance.disk_template not in (constants.DT_PLAIN, constants.DT_DRBD8):
5574
      raise errors.OpPrereqError("Instance's disk layout does not support"
5575
                                 " growing.")
5576

    
5577
    self.disk = instance.FindDisk(self.op.disk)
5578

    
5579
    nodeinfo = self.rpc.call_node_info(nodenames, self.cfg.GetVGName(),
5580
                                       instance.hypervisor)
5581
    for node in nodenames:
5582
      info = nodeinfo[node]
5583
      if info.failed or not info.data:
5584
        raise errors.OpPrereqError("Cannot get current information"
5585
                                   " from node '%s'" % node)
5586
      vg_free = info.data.get('vg_free', None)
5587
      if not isinstance(vg_free, int):
5588
        raise errors.OpPrereqError("Can't compute free disk space on"
5589
                                   " node %s" % node)
5590
      if self.op.amount > vg_free:
5591
        raise errors.OpPrereqError("Not enough disk space on target node %s:"
5592
                                   " %d MiB available, %d MiB required" %
5593
                                   (node, vg_free, self.op.amount))
5594

    
5595
  def Exec(self, feedback_fn):
5596
    """Execute disk grow.
5597

5598
    """
5599
    instance = self.instance
5600
    disk = self.disk
5601
    for node in instance.all_nodes:
5602
      self.cfg.SetDiskID(disk, node)
5603
      result = self.rpc.call_blockdev_grow(node, disk, self.op.amount)
5604
      msg = result.RemoteFailMsg()
5605
      if msg:
5606
        raise errors.OpExecError("Grow request failed to node %s: %s" %
5607
                                 (node, msg))
5608
    disk.RecordGrow(self.op.amount)
5609
    self.cfg.Update(instance)
5610
    if self.op.wait_for_sync:
5611
      disk_abort = not _WaitForSync(self, instance)
5612
      if disk_abort:
5613
        self.proc.LogWarning("Warning: disk sync-ing has not returned a good"
5614
                             " status.\nPlease check the instance.")
5615

    
5616

    
5617
class LUQueryInstanceData(NoHooksLU):
5618
  """Query runtime instance data.
5619

5620
  """
5621
  _OP_REQP = ["instances", "static"]
5622
  REQ_BGL = False
5623

    
5624
  def ExpandNames(self):
5625
    self.needed_locks = {}
5626
    self.share_locks = dict(((i, 1) for i in locking.LEVELS))
5627

    
5628
    if not isinstance(self.op.instances, list):
5629
      raise errors.OpPrereqError("Invalid argument type 'instances'")
5630

    
5631
    if self.op.instances:
5632
      self.wanted_names = []
5633
      for name in self.op.instances:
5634
        full_name = self.cfg.ExpandInstanceName(name)
5635
        if full_name is None:
5636
          raise errors.OpPrereqError("Instance '%s' not known" % name)
5637
        self.wanted_names.append(full_name)
5638
      self.needed_locks[locking.LEVEL_INSTANCE] = self.wanted_names
5639
    else:
5640
      self.wanted_names = None
5641
      self.needed_locks[locking.LEVEL_INSTANCE] = locking.ALL_SET
5642

    
5643
    self.needed_locks[locking.LEVEL_NODE] = []
5644
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
5645

    
5646
  def DeclareLocks(self, level):
5647
    if level == locking.LEVEL_NODE:
5648
      self._LockInstancesNodes()
5649

    
5650
  def CheckPrereq(self):
5651
    """Check prerequisites.
5652

5653
    This only checks the optional instance list against the existing names.
5654

5655
    """
5656
    if self.wanted_names is None:
5657
      self.wanted_names = self.acquired_locks[locking.LEVEL_INSTANCE]
5658

    
5659
    self.wanted_instances = [self.cfg.GetInstanceInfo(name) for name
5660
                             in self.wanted_names]
5661
    return
5662

    
5663
  def _ComputeDiskStatus(self, instance, snode, dev):
5664
    """Compute block device status.
5665

5666
    """
5667
    static = self.op.static
5668
    if not static:
5669
      self.cfg.SetDiskID(dev, instance.primary_node)
5670
      dev_pstatus = self.rpc.call_blockdev_find(instance.primary_node, dev)
5671
      if dev_pstatus.offline:
5672
        dev_pstatus = None
5673
      else:
5674
        msg = dev_pstatus.RemoteFailMsg()
5675
        if msg:
5676
          raise errors.OpExecError("Can't compute disk status for %s: %s" %
5677
                                   (instance.name, msg))
5678
        dev_pstatus = dev_pstatus.payload
5679
    else:
5680
      dev_pstatus = None
5681

    
5682
    if dev.dev_type in constants.LDS_DRBD:
5683
      # we change the snode then (otherwise we use the one passed in)
5684
      if dev.logical_id[0] == instance.primary_node:
5685
        snode = dev.logical_id[1]
5686
      else:
5687
        snode = dev.logical_id[0]
5688

    
5689
    if snode and not static:
5690
      self.cfg.SetDiskID(dev, snode)
5691
      dev_sstatus = self.rpc.call_blockdev_find(snode, dev)
5692
      if dev_sstatus.offline:
5693
        dev_sstatus = None
5694
      else:
5695
        msg = dev_sstatus.RemoteFailMsg()
5696
        if msg:
5697
          raise errors.OpExecError("Can't compute disk status for %s: %s" %
5698
                                   (instance.name, msg))
5699
        dev_sstatus = dev_sstatus.payload
5700
    else:
5701
      dev_sstatus = None
5702

    
5703
    if dev.children:
5704
      dev_children = [self._ComputeDiskStatus(instance, snode, child)
5705
                      for child in dev.children]
5706
    else:
5707
      dev_children = []
5708

    
5709
    data = {
5710
      "iv_name": dev.iv_name,
5711
      "dev_type": dev.dev_type,
5712
      "logical_id": dev.logical_id,
5713
      "physical_id": dev.physical_id,
5714
      "pstatus": dev_pstatus,
5715
      "sstatus": dev_sstatus,
5716
      "children": dev_children,
5717
      "mode": dev.mode,
5718
      "size": dev.size,
5719
      }
5720

    
5721
    return data
5722

    
5723
  def Exec(self, feedback_fn):
5724
    """Gather and return data"""
5725
    result = {}
5726

    
5727
    cluster = self.cfg.GetClusterInfo()
5728

    
5729
    for instance in self.wanted_instances:
5730
      if not self.op.static:
5731
        remote_info = self.rpc.call_instance_info(instance.primary_node,
5732
                                                  instance.name,
5733
                                                  instance.hypervisor)
5734
        remote_info.Raise()
5735
        remote_info = remote_info.data
5736
        if remote_info and "state" in remote_info:
5737
          remote_state = "up"
5738
        else:
5739
          remote_state = "down"
5740
      else:
5741
        remote_state = None
5742
      if instance.admin_up:
5743
        config_state = "up"
5744
      else:
5745
        config_state = "down"
5746

    
5747
      disks = [self._ComputeDiskStatus(instance, None, device)
5748
               for device in instance.disks]
5749

    
5750
      idict = {
5751
        "name": instance.name,
5752
        "config_state": config_state,
5753
        "run_state": remote_state,
5754
        "pnode": instance.primary_node,
5755
        "snodes": instance.secondary_nodes,
5756
        "os": instance.os,
5757
        "nics": [(nic.mac, nic.ip, nic.bridge) for nic in instance.nics],
5758
        "disks": disks,
5759
        "hypervisor": instance.hypervisor,
5760
        "network_port": instance.network_port,
5761
        "hv_instance": instance.hvparams,
5762
        "hv_actual": cluster.FillHV(instance),
5763
        "be_instance": instance.beparams,
5764
        "be_actual": cluster.FillBE(instance),
5765
        }
5766

    
5767
      result[instance.name] = idict
5768

    
5769
    return result
5770

    
5771

    
5772
class LUSetInstanceParams(LogicalUnit):
5773
  """Modifies an instances's parameters.
5774

5775
  """
5776
  HPATH = "instance-modify"
5777
  HTYPE = constants.HTYPE_INSTANCE
5778
  _OP_REQP = ["instance_name"]
5779
  REQ_BGL = False
5780

    
5781
  def CheckArguments(self):
5782
    if not hasattr(self.op, 'nics'):
5783
      self.op.nics = []
5784
    if not hasattr(self.op, 'disks'):
5785
      self.op.disks = []
5786
    if not hasattr(self.op, 'beparams'):
5787
      self.op.beparams = {}
5788
    if not hasattr(self.op, 'hvparams'):
5789
      self.op.hvparams = {}
5790
    self.op.force = getattr(self.op, "force", False)
5791
    if not (self.op.nics or self.op.disks or
5792
            self.op.hvparams or self.op.beparams):
5793
      raise errors.OpPrereqError("No changes submitted")
5794

    
5795
    # Disk validation
5796
    disk_addremove = 0
5797
    for disk_op, disk_dict in self.op.disks:
5798
      if disk_op == constants.DDM_REMOVE:
5799
        disk_addremove += 1
5800
        continue
5801
      elif disk_op == constants.DDM_ADD:
5802
        disk_addremove += 1
5803
      else:
5804
        if not isinstance(disk_op, int):
5805
          raise errors.OpPrereqError("Invalid disk index")
5806
      if disk_op == constants.DDM_ADD:
5807
        mode = disk_dict.setdefault('mode', constants.DISK_RDWR)
5808
        if mode not in constants.DISK_ACCESS_SET:
5809
          raise errors.OpPrereqError("Invalid disk access mode '%s'" % mode)
5810
        size = disk_dict.get('size', None)
5811
        if size is None:
5812
          raise errors.OpPrereqError("Required disk parameter size missing")
5813
        try:
5814
          size = int(size)
5815
        except ValueError, err:
5816
          raise errors.OpPrereqError("Invalid disk size parameter: %s" %
5817
                                     str(err))
5818
        disk_dict['size'] = size
5819
      else:
5820
        # modification of disk
5821
        if 'size' in disk_dict:
5822
          raise errors.OpPrereqError("Disk size change not possible, use"
5823
                                     " grow-disk")
5824

    
5825
    if disk_addremove > 1:
5826
      raise errors.OpPrereqError("Only one disk add or remove operation"
5827
                                 " supported at a time")
5828

    
5829
    # NIC validation
5830
    nic_addremove = 0
5831
    for nic_op, nic_dict in self.op.nics:
5832
      if nic_op == constants.DDM_REMOVE:
5833
        nic_addremove += 1
5834
        continue
5835
      elif nic_op == constants.DDM_ADD:
5836
        nic_addremove += 1
5837
      else:
5838
        if not isinstance(nic_op, int):
5839
          raise errors.OpPrereqError("Invalid nic index")
5840

    
5841
      # nic_dict should be a dict
5842
      nic_ip = nic_dict.get('ip', None)
5843
      if nic_ip is not None:
5844
        if nic_ip.lower() == constants.VALUE_NONE:
5845
          nic_dict['ip'] = None
5846
        else:
5847
          if not utils.IsValidIP(nic_ip):
5848
            raise errors.OpPrereqError("Invalid IP address '%s'" % nic_ip)
5849

    
5850
      if nic_op == constants.DDM_ADD:
5851
        nic_bridge = nic_dict.get('bridge', None)
5852
        if nic_bridge is None:
5853
          nic_dict['bridge'] = self.cfg.GetDefBridge()
5854
        nic_mac = nic_dict.get('mac', None)
5855
        if nic_mac is None:
5856
          nic_dict['mac'] = constants.VALUE_AUTO
5857

    
5858
      if 'mac' in nic_dict:
5859
        nic_mac = nic_dict['mac']
5860
        if nic_mac not in (constants.VALUE_AUTO, constants.VALUE_GENERATE):
5861
          if not utils.IsValidMac(nic_mac):
5862
            raise errors.OpPrereqError("Invalid MAC address %s" % nic_mac)
5863
        if nic_op != constants.DDM_ADD and nic_mac == constants.VALUE_AUTO:
5864
          raise errors.OpPrereqError("'auto' is not a valid MAC address when"
5865
                                     " modifying an existing nic")
5866

    
5867
    if nic_addremove > 1:
5868
      raise errors.OpPrereqError("Only one NIC add or remove operation"
5869
                                 " supported at a time")
5870

    
5871
  def ExpandNames(self):
5872
    self._ExpandAndLockInstance()
5873
    self.needed_locks[locking.LEVEL_NODE] = []
5874
    self.recalculate_locks[locking.LEVEL_NODE] = constants.LOCKS_REPLACE
5875

    
5876
  def DeclareLocks(self, level):
5877
    if level == locking.LEVEL_NODE:
5878
      self._LockInstancesNodes()
5879

    
5880
  def BuildHooksEnv(self):
5881
    """Build hooks env.
5882

5883
    This runs on the master, primary and secondaries.
5884

5885
    """
5886
    args = dict()
5887
    if constants.BE_MEMORY in self.be_new:
5888
      args['memory'] = self.be_new[constants.BE_MEMORY]
5889
    if constants.BE_VCPUS in self.be_new:
5890
      args['vcpus'] = self.be_new[constants.BE_VCPUS]
5891
    # TODO: export disk changes. Note: _BuildInstanceHookEnv* don't export disk
5892
    # information at all.
5893
    if self.op.nics:
5894
      args['nics'] = []
5895
      nic_override = dict(self.op.nics)
5896
      for idx, nic in enumerate(self.instance.nics):
5897
        if idx in nic_override:
5898
          this_nic_override = nic_override[idx]
5899
        else:
5900
          this_nic_override = {}
5901
        if 'ip' in this_nic_override:
5902
          ip = this_nic_override['ip']
5903
        else:
5904
          ip = nic.ip
5905
        if 'bridge' in this_nic_override:
5906
          bridge = this_nic_override['bridge']
5907
        else:
5908
          bridge = nic.bridge
5909
        if 'mac' in this_nic_override:
5910
          mac = this_nic_override['mac']
5911
        else:
5912
          mac = nic.mac
5913
        args['nics'].append((ip, bridge, mac))
5914
      if constants.DDM_ADD in nic_override:
5915
        ip = nic_override[constants.DDM_ADD].get('ip', None)
5916
        bridge = nic_override[constants.DDM_ADD]['bridge']
5917
        mac = nic_override[constants.DDM_ADD]['mac']
5918
        args['nics'].append((ip, bridge, mac))
5919
      elif constants.DDM_REMOVE in nic_override:
5920
        del args['nics'][-1]
5921

    
5922
    env = _BuildInstanceHookEnvByObject(self, self.instance, override=args)
5923
    nl = [self.cfg.GetMasterNode()] + list(self.instance.all_nodes)
5924
    return env, nl, nl
5925

    
5926
  def CheckPrereq(self):
5927
    """Check prerequisites.
5928

5929
    This only checks the instance list against the existing names.
5930

5931
    """
5932
    force = self.force = self.op.force
5933

    
5934
    # checking the new params on the primary/secondary nodes
5935

    
5936
    instance = self.instance = self.cfg.GetInstanceInfo(self.op.instance_name)
5937
    assert self.instance is not None, \
5938
      "Cannot retrieve locked instance %s" % self.op.instance_name
5939
    pnode = instance.primary_node
5940
    nodelist = list(instance.all_nodes)
5941

    
5942
    # hvparams processing
5943
    if self.op.hvparams:
5944
      i_hvdict = copy.deepcopy(instance.hvparams)
5945
      for key, val in self.op.hvparams.iteritems():
5946
        if val == constants.VALUE_DEFAULT:
5947
          try:
5948
            del i_hvdict[key]
5949
          except KeyError:
5950
            pass
5951
        else:
5952
          i_hvdict[key] = val
5953
      cluster = self.cfg.GetClusterInfo()
5954
      utils.ForceDictType(i_hvdict, constants.HVS_PARAMETER_TYPES)
5955
      hv_new = cluster.FillDict(cluster.hvparams[instance.hypervisor],
5956
                                i_hvdict)
5957
      # local check
5958
      hypervisor.GetHypervisor(
5959
        instance.hypervisor).CheckParameterSyntax(hv_new)
5960
      _CheckHVParams(self, nodelist, instance.hypervisor, hv_new)
5961
      self.hv_new = hv_new # the new actual values
5962
      self.hv_inst = i_hvdict # the new dict (without defaults)
5963
    else:
5964
      self.hv_new = self.hv_inst = {}
5965

    
5966
    # beparams processing
5967
    if self.op.beparams:
5968
      i_bedict = copy.deepcopy(instance.beparams)
5969
      for key, val in self.op.beparams.iteritems():
5970
        if val == constants.VALUE_DEFAULT:
5971
          try:
5972
            del i_bedict[key]
5973
          except KeyError:
5974
            pass
5975
        else:
5976
          i_bedict[key] = val
5977
      cluster = self.cfg.GetClusterInfo()
5978
      utils.ForceDictType(i_bedict, constants.BES_PARAMETER_TYPES)
5979
      be_new = cluster.FillDict(cluster.beparams[constants.BEGR_DEFAULT],
5980
                                i_bedict)
5981
      self.be_new = be_new # the new actual values
5982
      self.be_inst = i_bedict # the new dict (without defaults)
5983
    else:
5984
      self.be_new = self.be_inst = {}
5985

    
5986
    self.warn = []
5987

    
5988
    if constants.BE_MEMORY in self.op.beparams and not self.force:
5989
      mem_check_list = [pnode]
5990
      if be_new[constants.BE_AUTO_BALANCE]:
5991
        # either we changed auto_balance to yes or it was from before
5992
        mem_check_list.extend(instance.secondary_nodes)
5993
      instance_info = self.rpc.call_instance_info(pnode, instance.name,
5994
                                                  instance.hypervisor)
5995
      nodeinfo = self.rpc.call_node_info(mem_check_list, self.cfg.GetVGName(),
5996
                                         instance.hypervisor)
5997
      if nodeinfo[pnode].failed or not isinstance(nodeinfo[pnode].data, dict):
5998
        # Assume the primary node is unreachable and go ahead
5999
        self.warn.append("Can't get info from primary node %s" % pnode)
6000
      else:
6001
        if not instance_info.failed and instance_info.data:
6002
          current_mem = int(instance_info.data['memory'])
6003
        else:
6004
          # Assume instance not running
6005
          # (there is a slight race condition here, but it's not very probable,
6006
          # and we have no other way to check)
6007
          current_mem = 0
6008
        miss_mem = (be_new[constants.BE_MEMORY] - current_mem -
6009
                    nodeinfo[pnode].data['memory_free'])
6010
        if miss_mem > 0:
6011
          raise errors.OpPrereqError("This change will prevent the instance"
6012
                                     " from starting, due to %d MB of memory"
6013
                                     " missing on its primary node" % miss_mem)
6014

    
6015
      if be_new[constants.BE_AUTO_BALANCE]:
6016
        for node, nres in nodeinfo.iteritems():
6017
          if node not in instance.secondary_nodes:
6018
            continue
6019
          if nres.failed or not isinstance(nres.data, dict):
6020
            self.warn.append("Can't get info from secondary node %s" % node)
6021
          elif be_new[constants.BE_MEMORY] > nres.data['memory_free']:
6022
            self.warn.append("Not enough memory to failover instance to"
6023
                             " secondary node %s" % node)
6024

    
6025
    # NIC processing
6026
    for nic_op, nic_dict in self.op.nics:
6027
      if nic_op == constants.DDM_REMOVE:
6028
        if not instance.nics:
6029
          raise errors.OpPrereqError("Instance has no NICs, cannot remove")
6030
        continue
6031
      if nic_op != constants.DDM_ADD:
6032
        # an existing nic
6033
        if nic_op < 0 or nic_op >= len(instance.nics):
6034
          raise errors.OpPrereqError("Invalid NIC index %s, valid values"
6035
                                     " are 0 to %d" %
6036
                                     (nic_op, len(instance.nics)))
6037
      if 'bridge' in nic_dict:
6038
        nic_bridge = nic_dict['bridge']
6039
        if nic_bridge is None:
6040
          raise errors.OpPrereqError('Cannot set the nic bridge to None')
6041
        if not self.rpc.call_bridges_exist(pnode, [nic_bridge]):
6042
          msg = ("Bridge '%s' doesn't exist on one of"
6043
                 " the instance nodes" % nic_bridge)
6044
          if self.force:
6045
            self.warn.append(msg)
6046
          else:
6047
            raise errors.OpPrereqError(msg)
6048
      if 'mac' in nic_dict:
6049
        nic_mac = nic_dict['mac']
6050
        if nic_mac is None:
6051
          raise errors.OpPrereqError('Cannot set the nic mac to None')
6052
        elif nic_mac in (constants.VALUE_AUTO, constants.VALUE_GENERATE):
6053
          # otherwise generate the mac
6054
          nic_dict['mac'] = self.cfg.GenerateMAC()
6055
        else:
6056
          # or validate/reserve the current one
6057
          if self.cfg.IsMacInUse(nic_mac):
6058
            raise errors.OpPrereqError("MAC address %s already in use"
6059
                                       " in cluster" % nic_mac)
6060

    
6061
    # DISK processing
6062
    if self.op.disks and instance.disk_template == constants.DT_DISKLESS:
6063
      raise errors.OpPrereqError("Disk operations not supported for"
6064
                                 " diskless instances")
6065
    for disk_op, disk_dict in self.op.disks:
6066
      if disk_op == constants.DDM_REMOVE:
6067
        if len(instance.disks) == 1:
6068
          raise errors.OpPrereqError("Cannot remove the last disk of"
6069
                                     " an instance")
6070
        ins_l = self.rpc.call_instance_list([pnode], [instance.hypervisor])
6071
        ins_l = ins_l[pnode]
6072
        if ins_l.failed or not isinstance(ins_l.data, list):
6073
          raise errors.OpPrereqError("Can't contact node '%s'" % pnode)
6074
        if instance.name in ins_l.data:
6075
          raise errors.OpPrereqError("Instance is running, can't remove"
6076
                                     " disks.")
6077

    
6078
      if (disk_op == constants.DDM_ADD and
6079
          len(instance.nics) >= constants.MAX_DISKS):
6080
        raise errors.OpPrereqError("Instance has too many disks (%d), cannot"
6081
                                   " add more" % constants.MAX_DISKS)
6082
      if disk_op not in (constants.DDM_ADD, constants.DDM_REMOVE):
6083
        # an existing disk
6084
        if disk_op < 0 or disk_op >= len(instance.disks):
6085
          raise errors.OpPrereqError("Invalid disk index %s, valid values"
6086
                                     " are 0 to %d" %
6087
                                     (disk_op, len(instance.disks)))
6088

    
6089
    return
6090

    
6091
  def Exec(self, feedback_fn):
6092
    """Modifies an instance.
6093

6094
    All parameters take effect only at the next restart of the instance.
6095

6096
    """
6097
    # Process here the warnings from CheckPrereq, as we don't have a
6098
    # feedback_fn there.
6099
    for warn in self.warn:
6100
      feedback_fn("WARNING: %s" % warn)
6101

    
6102
    result = []
6103
    instance = self.instance
6104
    # disk changes
6105
    for disk_op, disk_dict in self.op.disks:
6106
      if disk_op == constants.DDM_REMOVE:
6107
        # remove the last disk
6108
        device = instance.disks.pop()
6109
        device_idx = len(instance.disks)
6110
        for node, disk in device.ComputeNodeTree(instance.primary_node):
6111
          self.cfg.SetDiskID(disk, node)
6112
          msg = self.rpc.call_blockdev_remove(node, disk).RemoteFailMsg()
6113
          if msg:
6114
            self.LogWarning("Could not remove disk/%d on node %s: %s,"
6115
                            " continuing anyway", device_idx, node, msg)
6116
        result.append(("disk/%d" % device_idx, "remove"))
6117
      elif disk_op == constants.DDM_ADD:
6118
        # add a new disk
6119
        if instance.disk_template == constants.DT_FILE:
6120
          file_driver, file_path = instance.disks[0].logical_id
6121
          file_path = os.path.dirname(file_path)
6122
        else:
6123
          file_driver = file_path = None
6124
        disk_idx_base = len(instance.disks)
6125
        new_disk = _GenerateDiskTemplate(self,
6126
                                         instance.disk_template,
6127
                                         instance.name, instance.primary_node,
6128
                                         instance.secondary_nodes,
6129
                                         [disk_dict],
6130
                                         file_path,
6131
                                         file_driver,
6132
                                         disk_idx_base)[0]
6133
        instance.disks.append(new_disk)
6134
        info = _GetInstanceInfoText(instance)
6135

    
6136
        logging.info("Creating volume %s for instance %s",
6137
                     new_disk.iv_name, instance.name)
6138
        # Note: this needs to be kept in sync with _CreateDisks
6139
        #HARDCODE
6140
        for node in instance.all_nodes:
6141
          f_create = node == instance.primary_node
6142
          try:
6143
            _CreateBlockDev(self, node, instance, new_disk,
6144
                            f_create, info, f_create)
6145
          except errors.OpExecError, err:
6146
            self.LogWarning("Failed to create volume %s (%s) on"
6147
                            " node %s: %s",
6148
                            new_disk.iv_name, new_disk, node, err)
6149
        result.append(("disk/%d" % disk_idx_base, "add:size=%s,mode=%s" %
6150
                       (new_disk.size, new_disk.mode)))
6151
      else:
6152
        # change a given disk
6153
        instance.disks[disk_op].mode = disk_dict['mode']
6154
        result.append(("disk.mode/%d" % disk_op, disk_dict['mode']))
6155
    # NIC changes
6156
    for nic_op, nic_dict in self.op.nics:
6157
      if nic_op == constants.DDM_REMOVE:
6158
        # remove the last nic
6159
        del instance.nics[-1]
6160
        result.append(("nic.%d" % len(instance.nics), "remove"))
6161
      elif nic_op == constants.DDM_ADD:
6162
        # mac and bridge should be set, by now
6163
        mac = nic_dict['mac']
6164
        bridge = nic_dict['bridge']
6165
        new_nic = objects.NIC(mac=mac, ip=nic_dict.get('ip', None),
6166
                              bridge=bridge)
6167
        instance.nics.append(new_nic)
6168
        result.append(("nic.%d" % (len(instance.nics) - 1),
6169
                       "add:mac=%s,ip=%s,bridge=%s" %
6170
                       (new_nic.mac, new_nic.ip, new_nic.bridge)))
6171
      else:
6172
        # change a given nic
6173
        for key in 'mac', 'ip', 'bridge':
6174
          if key in nic_dict:
6175
            setattr(instance.nics[nic_op], key, nic_dict[key])
6176
            result.append(("nic.%s/%d" % (key, nic_op), nic_dict[key]))
6177

    
6178
    # hvparams changes
6179
    if self.op.hvparams:
6180
      instance.hvparams = self.hv_inst
6181
      for key, val in self.op.hvparams.iteritems():
6182
        result.append(("hv/%s" % key, val))
6183

    
6184
    # beparams changes
6185
    if self.op.beparams:
6186
      instance.beparams = self.be_inst
6187
      for key, val in self.op.beparams.iteritems():
6188
        result.append(("be/%s" % key, val))
6189

    
6190
    self.cfg.Update(instance)
6191

    
6192
    return result
6193

    
6194

    
6195
class LUQueryExports(NoHooksLU):
6196
  """Query the exports list
6197

6198
  """
6199
  _OP_REQP = ['nodes']
6200
  REQ_BGL = False
6201

    
6202
  def ExpandNames(self):
6203
    self.needed_locks = {}
6204
    self.share_locks[locking.LEVEL_NODE] = 1
6205
    if not self.op.nodes:
6206
      self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
6207
    else:
6208
      self.needed_locks[locking.LEVEL_NODE] = \
6209
        _GetWantedNodes(self, self.op.nodes)
6210

    
6211
  def CheckPrereq(self):
6212
    """Check prerequisites.
6213

6214
    """
6215
    self.nodes = self.acquired_locks[locking.LEVEL_NODE]
6216

    
6217
  def Exec(self, feedback_fn):
6218
    """Compute the list of all the exported system images.
6219

6220
    @rtype: dict
6221
    @return: a dictionary with the structure node->(export-list)
6222
        where export-list is a list of the instances exported on
6223
        that node.
6224

6225
    """
6226
    rpcresult = self.rpc.call_export_list(self.nodes)
6227
    result = {}
6228
    for node in rpcresult:
6229
      if rpcresult[node].failed:
6230
        result[node] = False
6231
      else:
6232
        result[node] = rpcresult[node].data
6233

    
6234
    return result
6235

    
6236

    
6237
class LUExportInstance(LogicalUnit):
6238
  """Export an instance to an image in the cluster.
6239

6240
  """
6241
  HPATH = "instance-export"
6242
  HTYPE = constants.HTYPE_INSTANCE
6243
  _OP_REQP = ["instance_name", "target_node", "shutdown"]
6244
  REQ_BGL = False
6245

    
6246
  def ExpandNames(self):
6247
    self._ExpandAndLockInstance()
6248
    # FIXME: lock only instance primary and destination node
6249
    #
6250
    # Sad but true, for now we have do lock all nodes, as we don't know where
6251
    # the previous export might be, and and in this LU we search for it and
6252
    # remove it from its current node. In the future we could fix this by:
6253
    #  - making a tasklet to search (share-lock all), then create the new one,
6254
    #    then one to remove, after
6255
    #  - removing the removal operation altoghether
6256
    self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
6257

    
6258
  def DeclareLocks(self, level):
6259
    """Last minute lock declaration."""
6260
    # All nodes are locked anyway, so nothing to do here.
6261

    
6262
  def BuildHooksEnv(self):
6263
    """Build hooks env.
6264

6265
    This will run on the master, primary node and target node.
6266

6267
    """
6268
    env = {
6269
      "EXPORT_NODE": self.op.target_node,
6270
      "EXPORT_DO_SHUTDOWN": self.op.shutdown,
6271
      }
6272
    env.update(_BuildInstanceHookEnvByObject(self, self.instance))
6273
    nl = [self.cfg.GetMasterNode(), self.instance.primary_node,
6274
          self.op.target_node]
6275
    return env, nl, nl
6276

    
6277
  def CheckPrereq(self):
6278
    """Check prerequisites.
6279

6280
    This checks that the instance and node names are valid.
6281

6282
    """
6283
    instance_name = self.op.instance_name
6284
    self.instance = self.cfg.GetInstanceInfo(instance_name)
6285
    assert self.instance is not None, \
6286
          "Cannot retrieve locked instance %s" % self.op.instance_name
6287
    _CheckNodeOnline(self, self.instance.primary_node)
6288

    
6289
    self.dst_node = self.cfg.GetNodeInfo(
6290
      self.cfg.ExpandNodeName(self.op.target_node))
6291

    
6292
    if self.dst_node is None:
6293
      # This is wrong node name, not a non-locked node
6294
      raise errors.OpPrereqError("Wrong node name %s" % self.op.target_node)
6295
    _CheckNodeOnline(self, self.dst_node.name)
6296
    _CheckNodeNotDrained(self, self.dst_node.name)
6297

    
6298
    # instance disk type verification
6299
    for disk in self.instance.disks:
6300
      if disk.dev_type == constants.LD_FILE:
6301
        raise errors.OpPrereqError("Export not supported for instances with"
6302
                                   " file-based disks")
6303

    
6304
  def Exec(self, feedback_fn):
6305
    """Export an instance to an image in the cluster.
6306

6307
    """
6308
    instance = self.instance
6309
    dst_node = self.dst_node
6310
    src_node = instance.primary_node
6311
    if self.op.shutdown:
6312
      # shutdown the instance, but not the disks
6313
      result = self.rpc.call_instance_shutdown(src_node, instance)
6314
      msg = result.RemoteFailMsg()
6315
      if msg:
6316
        raise errors.OpExecError("Could not shutdown instance %s on"
6317
                                 " node %s: %s" %
6318
                                 (instance.name, src_node, msg))
6319

    
6320
    vgname = self.cfg.GetVGName()
6321

    
6322
    snap_disks = []
6323

    
6324
    # set the disks ID correctly since call_instance_start needs the
6325
    # correct drbd minor to create the symlinks
6326
    for disk in instance.disks:
6327
      self.cfg.SetDiskID(disk, src_node)
6328

    
6329
    try:
6330
      for idx, disk in enumerate(instance.disks):
6331
        # new_dev_name will be a snapshot of an lvm leaf of the one we passed
6332
        new_dev_name = self.rpc.call_blockdev_snapshot(src_node, disk)
6333
        if new_dev_name.failed or not new_dev_name.data:
6334
          self.LogWarning("Could not snapshot disk/%d on node %s",
6335
                          idx, src_node)
6336
          snap_disks.append(False)
6337
        else:
6338
          new_dev = objects.Disk(dev_type=constants.LD_LV, size=disk.size,
6339
                                 logical_id=(vgname, new_dev_name.data),
6340
                                 physical_id=(vgname, new_dev_name.data),
6341
                                 iv_name=disk.iv_name)
6342
          snap_disks.append(new_dev)
6343

    
6344
    finally:
6345
      if self.op.shutdown and instance.admin_up:
6346
        result = self.rpc.call_instance_start(src_node, instance, None, None)
6347
        msg = result.RemoteFailMsg()
6348
        if msg:
6349
          _ShutdownInstanceDisks(self, instance)
6350
          raise errors.OpExecError("Could not start instance: %s" % msg)
6351

    
6352
    # TODO: check for size
6353

    
6354
    cluster_name = self.cfg.GetClusterName()
6355
    for idx, dev in enumerate(snap_disks):
6356
      if dev:
6357
        result = self.rpc.call_snapshot_export(src_node, dev, dst_node.name,
6358
                                               instance, cluster_name, idx)
6359
        if result.failed or not result.data:
6360
          self.LogWarning("Could not export disk/%d from node %s to"
6361
                          " node %s", idx, src_node, dst_node.name)
6362
        msg = self.rpc.call_blockdev_remove(src_node, dev).RemoteFailMsg()
6363
        if msg:
6364
          self.LogWarning("Could not remove snapshot for disk/%d from node"
6365
                          " %s: %s", idx, src_node, msg)
6366

    
6367
    result = self.rpc.call_finalize_export(dst_node.name, instance, snap_disks)
6368
    if result.failed or not result.data:
6369
      self.LogWarning("Could not finalize export for instance %s on node %s",
6370
                      instance.name, dst_node.name)
6371

    
6372
    nodelist = self.cfg.GetNodeList()
6373
    nodelist.remove(dst_node.name)
6374

    
6375
    # on one-node clusters nodelist will be empty after the removal
6376
    # if we proceed the backup would be removed because OpQueryExports
6377
    # substitutes an empty list with the full cluster node list.
6378
    if nodelist:
6379
      exportlist = self.rpc.call_export_list(nodelist)
6380
      for node in exportlist:
6381
        if exportlist[node].failed:
6382
          continue
6383
        if instance.name in exportlist[node].data:
6384
          if not self.rpc.call_export_remove(node, instance.name):
6385
            self.LogWarning("Could not remove older export for instance %s"
6386
                            " on node %s", instance.name, node)
6387

    
6388

    
6389
class LURemoveExport(NoHooksLU):
6390
  """Remove exports related to the named instance.
6391

6392
  """
6393
  _OP_REQP = ["instance_name"]
6394
  REQ_BGL = False
6395

    
6396
  def ExpandNames(self):
6397
    self.needed_locks = {}
6398
    # We need all nodes to be locked in order for RemoveExport to work, but we
6399
    # don't need to lock the instance itself, as nothing will happen to it (and
6400
    # we can remove exports also for a removed instance)
6401
    self.needed_locks[locking.LEVEL_NODE] = locking.ALL_SET
6402

    
6403
  def CheckPrereq(self):
6404
    """Check prerequisites.
6405
    """
6406
    pass
6407

    
6408
  def Exec(self, feedback_fn):
6409
    """Remove any export.
6410

6411
    """
6412
    instance_name = self.cfg.ExpandInstanceName(self.op.instance_name)
6413
    # If the instance was not found we'll try with the name that was passed in.
6414
    # This will only work if it was an FQDN, though.
6415
    fqdn_warn = False
6416
    if not instance_name:
6417
      fqdn_warn = True
6418
      instance_name = self.op.instance_name
6419

    
6420
    exportlist = self.rpc.call_export_list(self.acquired_locks[
6421
      locking.LEVEL_NODE])
6422
    found = False
6423
    for node in exportlist:
6424
      if exportlist[node].failed:
6425
        self.LogWarning("Failed to query node %s, continuing" % node)
6426
        continue
6427
      if instance_name in exportlist[node].data:
6428
        found = True
6429
        result = self.rpc.call_export_remove(node, instance_name)
6430
        if result.failed or not result.data:
6431
          logging.error("Could not remove export for instance %s"
6432
                        " on node %s", instance_name, node)
6433

    
6434
    if fqdn_warn and not found:
6435
      feedback_fn("Export not found. If trying to remove an export belonging"
6436
                  " to a deleted instance please use its Fully Qualified"
6437
                  " Domain Name.")
6438

    
6439

    
6440
class TagsLU(NoHooksLU):
6441
  """Generic tags LU.
6442

6443
  This is an abstract class which is the parent of all the other tags LUs.
6444

6445
  """
6446

    
6447
  def ExpandNames(self):
6448
    self.needed_locks = {}
6449
    if self.op.kind == constants.TAG_NODE:
6450
      name = self.cfg.ExpandNodeName(self.op.name)
6451
      if name is None:
6452
        raise errors.OpPrereqError("Invalid node name (%s)" %
6453
                                   (self.op.name,))
6454
      self.op.name = name
6455
      self.needed_locks[locking.LEVEL_NODE] = name
6456
    elif self.op.kind == constants.TAG_INSTANCE:
6457
      name = self.cfg.ExpandInstanceName(self.op.name)
6458
      if name is None:
6459
        raise errors.OpPrereqError("Invalid instance name (%s)" %
6460
                                   (self.op.name,))
6461
      self.op.name = name
6462
      self.needed_locks[locking.LEVEL_INSTANCE] = name
6463

    
6464
  def CheckPrereq(self):
6465
    """Check prerequisites.
6466

6467
    """
6468
    if self.op.kind == constants.TAG_CLUSTER:
6469
      self.target = self.cfg.GetClusterInfo()
6470
    elif self.op.kind == constants.TAG_NODE:
6471
      self.target = self.cfg.GetNodeInfo(self.op.name)
6472
    elif self.op.kind == constants.TAG_INSTANCE:
6473
      self.target = self.cfg.GetInstanceInfo(self.op.name)
6474
    else:
6475
      raise errors.OpPrereqError("Wrong tag type requested (%s)" %
6476
                                 str(self.op.kind))
6477

    
6478

    
6479
class LUGetTags(TagsLU):
6480
  """Returns the tags of a given object.
6481

6482
  """
6483
  _OP_REQP = ["kind", "name"]
6484
  REQ_BGL = False
6485

    
6486
  def Exec(self, feedback_fn):
6487
    """Returns the tag list.
6488

6489
    """
6490
    return list(self.target.GetTags())
6491

    
6492

    
6493
class LUSearchTags(NoHooksLU):
6494
  """Searches the tags for a given pattern.
6495

6496
  """
6497
  _OP_REQP = ["pattern"]
6498
  REQ_BGL = False
6499

    
6500
  def ExpandNames(self):
6501
    self.needed_locks = {}
6502

    
6503
  def CheckPrereq(self):
6504
    """Check prerequisites.
6505

6506
    This checks the pattern passed for validity by compiling it.
6507

6508
    """
6509
    try:
6510
      self.re = re.compile(self.op.pattern)
6511
    except re.error, err:
6512
      raise errors.OpPrereqError("Invalid search pattern '%s': %s" %
6513
                                 (self.op.pattern, err))
6514

    
6515
  def Exec(self, feedback_fn):
6516
    """Returns the tag list.
6517

6518
    """
6519
    cfg = self.cfg
6520
    tgts = [("/cluster", cfg.GetClusterInfo())]
6521
    ilist = cfg.GetAllInstancesInfo().values()
6522
    tgts.extend([("/instances/%s" % i.name, i) for i in ilist])
6523
    nlist = cfg.GetAllNodesInfo().values()
6524
    tgts.extend([("/nodes/%s" % n.name, n) for n in nlist])
6525
    results = []
6526
    for path, target in tgts:
6527
      for tag in target.GetTags():
6528
        if self.re.search(tag):
6529
          results.append((path, tag))
6530
    return results
6531

    
6532

    
6533
class LUAddTags(TagsLU):
6534
  """Sets a tag on a given object.
6535

6536
  """
6537
  _OP_REQP = ["kind", "name", "tags"]
6538
  REQ_BGL = False
6539

    
6540
  def CheckPrereq(self):
6541
    """Check prerequisites.
6542

6543
    This checks the type and length of the tag name and value.
6544

6545
    """
6546
    TagsLU.CheckPrereq(self)
6547
    for tag in self.op.tags:
6548
      objects.TaggableObject.ValidateTag(tag)
6549

    
6550
  def Exec(self, feedback_fn):
6551
    """Sets the tag.
6552

6553
    """
6554
    try:
6555
      for tag in self.op.tags:
6556
        self.target.AddTag(tag)
6557
    except errors.TagError, err:
6558
      raise errors.OpExecError("Error while setting tag: %s" % str(err))
6559
    try:
6560
      self.cfg.Update(self.target)
6561
    except errors.ConfigurationError:
6562
      raise errors.OpRetryError("There has been a modification to the"
6563
                                " config file and the operation has been"
6564
                                " aborted. Please retry.")
6565

    
6566

    
6567
class LUDelTags(TagsLU):
6568
  """Delete a list of tags from a given object.
6569

6570
  """
6571
  _OP_REQP = ["kind", "name", "tags"]
6572
  REQ_BGL = False
6573

    
6574
  def CheckPrereq(self):
6575
    """Check prerequisites.
6576

6577
    This checks that we have the given tag.
6578

6579
    """
6580
    TagsLU.CheckPrereq(self)
6581
    for tag in self.op.tags:
6582
      objects.TaggableObject.ValidateTag(tag)
6583
    del_tags = frozenset(self.op.tags)
6584
    cur_tags = self.target.GetTags()
6585
    if not del_tags <= cur_tags:
6586
      diff_tags = del_tags - cur_tags
6587
      diff_names = ["'%s'" % tag for tag in diff_tags]
6588
      diff_names.sort()
6589
      raise errors.OpPrereqError("Tag(s) %s not found" %
6590
                                 (",".join(diff_names)))
6591

    
6592
  def Exec(self, feedback_fn):
6593
    """Remove the tag from the object.
6594

6595
    """
6596
    for tag in self.op.tags:
6597
      self.target.RemoveTag(tag)
6598
    try:
6599
      self.cfg.Update(self.target)
6600
    except errors.ConfigurationError:
6601
      raise errors.OpRetryError("There has been a modification to the"
6602
                                " config file and the operation has been"
6603
                                " aborted. Please retry.")
6604

    
6605

    
6606
class LUTestDelay(NoHooksLU):
6607
  """Sleep for a specified amount of time.
6608

6609
  This LU sleeps on the master and/or nodes for a specified amount of
6610
  time.
6611

6612
  """
6613
  _OP_REQP = ["duration", "on_master", "on_nodes"]
6614
  REQ_BGL = False
6615

    
6616
  def ExpandNames(self):
6617
    """Expand names and set required locks.
6618

6619
    This expands the node list, if any.
6620

6621
    """
6622
    self.needed_locks = {}
6623
    if self.op.on_nodes:
6624
      # _GetWantedNodes can be used here, but is not always appropriate to use
6625
      # this way in ExpandNames. Check LogicalUnit.ExpandNames docstring for
6626
      # more information.
6627
      self.op.on_nodes = _GetWantedNodes(self, self.op.on_nodes)
6628
      self.needed_locks[locking.LEVEL_NODE] = self.op.on_nodes
6629

    
6630
  def CheckPrereq(self):
6631
    """Check prerequisites.
6632

6633
    """
6634

    
6635
  def Exec(self, feedback_fn):
6636
    """Do the actual sleep.
6637

6638
    """
6639
    if self.op.on_master:
6640
      if not utils.TestDelay(self.op.duration):
6641
        raise errors.OpExecError("Error during master delay test")
6642
    if self.op.on_nodes:
6643
      result = self.rpc.call_test_delay(self.op.on_nodes, self.op.duration)
6644
      if not result:
6645
        raise errors.OpExecError("Complete failure from rpc call")
6646
      for node, node_result in result.items():
6647
        node_result.Raise()
6648
        if not node_result.data:
6649
          raise errors.OpExecError("Failure during rpc call to node %s,"
6650
                                   " result: %s" % (node, node_result.data))
6651

    
6652

    
6653
class IAllocator(object):
6654
  """IAllocator framework.
6655

6656
  An IAllocator instance has three sets of attributes:
6657
    - cfg that is needed to query the cluster
6658
    - input data (all members of the _KEYS class attribute are required)
6659
    - four buffer attributes (in|out_data|text), that represent the
6660
      input (to the external script) in text and data structure format,
6661
      and the output from it, again in two formats
6662
    - the result variables from the script (success, info, nodes) for
6663
      easy usage
6664

6665
  """
6666
  _ALLO_KEYS = [
6667
    "mem_size", "disks", "disk_template",
6668
    "os", "tags", "nics", "vcpus", "hypervisor",
6669
    ]
6670
  _RELO_KEYS = [
6671
    "relocate_from",
6672
    ]
6673

    
6674
  def __init__(self, lu, mode, name, **kwargs):
6675
    self.lu = lu
6676
    # init buffer variables
6677
    self.in_text = self.out_text = self.in_data = self.out_data = None
6678
    # init all input fields so that pylint is happy
6679
    self.mode = mode
6680
    self.name = name
6681
    self.mem_size = self.disks = self.disk_template = None
6682
    self.os = self.tags = self.nics = self.vcpus = None
6683
    self.hypervisor = None
6684
    self.relocate_from = None
6685
    # computed fields
6686
    self.required_nodes = None
6687
    # init result fields
6688
    self.success = self.info = self.nodes = None
6689
    if self.mode == constants.IALLOCATOR_MODE_ALLOC:
6690
      keyset = self._ALLO_KEYS
6691
    elif self.mode == constants.IALLOCATOR_MODE_RELOC:
6692
      keyset = self._RELO_KEYS
6693
    else:
6694
      raise errors.ProgrammerError("Unknown mode '%s' passed to the"
6695
                                   " IAllocator" % self.mode)
6696
    for key in kwargs:
6697
      if key not in keyset:
6698
        raise errors.ProgrammerError("Invalid input parameter '%s' to"
6699
                                     " IAllocator" % key)
6700
      setattr(self, key, kwargs[key])
6701
    for key in keyset:
6702
      if key not in kwargs:
6703
        raise errors.ProgrammerError("Missing input parameter '%s' to"
6704
                                     " IAllocator" % key)
6705
    self._BuildInputData()
6706

    
6707
  def _ComputeClusterData(self):
6708
    """Compute the generic allocator input data.
6709

6710
    This is the data that is independent of the actual operation.
6711

6712
    """
6713
    cfg = self.lu.cfg
6714
    cluster_info = cfg.GetClusterInfo()
6715
    # cluster data
6716
    data = {
6717
      "version": constants.IALLOCATOR_VERSION,
6718
      "cluster_name": cfg.GetClusterName(),
6719
      "cluster_tags": list(cluster_info.GetTags()),
6720
      "enabled_hypervisors": list(cluster_info.enabled_hypervisors),
6721
      # we don't have job IDs
6722
      }
6723
    iinfo = cfg.GetAllInstancesInfo().values()
6724
    i_list = [(inst, cluster_info.FillBE(inst)) for inst in iinfo]
6725

    
6726
    # node data
6727
    node_results = {}
6728
    node_list = cfg.GetNodeList()
6729

    
6730
    if self.mode == constants.IALLOCATOR_MODE_ALLOC:
6731
      hypervisor_name = self.hypervisor
6732
    elif self.mode == constants.IALLOCATOR_MODE_RELOC:
6733
      hypervisor_name = cfg.GetInstanceInfo(self.name).hypervisor
6734

    
6735
    node_data = self.lu.rpc.call_node_info(node_list, cfg.GetVGName(),
6736
                                           hypervisor_name)
6737
    node_iinfo = self.lu.rpc.call_all_instances_info(node_list,
6738
                       cluster_info.enabled_hypervisors)
6739
    for nname, nresult in node_data.items():
6740
      # first fill in static (config-based) values
6741
      ninfo = cfg.GetNodeInfo(nname)
6742
      pnr = {
6743
        "tags": list(ninfo.GetTags()),
6744
        "primary_ip": ninfo.primary_ip,
6745
        "secondary_ip": ninfo.secondary_ip,
6746
        "offline": ninfo.offline,
6747
        "drained": ninfo.drained,
6748
        "master_candidate": ninfo.master_candidate,
6749
        }
6750

    
6751
      if not ninfo.offline:
6752
        nresult.Raise()
6753
        if not isinstance(nresult.data, dict):
6754
          raise errors.OpExecError("Can't get data for node %s" % nname)
6755
        remote_info = nresult.data
6756
        for attr in ['memory_total', 'memory_free', 'memory_dom0',
6757
                     'vg_size', 'vg_free', 'cpu_total']:
6758
          if attr not in remote_info:
6759
            raise errors.OpExecError("Node '%s' didn't return attribute"
6760
                                     " '%s'" % (nname, attr))
6761
          try:
6762
            remote_info[attr] = int(remote_info[attr])
6763
          except ValueError, err:
6764
            raise errors.OpExecError("Node '%s' returned invalid value"
6765
                                     " for '%s': %s" % (nname, attr, err))
6766
        # compute memory used by primary instances
6767
        i_p_mem = i_p_up_mem = 0
6768
        for iinfo, beinfo in i_list:
6769
          if iinfo.primary_node == nname:
6770
            i_p_mem += beinfo[constants.BE_MEMORY]
6771
            if iinfo.name not in node_iinfo[nname].data:
6772
              i_used_mem = 0
6773
            else:
6774
              i_used_mem = int(node_iinfo[nname].data[iinfo.name]['memory'])
6775
            i_mem_diff = beinfo[constants.BE_MEMORY] - i_used_mem
6776
            remote_info['memory_free'] -= max(0, i_mem_diff)
6777

    
6778
            if iinfo.admin_up:
6779
              i_p_up_mem += beinfo[constants.BE_MEMORY]
6780

    
6781
        # compute memory used by instances
6782
        pnr_dyn = {
6783
          "total_memory": remote_info['memory_total'],
6784
          "reserved_memory": remote_info['memory_dom0'],
6785
          "free_memory": remote_info['memory_free'],
6786
          "total_disk": remote_info['vg_size'],
6787
          "free_disk": remote_info['vg_free'],
6788
          "total_cpus": remote_info['cpu_total'],
6789
          "i_pri_memory": i_p_mem,
6790
          "i_pri_up_memory": i_p_up_mem,
6791
          }
6792
        pnr.update(pnr_dyn)
6793

    
6794
      node_results[nname] = pnr
6795
    data["nodes"] = node_results
6796

    
6797
    # instance data
6798
    instance_data = {}
6799
    for iinfo, beinfo in i_list:
6800
      nic_data = [{"mac": n.mac, "ip": n.ip, "bridge": n.bridge}
6801
                  for n in iinfo.nics]
6802
      pir = {
6803
        "tags": list(iinfo.GetTags()),
6804
        "admin_up": iinfo.admin_up,
6805
        "vcpus": beinfo[constants.BE_VCPUS],
6806
        "memory": beinfo[constants.BE_MEMORY],
6807
        "os": iinfo.os,
6808
        "nodes": [iinfo.primary_node] + list(iinfo.secondary_nodes),
6809
        "nics": nic_data,
6810
        "disks": [{"size": dsk.size, "mode": dsk.mode} for dsk in iinfo.disks],
6811
        "disk_template": iinfo.disk_template,
6812
        "hypervisor": iinfo.hypervisor,
6813
        }
6814
      pir["disk_space_total"] = _ComputeDiskSize(iinfo.disk_template,
6815
                                                 pir["disks"])
6816
      instance_data[iinfo.name] = pir
6817

    
6818
    data["instances"] = instance_data
6819

    
6820
    self.in_data = data
6821

    
6822
  def _AddNewInstance(self):
6823
    """Add new instance data to allocator structure.
6824

6825
    This in combination with _AllocatorGetClusterData will create the
6826
    correct structure needed as input for the allocator.
6827

6828
    The checks for the completeness of the opcode must have already been
6829
    done.
6830

6831
    """
6832
    data = self.in_data
6833

    
6834
    disk_space = _ComputeDiskSize(self.disk_template, self.disks)
6835

    
6836
    if self.disk_template in constants.DTS_NET_MIRROR:
6837
      self.required_nodes = 2
6838
    else:
6839
      self.required_nodes = 1
6840
    request = {
6841
      "type": "allocate",
6842
      "name": self.name,
6843
      "disk_template": self.disk_template,
6844
      "tags": self.tags,
6845
      "os": self.os,
6846
      "vcpus": self.vcpus,
6847
      "memory": self.mem_size,
6848
      "disks": self.disks,
6849
      "disk_space_total": disk_space,
6850
      "nics": self.nics,
6851
      "required_nodes": self.required_nodes,
6852
      }
6853
    data["request"] = request
6854

    
6855
  def _AddRelocateInstance(self):
6856
    """Add relocate instance data to allocator structure.
6857

6858
    This in combination with _IAllocatorGetClusterData will create the
6859
    correct structure needed as input for the allocator.
6860

6861
    The checks for the completeness of the opcode must have already been
6862
    done.
6863

6864
    """
6865
    instance = self.lu.cfg.GetInstanceInfo(self.name)
6866
    if instance is None:
6867
      raise errors.ProgrammerError("Unknown instance '%s' passed to"
6868
                                   " IAllocator" % self.name)
6869

    
6870
    if instance.disk_template not in constants.DTS_NET_MIRROR:
6871
      raise errors.OpPrereqError("Can't relocate non-mirrored instances")
6872

    
6873
    if len(instance.secondary_nodes) != 1:
6874
      raise errors.OpPrereqError("Instance has not exactly one secondary node")
6875

    
6876
    self.required_nodes = 1
6877
    disk_sizes = [{'size': disk.size} for disk in instance.disks]
6878
    disk_space = _ComputeDiskSize(instance.disk_template, disk_sizes)
6879

    
6880
    request = {
6881
      "type": "relocate",
6882
      "name": self.name,
6883
      "disk_space_total": disk_space,
6884
      "required_nodes": self.required_nodes,
6885
      "relocate_from": self.relocate_from,
6886
      }
6887
    self.in_data["request"] = request
6888

    
6889
  def _BuildInputData(self):
6890
    """Build input data structures.
6891

6892
    """
6893
    self._ComputeClusterData()
6894

    
6895
    if self.mode == constants.IALLOCATOR_MODE_ALLOC:
6896
      self._AddNewInstance()
6897
    else:
6898
      self._AddRelocateInstance()
6899

    
6900
    self.in_text = serializer.Dump(self.in_data)
6901

    
6902
  def Run(self, name, validate=True, call_fn=None):
6903
    """Run an instance allocator and return the results.
6904

6905
    """
6906
    if call_fn is None:
6907
      call_fn = self.lu.rpc.call_iallocator_runner
6908
    data = self.in_text
6909

    
6910
    result = call_fn(self.lu.cfg.GetMasterNode(), name, self.in_text)
6911
    result.Raise()
6912

    
6913
    if not isinstance(result.data, (list, tuple)) or len(result.data) != 4:
6914
      raise errors.OpExecError("Invalid result from master iallocator runner")
6915

    
6916
    rcode, stdout, stderr, fail = result.data
6917

    
6918
    if rcode == constants.IARUN_NOTFOUND:
6919
      raise errors.OpExecError("Can't find allocator '%s'" % name)
6920
    elif rcode == constants.IARUN_FAILURE:
6921
      raise errors.OpExecError("Instance allocator call failed: %s,"
6922
                               " output: %s" % (fail, stdout+stderr))
6923
    self.out_text = stdout
6924
    if validate:
6925
      self._ValidateResult()
6926

    
6927
  def _ValidateResult(self):
6928
    """Process the allocator results.
6929

6930
    This will process and if successful save the result in
6931
    self.out_data and the other parameters.
6932

6933
    """
6934
    try:
6935
      rdict = serializer.Load(self.out_text)
6936
    except Exception, err:
6937
      raise errors.OpExecError("Can't parse iallocator results: %s" % str(err))
6938

    
6939
    if not isinstance(rdict, dict):
6940
      raise errors.OpExecError("Can't parse iallocator results: not a dict")
6941

    
6942
    for key in "success", "info", "nodes":
6943
      if key not in rdict:
6944
        raise errors.OpExecError("Can't parse iallocator results:"
6945
                                 " missing key '%s'" % key)
6946
      setattr(self, key, rdict[key])
6947

    
6948
    if not isinstance(rdict["nodes"], list):
6949
      raise errors.OpExecError("Can't parse iallocator results: 'nodes' key"
6950
                               " is not a list")
6951
    self.out_data = rdict
6952

    
6953

    
6954
class LUTestAllocator(NoHooksLU):
6955
  """Run allocator tests.
6956

6957
  This LU runs the allocator tests
6958

6959
  """
6960
  _OP_REQP = ["direction", "mode", "name"]
6961

    
6962
  def CheckPrereq(self):
6963
    """Check prerequisites.
6964

6965
    This checks the opcode parameters depending on the director and mode test.
6966

6967
    """
6968
    if self.op.mode == constants.IALLOCATOR_MODE_ALLOC:
6969
      for attr in ["name", "mem_size", "disks", "disk_template",
6970
                   "os", "tags", "nics", "vcpus"]:
6971
        if not hasattr(self.op, attr):
6972
          raise errors.OpPrereqError("Missing attribute '%s' on opcode input" %
6973
                                     attr)
6974
      iname = self.cfg.ExpandInstanceName(self.op.name)
6975
      if iname is not None:
6976
        raise errors.OpPrereqError("Instance '%s' already in the cluster" %
6977
                                   iname)
6978
      if not isinstance(self.op.nics, list):
6979
        raise errors.OpPrereqError("Invalid parameter 'nics'")
6980
      for row in self.op.nics:
6981
        if (not isinstance(row, dict) or
6982
            "mac" not in row or
6983
            "ip" not in row or
6984
            "bridge" not in row):
6985
          raise errors.OpPrereqError("Invalid contents of the"
6986
                                     " 'nics' parameter")
6987
      if not isinstance(self.op.disks, list):
6988
        raise errors.OpPrereqError("Invalid parameter 'disks'")
6989
      for row in self.op.disks:
6990
        if (not isinstance(row, dict) or
6991
            "size" not in row or
6992
            not isinstance(row["size"], int) or
6993
            "mode" not in row or
6994
            row["mode"] not in ['r', 'w']):
6995
          raise errors.OpPrereqError("Invalid contents of the"
6996
                                     " 'disks' parameter")
6997
      if not hasattr(self.op, "hypervisor") or self.op.hypervisor is None:
6998
        self.op.hypervisor = self.cfg.GetHypervisorType()
6999
    elif self.op.mode == constants.IALLOCATOR_MODE_RELOC:
7000
      if not hasattr(self.op, "name"):
7001
        raise errors.OpPrereqError("Missing attribute 'name' on opcode input")
7002
      fname = self.cfg.ExpandInstanceName(self.op.name)
7003
      if fname is None:
7004
        raise errors.OpPrereqError("Instance '%s' not found for relocation" %
7005
                                   self.op.name)
7006
      self.op.name = fname
7007
      self.relocate_from = self.cfg.GetInstanceInfo(fname).secondary_nodes
7008
    else:
7009
      raise errors.OpPrereqError("Invalid test allocator mode '%s'" %
7010
                                 self.op.mode)
7011

    
7012
    if self.op.direction == constants.IALLOCATOR_DIR_OUT:
7013
      if not hasattr(self.op, "allocator") or self.op.allocator is None:
7014
        raise errors.OpPrereqError("Missing allocator name")
7015
    elif self.op.direction != constants.IALLOCATOR_DIR_IN:
7016
      raise errors.OpPrereqError("Wrong allocator test '%s'" %
7017
                                 self.op.direction)
7018

    
7019
  def Exec(self, feedback_fn):
7020
    """Run the allocator test.
7021

7022
    """
7023
    if self.op.mode == constants.IALLOCATOR_MODE_ALLOC:
7024
      ial = IAllocator(self,
7025
                       mode=self.op.mode,
7026
                       name=self.op.name,
7027
                       mem_size=self.op.mem_size,
7028
                       disks=self.op.disks,
7029
                       disk_template=self.op.disk_template,
7030
                       os=self.op.os,
7031
                       tags=self.op.tags,
7032
                       nics=self.op.nics,
7033
                       vcpus=self.op.vcpus,
7034
                       hypervisor=self.op.hypervisor,
7035
                       )
7036
    else:
7037
      ial = IAllocator(self,
7038
                       mode=self.op.mode,
7039
                       name=self.op.name,
7040
                       relocate_from=list(self.relocate_from),
7041
                       )
7042

    
7043
    if self.op.direction == constants.IALLOCATOR_DIR_IN:
7044
      result = ial.in_text
7045
    else:
7046
      ial.Run(self.op.allocator, validate=False)
7047
      result = ial.out_text
7048
    return result