Statistics
| Branch: | Tag: | Revision:

root / lib / config.py @ 75cf411a

History | View | Annotate | Download (59 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 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
"""Configuration management for Ganeti
23

24
This module provides the interface to the Ganeti cluster configuration.
25

26
The configuration data is stored on every node but is updated on the master
27
only. After each update, the master distributes the data to the other nodes.
28

29
Currently, the data storage format is JSON. YAML was slow and consuming too
30
much memory.
31

32
"""
33

    
34
# pylint: disable-msg=R0904
35
# R0904: Too many public methods
36

    
37
import os
38
import random
39
import logging
40
import time
41

    
42
from ganeti import errors
43
from ganeti import locking
44
from ganeti import utils
45
from ganeti import constants
46
from ganeti import rpc
47
from ganeti import objects
48
from ganeti import serializer
49
from ganeti import uidpool
50
from ganeti import netutils
51
from ganeti import runtime
52

    
53

    
54
_config_lock = locking.SharedLock("ConfigWriter")
55

    
56
# job id used for resource management at config upgrade time
57
_UPGRADE_CONFIG_JID = "jid-cfg-upgrade"
58

    
59

    
60
def _ValidateConfig(data):
61
  """Verifies that a configuration objects looks valid.
62

63
  This only verifies the version of the configuration.
64

65
  @raise errors.ConfigurationError: if the version differs from what
66
      we expect
67

68
  """
69
  if data.version != constants.CONFIG_VERSION:
70
    raise errors.ConfigVersionMismatch(constants.CONFIG_VERSION, data.version)
71

    
72

    
73
class TemporaryReservationManager:
74
  """A temporary resource reservation manager.
75

76
  This is used to reserve resources in a job, before using them, making sure
77
  other jobs cannot get them in the meantime.
78

79
  """
80
  def __init__(self):
81
    self._ec_reserved = {}
82

    
83
  def Reserved(self, resource):
84
    for holder_reserved in self._ec_reserved.values():
85
      if resource in holder_reserved:
86
        return True
87
    return False
88

    
89
  def Reserve(self, ec_id, resource):
90
    if self.Reserved(resource):
91
      raise errors.ReservationError("Duplicate reservation for resource '%s'"
92
                                    % str(resource))
93
    if ec_id not in self._ec_reserved:
94
      self._ec_reserved[ec_id] = set([resource])
95
    else:
96
      self._ec_reserved[ec_id].add(resource)
97

    
98
  def DropECReservations(self, ec_id):
99
    if ec_id in self._ec_reserved:
100
      del self._ec_reserved[ec_id]
101

    
102
  def GetReserved(self):
103
    all_reserved = set()
104
    for holder_reserved in self._ec_reserved.values():
105
      all_reserved.update(holder_reserved)
106
    return all_reserved
107

    
108
  def Generate(self, existing, generate_one_fn, ec_id):
109
    """Generate a new resource of this type
110

111
    """
112
    assert callable(generate_one_fn)
113

    
114
    all_elems = self.GetReserved()
115
    all_elems.update(existing)
116
    retries = 64
117
    while retries > 0:
118
      new_resource = generate_one_fn()
119
      if new_resource is not None and new_resource not in all_elems:
120
        break
121
    else:
122
      raise errors.ConfigurationError("Not able generate new resource"
123
                                      " (last tried: %s)" % new_resource)
124
    self.Reserve(ec_id, new_resource)
125
    return new_resource
126

    
127

    
128
class ConfigWriter:
129
  """The interface to the cluster configuration.
130

131
  @ivar _temporary_lvs: reservation manager for temporary LVs
132
  @ivar _all_rms: a list of all temporary reservation managers
133

134
  """
135
  def __init__(self, cfg_file=None, offline=False, _getents=runtime.GetEnts,
136
               accept_foreign=False):
137
    self.write_count = 0
138
    self._lock = _config_lock
139
    self._config_data = None
140
    self._offline = offline
141
    if cfg_file is None:
142
      self._cfg_file = constants.CLUSTER_CONF_FILE
143
    else:
144
      self._cfg_file = cfg_file
145
    self._getents = _getents
146
    self._temporary_ids = TemporaryReservationManager()
147
    self._temporary_drbds = {}
148
    self._temporary_macs = TemporaryReservationManager()
149
    self._temporary_secrets = TemporaryReservationManager()
150
    self._temporary_lvs = TemporaryReservationManager()
151
    self._all_rms = [self._temporary_ids, self._temporary_macs,
152
                     self._temporary_secrets, self._temporary_lvs]
153
    # Note: in order to prevent errors when resolving our name in
154
    # _DistributeConfig, we compute it here once and reuse it; it's
155
    # better to raise an error before starting to modify the config
156
    # file than after it was modified
157
    self._my_hostname = netutils.Hostname.GetSysName()
158
    self._last_cluster_serial = -1
159
    self._cfg_id = None
160
    self._OpenConfig(accept_foreign)
161

    
162
  # this method needs to be static, so that we can call it on the class
163
  @staticmethod
164
  def IsCluster():
165
    """Check if the cluster is configured.
166

167
    """
168
    return os.path.exists(constants.CLUSTER_CONF_FILE)
169

    
170
  def _GenerateOneMAC(self):
171
    """Generate one mac address
172

173
    """
174
    prefix = self._config_data.cluster.mac_prefix
175
    byte1 = random.randrange(0, 256)
176
    byte2 = random.randrange(0, 256)
177
    byte3 = random.randrange(0, 256)
178
    mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
179
    return mac
180

    
181
  @locking.ssynchronized(_config_lock, shared=1)
182
  def GetNdParams(self, node):
183
    """Get the node params populated with cluster defaults.
184

185
    @type node: L{object.Node}
186
    @param node: The node we want to know the params for
187
    @return: A dict with the filled in node params
188

189
    """
190
    nodegroup = self._UnlockedGetNodeGroup(node.group)
191
    return self._config_data.cluster.FillND(node, nodegroup)
192

    
193
  @locking.ssynchronized(_config_lock, shared=1)
194
  def GenerateMAC(self, ec_id):
195
    """Generate a MAC for an instance.
196

197
    This should check the current instances for duplicates.
198

199
    """
200
    existing = self._AllMACs()
201
    return self._temporary_ids.Generate(existing, self._GenerateOneMAC, ec_id)
202

    
203
  @locking.ssynchronized(_config_lock, shared=1)
204
  def ReserveMAC(self, mac, ec_id):
205
    """Reserve a MAC for an instance.
206

207
    This only checks instances managed by this cluster, it does not
208
    check for potential collisions elsewhere.
209

210
    """
211
    all_macs = self._AllMACs()
212
    if mac in all_macs:
213
      raise errors.ReservationError("mac already in use")
214
    else:
215
      self._temporary_macs.Reserve(mac, ec_id)
216

    
217
  @locking.ssynchronized(_config_lock, shared=1)
218
  def ReserveLV(self, lv_name, ec_id):
219
    """Reserve an VG/LV pair for an instance.
220

221
    @type lv_name: string
222
    @param lv_name: the logical volume name to reserve
223

224
    """
225
    all_lvs = self._AllLVs()
226
    if lv_name in all_lvs:
227
      raise errors.ReservationError("LV already in use")
228
    else:
229
      self._temporary_lvs.Reserve(lv_name, ec_id)
230

    
231
  @locking.ssynchronized(_config_lock, shared=1)
232
  def GenerateDRBDSecret(self, ec_id):
233
    """Generate a DRBD secret.
234

235
    This checks the current disks for duplicates.
236

237
    """
238
    return self._temporary_secrets.Generate(self._AllDRBDSecrets(),
239
                                            utils.GenerateSecret,
240
                                            ec_id)
241

    
242
  def _AllLVs(self):
243
    """Compute the list of all LVs.
244

245
    """
246
    lvnames = set()
247
    for instance in self._config_data.instances.values():
248
      node_data = instance.MapLVsByNode()
249
      for lv_list in node_data.values():
250
        lvnames.update(lv_list)
251
    return lvnames
252

    
253
  def _AllIDs(self, include_temporary):
254
    """Compute the list of all UUIDs and names we have.
255

256
    @type include_temporary: boolean
257
    @param include_temporary: whether to include the _temporary_ids set
258
    @rtype: set
259
    @return: a set of IDs
260

261
    """
262
    existing = set()
263
    if include_temporary:
264
      existing.update(self._temporary_ids.GetReserved())
265
    existing.update(self._AllLVs())
266
    existing.update(self._config_data.instances.keys())
267
    existing.update(self._config_data.nodes.keys())
268
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
269
    return existing
270

    
271
  def _GenerateUniqueID(self, ec_id):
272
    """Generate an unique UUID.
273

274
    This checks the current node, instances and disk names for
275
    duplicates.
276

277
    @rtype: string
278
    @return: the unique id
279

280
    """
281
    existing = self._AllIDs(include_temporary=False)
282
    return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
283

    
284
  @locking.ssynchronized(_config_lock, shared=1)
285
  def GenerateUniqueID(self, ec_id):
286
    """Generate an unique ID.
287

288
    This is just a wrapper over the unlocked version.
289

290
    @type ec_id: string
291
    @param ec_id: unique id for the job to reserve the id to
292

293
    """
294
    return self._GenerateUniqueID(ec_id)
295

    
296
  def _AllMACs(self):
297
    """Return all MACs present in the config.
298

299
    @rtype: list
300
    @return: the list of all MACs
301

302
    """
303
    result = []
304
    for instance in self._config_data.instances.values():
305
      for nic in instance.nics:
306
        result.append(nic.mac)
307

    
308
    return result
309

    
310
  def _AllDRBDSecrets(self):
311
    """Return all DRBD secrets present in the config.
312

313
    @rtype: list
314
    @return: the list of all DRBD secrets
315

316
    """
317
    def helper(disk, result):
318
      """Recursively gather secrets from this disk."""
319
      if disk.dev_type == constants.DT_DRBD8:
320
        result.append(disk.logical_id[5])
321
      if disk.children:
322
        for child in disk.children:
323
          helper(child, result)
324

    
325
    result = []
326
    for instance in self._config_data.instances.values():
327
      for disk in instance.disks:
328
        helper(disk, result)
329

    
330
    return result
331

    
332
  def _CheckDiskIDs(self, disk, l_ids, p_ids):
333
    """Compute duplicate disk IDs
334

335
    @type disk: L{objects.Disk}
336
    @param disk: the disk at which to start searching
337
    @type l_ids: list
338
    @param l_ids: list of current logical ids
339
    @type p_ids: list
340
    @param p_ids: list of current physical ids
341
    @rtype: list
342
    @return: a list of error messages
343

344
    """
345
    result = []
346
    if disk.logical_id is not None:
347
      if disk.logical_id in l_ids:
348
        result.append("duplicate logical id %s" % str(disk.logical_id))
349
      else:
350
        l_ids.append(disk.logical_id)
351
    if disk.physical_id is not None:
352
      if disk.physical_id in p_ids:
353
        result.append("duplicate physical id %s" % str(disk.physical_id))
354
      else:
355
        p_ids.append(disk.physical_id)
356

    
357
    if disk.children:
358
      for child in disk.children:
359
        result.extend(self._CheckDiskIDs(child, l_ids, p_ids))
360
    return result
361

    
362
  def _UnlockedVerifyConfig(self):
363
    """Verify function.
364

365
    @rtype: list
366
    @return: a list of error messages; a non-empty list signifies
367
        configuration errors
368

369
    """
370
    result = []
371
    seen_macs = []
372
    ports = {}
373
    data = self._config_data
374
    seen_lids = []
375
    seen_pids = []
376

    
377
    # global cluster checks
378
    if not data.cluster.enabled_hypervisors:
379
      result.append("enabled hypervisors list doesn't have any entries")
380
    invalid_hvs = set(data.cluster.enabled_hypervisors) - constants.HYPER_TYPES
381
    if invalid_hvs:
382
      result.append("enabled hypervisors contains invalid entries: %s" %
383
                    invalid_hvs)
384
    missing_hvp = (set(data.cluster.enabled_hypervisors) -
385
                   set(data.cluster.hvparams.keys()))
386
    if missing_hvp:
387
      result.append("hypervisor parameters missing for the enabled"
388
                    " hypervisor(s) %s" % utils.CommaJoin(missing_hvp))
389

    
390
    if data.cluster.master_node not in data.nodes:
391
      result.append("cluster has invalid primary node '%s'" %
392
                    data.cluster.master_node)
393

    
394
    # per-instance checks
395
    for instance_name in data.instances:
396
      instance = data.instances[instance_name]
397
      if instance.name != instance_name:
398
        result.append("instance '%s' is indexed by wrong name '%s'" %
399
                      (instance.name, instance_name))
400
      if instance.primary_node not in data.nodes:
401
        result.append("instance '%s' has invalid primary node '%s'" %
402
                      (instance_name, instance.primary_node))
403
      for snode in instance.secondary_nodes:
404
        if snode not in data.nodes:
405
          result.append("instance '%s' has invalid secondary node '%s'" %
406
                        (instance_name, snode))
407
      for idx, nic in enumerate(instance.nics):
408
        if nic.mac in seen_macs:
409
          result.append("instance '%s' has NIC %d mac %s duplicate" %
410
                        (instance_name, idx, nic.mac))
411
        else:
412
          seen_macs.append(nic.mac)
413

    
414
      # gather the drbd ports for duplicate checks
415
      for dsk in instance.disks:
416
        if dsk.dev_type in constants.LDS_DRBD:
417
          tcp_port = dsk.logical_id[2]
418
          if tcp_port not in ports:
419
            ports[tcp_port] = []
420
          ports[tcp_port].append((instance.name, "drbd disk %s" % dsk.iv_name))
421
      # gather network port reservation
422
      net_port = getattr(instance, "network_port", None)
423
      if net_port is not None:
424
        if net_port not in ports:
425
          ports[net_port] = []
426
        ports[net_port].append((instance.name, "network port"))
427

    
428
      # instance disk verify
429
      for idx, disk in enumerate(instance.disks):
430
        result.extend(["instance '%s' disk %d error: %s" %
431
                       (instance.name, idx, msg) for msg in disk.Verify()])
432
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
433

    
434
    # cluster-wide pool of free ports
435
    for free_port in data.cluster.tcpudp_port_pool:
436
      if free_port not in ports:
437
        ports[free_port] = []
438
      ports[free_port].append(("cluster", "port marked as free"))
439

    
440
    # compute tcp/udp duplicate ports
441
    keys = ports.keys()
442
    keys.sort()
443
    for pnum in keys:
444
      pdata = ports[pnum]
445
      if len(pdata) > 1:
446
        txt = utils.CommaJoin(["%s/%s" % val for val in pdata])
447
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))
448

    
449
    # highest used tcp port check
450
    if keys:
451
      if keys[-1] > data.cluster.highest_used_port:
452
        result.append("Highest used port mismatch, saved %s, computed %s" %
453
                      (data.cluster.highest_used_port, keys[-1]))
454

    
455
    if not data.nodes[data.cluster.master_node].master_candidate:
456
      result.append("Master node is not a master candidate")
457

    
458
    # master candidate checks
459
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
460
    if mc_now < mc_max:
461
      result.append("Not enough master candidates: actual %d, target %d" %
462
                    (mc_now, mc_max))
463

    
464
    # node checks
465
    for node_name, node in data.nodes.items():
466
      if node.name != node_name:
467
        result.append("Node '%s' is indexed by wrong name '%s'" %
468
                      (node.name, node_name))
469
      if [node.master_candidate, node.drained, node.offline].count(True) > 1:
470
        result.append("Node %s state is invalid: master_candidate=%s,"
471
                      " drain=%s, offline=%s" %
472
                      (node.name, node.master_candidate, node.drained,
473
                       node.offline))
474

    
475
    # nodegroups checks
476
    nodegroups_names = set()
477
    for nodegroup_uuid in data.nodegroups:
478
      nodegroup = data.nodegroups[nodegroup_uuid]
479
      if nodegroup.uuid != nodegroup_uuid:
480
        result.append("node group '%s' (uuid: '%s') indexed by wrong uuid '%s'"
481
                      % (nodegroup.name, nodegroup.uuid, nodegroup_uuid))
482
      if utils.UUID_RE.match(nodegroup.name.lower()):
483
        result.append("node group '%s' (uuid: '%s') has uuid-like name" %
484
                      (nodegroup.name, nodegroup.uuid))
485
      if nodegroup.name in nodegroups_names:
486
        result.append("duplicate node group name '%s'" % nodegroup.name)
487
      else:
488
        nodegroups_names.add(nodegroup.name)
489

    
490
    # drbd minors check
491
    _, duplicates = self._UnlockedComputeDRBDMap()
492
    for node, minor, instance_a, instance_b in duplicates:
493
      result.append("DRBD minor %d on node %s is assigned twice to instances"
494
                    " %s and %s" % (minor, node, instance_a, instance_b))
495

    
496
    # IP checks
497
    default_nicparams = data.cluster.nicparams[constants.PP_DEFAULT]
498
    ips = {}
499

    
500
    def _AddIpAddress(ip, name):
501
      ips.setdefault(ip, []).append(name)
502

    
503
    _AddIpAddress(data.cluster.master_ip, "cluster_ip")
504

    
505
    for node in data.nodes.values():
506
      _AddIpAddress(node.primary_ip, "node:%s/primary" % node.name)
507
      if node.secondary_ip != node.primary_ip:
508
        _AddIpAddress(node.secondary_ip, "node:%s/secondary" % node.name)
509

    
510
    for instance in data.instances.values():
511
      for idx, nic in enumerate(instance.nics):
512
        if nic.ip is None:
513
          continue
514

    
515
        nicparams = objects.FillDict(default_nicparams, nic.nicparams)
516
        nic_mode = nicparams[constants.NIC_MODE]
517
        nic_link = nicparams[constants.NIC_LINK]
518

    
519
        if nic_mode == constants.NIC_MODE_BRIDGED:
520
          link = "bridge:%s" % nic_link
521
        elif nic_mode == constants.NIC_MODE_ROUTED:
522
          link = "route:%s" % nic_link
523
        else:
524
          raise errors.ProgrammerError("NIC mode '%s' not handled" % nic_mode)
525

    
526
        _AddIpAddress("%s/%s" % (link, nic.ip),
527
                      "instance:%s/nic:%d" % (instance.name, idx))
528

    
529
    for ip, owners in ips.items():
530
      if len(owners) > 1:
531
        result.append("IP address %s is used by multiple owners: %s" %
532
                      (ip, utils.CommaJoin(owners)))
533

    
534
    return result
535

    
536
  @locking.ssynchronized(_config_lock, shared=1)
537
  def VerifyConfig(self):
538
    """Verify function.
539

540
    This is just a wrapper over L{_UnlockedVerifyConfig}.
541

542
    @rtype: list
543
    @return: a list of error messages; a non-empty list signifies
544
        configuration errors
545

546
    """
547
    return self._UnlockedVerifyConfig()
548

    
549
  def _UnlockedSetDiskID(self, disk, node_name):
550
    """Convert the unique ID to the ID needed on the target nodes.
551

552
    This is used only for drbd, which needs ip/port configuration.
553

554
    The routine descends down and updates its children also, because
555
    this helps when the only the top device is passed to the remote
556
    node.
557

558
    This function is for internal use, when the config lock is already held.
559

560
    """
561
    if disk.children:
562
      for child in disk.children:
563
        self._UnlockedSetDiskID(child, node_name)
564

    
565
    if disk.logical_id is None and disk.physical_id is not None:
566
      return
567
    if disk.dev_type == constants.LD_DRBD8:
568
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
569
      if node_name not in (pnode, snode):
570
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
571
                                        node_name)
572
      pnode_info = self._UnlockedGetNodeInfo(pnode)
573
      snode_info = self._UnlockedGetNodeInfo(snode)
574
      if pnode_info is None or snode_info is None:
575
        raise errors.ConfigurationError("Can't find primary or secondary node"
576
                                        " for %s" % str(disk))
577
      p_data = (pnode_info.secondary_ip, port)
578
      s_data = (snode_info.secondary_ip, port)
579
      if pnode == node_name:
580
        disk.physical_id = p_data + s_data + (pminor, secret)
581
      else: # it must be secondary, we tested above
582
        disk.physical_id = s_data + p_data + (sminor, secret)
583
    else:
584
      disk.physical_id = disk.logical_id
585
    return
586

    
587
  @locking.ssynchronized(_config_lock)
588
  def SetDiskID(self, disk, node_name):
589
    """Convert the unique ID to the ID needed on the target nodes.
590

591
    This is used only for drbd, which needs ip/port configuration.
592

593
    The routine descends down and updates its children also, because
594
    this helps when the only the top device is passed to the remote
595
    node.
596

597
    """
598
    return self._UnlockedSetDiskID(disk, node_name)
599

    
600
  @locking.ssynchronized(_config_lock)
601
  def AddTcpUdpPort(self, port):
602
    """Adds a new port to the available port pool.
603

604
    """
605
    if not isinstance(port, int):
606
      raise errors.ProgrammerError("Invalid type passed for port")
607

    
608
    self._config_data.cluster.tcpudp_port_pool.add(port)
609
    self._WriteConfig()
610

    
611
  @locking.ssynchronized(_config_lock, shared=1)
612
  def GetPortList(self):
613
    """Returns a copy of the current port list.
614

615
    """
616
    return self._config_data.cluster.tcpudp_port_pool.copy()
617

    
618
  @locking.ssynchronized(_config_lock)
619
  def AllocatePort(self):
620
    """Allocate a port.
621

622
    The port will be taken from the available port pool or from the
623
    default port range (and in this case we increase
624
    highest_used_port).
625

626
    """
627
    # If there are TCP/IP ports configured, we use them first.
628
    if self._config_data.cluster.tcpudp_port_pool:
629
      port = self._config_data.cluster.tcpudp_port_pool.pop()
630
    else:
631
      port = self._config_data.cluster.highest_used_port + 1
632
      if port >= constants.LAST_DRBD_PORT:
633
        raise errors.ConfigurationError("The highest used port is greater"
634
                                        " than %s. Aborting." %
635
                                        constants.LAST_DRBD_PORT)
636
      self._config_data.cluster.highest_used_port = port
637

    
638
    self._WriteConfig()
639
    return port
640

    
641
  def _UnlockedComputeDRBDMap(self):
642
    """Compute the used DRBD minor/nodes.
643

644
    @rtype: (dict, list)
645
    @return: dictionary of node_name: dict of minor: instance_name;
646
        the returned dict will have all the nodes in it (even if with
647
        an empty list), and a list of duplicates; if the duplicates
648
        list is not empty, the configuration is corrupted and its caller
649
        should raise an exception
650

651
    """
652
    def _AppendUsedPorts(instance_name, disk, used):
653
      duplicates = []
654
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
655
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
656
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
657
          assert node in used, ("Node '%s' of instance '%s' not found"
658
                                " in node list" % (node, instance_name))
659
          if port in used[node]:
660
            duplicates.append((node, port, instance_name, used[node][port]))
661
          else:
662
            used[node][port] = instance_name
663
      if disk.children:
664
        for child in disk.children:
665
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
666
      return duplicates
667

    
668
    duplicates = []
669
    my_dict = dict((node, {}) for node in self._config_data.nodes)
670
    for instance in self._config_data.instances.itervalues():
671
      for disk in instance.disks:
672
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
673
    for (node, minor), instance in self._temporary_drbds.iteritems():
674
      if minor in my_dict[node] and my_dict[node][minor] != instance:
675
        duplicates.append((node, minor, instance, my_dict[node][minor]))
676
      else:
677
        my_dict[node][minor] = instance
678
    return my_dict, duplicates
679

    
680
  @locking.ssynchronized(_config_lock)
681
  def ComputeDRBDMap(self):
682
    """Compute the used DRBD minor/nodes.
683

684
    This is just a wrapper over L{_UnlockedComputeDRBDMap}.
685

686
    @return: dictionary of node_name: dict of minor: instance_name;
687
        the returned dict will have all the nodes in it (even if with
688
        an empty list).
689

690
    """
691
    d_map, duplicates = self._UnlockedComputeDRBDMap()
692
    if duplicates:
693
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
694
                                      str(duplicates))
695
    return d_map
696

    
697
  @locking.ssynchronized(_config_lock)
698
  def AllocateDRBDMinor(self, nodes, instance):
699
    """Allocate a drbd minor.
700

701
    The free minor will be automatically computed from the existing
702
    devices. A node can be given multiple times in order to allocate
703
    multiple minors. The result is the list of minors, in the same
704
    order as the passed nodes.
705

706
    @type instance: string
707
    @param instance: the instance for which we allocate minors
708

709
    """
710
    assert isinstance(instance, basestring), \
711
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
712

    
713
    d_map, duplicates = self._UnlockedComputeDRBDMap()
714
    if duplicates:
715
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
716
                                      str(duplicates))
717
    result = []
718
    for nname in nodes:
719
      ndata = d_map[nname]
720
      if not ndata:
721
        # no minors used, we can start at 0
722
        result.append(0)
723
        ndata[0] = instance
724
        self._temporary_drbds[(nname, 0)] = instance
725
        continue
726
      keys = ndata.keys()
727
      keys.sort()
728
      ffree = utils.FirstFree(keys)
729
      if ffree is None:
730
        # return the next minor
731
        # TODO: implement high-limit check
732
        minor = keys[-1] + 1
733
      else:
734
        minor = ffree
735
      # double-check minor against current instances
736
      assert minor not in d_map[nname], \
737
             ("Attempt to reuse allocated DRBD minor %d on node %s,"
738
              " already allocated to instance %s" %
739
              (minor, nname, d_map[nname][minor]))
740
      ndata[minor] = instance
741
      # double-check minor against reservation
742
      r_key = (nname, minor)
743
      assert r_key not in self._temporary_drbds, \
744
             ("Attempt to reuse reserved DRBD minor %d on node %s,"
745
              " reserved for instance %s" %
746
              (minor, nname, self._temporary_drbds[r_key]))
747
      self._temporary_drbds[r_key] = instance
748
      result.append(minor)
749
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
750
                  nodes, result)
751
    return result
752

    
753
  def _UnlockedReleaseDRBDMinors(self, instance):
754
    """Release temporary drbd minors allocated for a given instance.
755

756
    @type instance: string
757
    @param instance: the instance for which temporary minors should be
758
                     released
759

760
    """
761
    assert isinstance(instance, basestring), \
762
           "Invalid argument passed to ReleaseDRBDMinors"
763
    for key, name in self._temporary_drbds.items():
764
      if name == instance:
765
        del self._temporary_drbds[key]
766

    
767
  @locking.ssynchronized(_config_lock)
768
  def ReleaseDRBDMinors(self, instance):
769
    """Release temporary drbd minors allocated for a given instance.
770

771
    This should be called on the error paths, on the success paths
772
    it's automatically called by the ConfigWriter add and update
773
    functions.
774

775
    This function is just a wrapper over L{_UnlockedReleaseDRBDMinors}.
776

777
    @type instance: string
778
    @param instance: the instance for which temporary minors should be
779
                     released
780

781
    """
782
    self._UnlockedReleaseDRBDMinors(instance)
783

    
784
  @locking.ssynchronized(_config_lock, shared=1)
785
  def GetConfigVersion(self):
786
    """Get the configuration version.
787

788
    @return: Config version
789

790
    """
791
    return self._config_data.version
792

    
793
  @locking.ssynchronized(_config_lock, shared=1)
794
  def GetClusterName(self):
795
    """Get cluster name.
796

797
    @return: Cluster name
798

799
    """
800
    return self._config_data.cluster.cluster_name
801

    
802
  @locking.ssynchronized(_config_lock, shared=1)
803
  def GetMasterNode(self):
804
    """Get the hostname of the master node for this cluster.
805

806
    @return: Master hostname
807

808
    """
809
    return self._config_data.cluster.master_node
810

    
811
  @locking.ssynchronized(_config_lock, shared=1)
812
  def GetMasterIP(self):
813
    """Get the IP of the master node for this cluster.
814

815
    @return: Master IP
816

817
    """
818
    return self._config_data.cluster.master_ip
819

    
820
  @locking.ssynchronized(_config_lock, shared=1)
821
  def GetMasterNetdev(self):
822
    """Get the master network device for this cluster.
823

824
    """
825
    return self._config_data.cluster.master_netdev
826

    
827
  @locking.ssynchronized(_config_lock, shared=1)
828
  def GetFileStorageDir(self):
829
    """Get the file storage dir for this cluster.
830

831
    """
832
    return self._config_data.cluster.file_storage_dir
833

    
834
  @locking.ssynchronized(_config_lock, shared=1)
835
  def GetHypervisorType(self):
836
    """Get the hypervisor type for this cluster.
837

838
    """
839
    return self._config_data.cluster.enabled_hypervisors[0]
840

    
841
  @locking.ssynchronized(_config_lock, shared=1)
842
  def GetHostKey(self):
843
    """Return the rsa hostkey from the config.
844

845
    @rtype: string
846
    @return: the rsa hostkey
847

848
    """
849
    return self._config_data.cluster.rsahostkeypub
850

    
851
  @locking.ssynchronized(_config_lock, shared=1)
852
  def GetDefaultIAllocator(self):
853
    """Get the default instance allocator for this cluster.
854

855
    """
856
    return self._config_data.cluster.default_iallocator
857

    
858
  @locking.ssynchronized(_config_lock, shared=1)
859
  def GetPrimaryIPFamily(self):
860
    """Get cluster primary ip family.
861

862
    @return: primary ip family
863

864
    """
865
    return self._config_data.cluster.primary_ip_family
866

    
867
  @locking.ssynchronized(_config_lock)
868
  def AddNodeGroup(self, group, ec_id, check_uuid=True):
869
    """Add a node group to the configuration.
870

871
    @type group: L{objects.NodeGroup}
872
    @param group: the NodeGroup object to add
873
    @type ec_id: string
874
    @param ec_id: unique id for the job to use when creating a missing UUID
875
    @type check_uuid: bool
876
    @param check_uuid: add an UUID to the group if it doesn't have one or, if
877
                       it does, ensure that it does not exist in the
878
                       configuration already
879

880
    """
881
    self._UnlockedAddNodeGroup(group, ec_id, check_uuid)
882
    self._WriteConfig()
883

    
884
  def _UnlockedAddNodeGroup(self, group, ec_id, check_uuid):
885
    """Add a node group to the configuration.
886

887
    """
888
    logging.info("Adding node group %s to configuration", group.name)
889

    
890
    # Some code might need to add a node group with a pre-populated UUID
891
    # generated with ConfigWriter.GenerateUniqueID(). We allow them to bypass
892
    # the "does this UUID" exist already check.
893
    if check_uuid:
894
      self._EnsureUUID(group, ec_id)
895

    
896
    group.serial_no = 1
897
    group.ctime = group.mtime = time.time()
898

    
899
    self._config_data.nodegroups[group.uuid] = group
900
    self._config_data.cluster.serial_no += 1
901

    
902
  @locking.ssynchronized(_config_lock)
903
  def RemoveNodeGroup(self, group_uuid):
904
    """Remove a node group from the configuration.
905

906
    @type group_uuid: string
907
    @param group_uuid: the UUID of the node group to remove
908

909
    """
910
    logging.info("Removing node group %s from configuration", group_uuid)
911

    
912
    if group_uuid not in self._config_data.nodegroups:
913
      raise errors.ConfigurationError("Unknown node group '%s'" % group_uuid)
914

    
915
    del self._config_data.nodegroups[group_uuid]
916
    self._config_data.cluster.serial_no += 1
917
    self._WriteConfig()
918

    
919
  @locking.ssynchronized(_config_lock, shared=1)
920
  def LookupNodeGroup(self, target):
921
    """Lookup a node group's UUID.
922

923
    @type target: string or None
924
    @param target: group name or UUID or None to look for the default
925
    @rtype: string
926
    @return: nodegroup UUID
927
    @raises errors.OpPrereqError: when the target group cannot be found
928

929
    """
930
    if target is None:
931
      if len(self._config_data.nodegroups) != 1:
932
        raise errors.OpPrereqError("More than one node group exists. Target"
933
                                   " group must be specified explicitely.")
934
      else:
935
        return self._config_data.nodegroups.keys()[0]
936
    if target in self._config_data.nodegroups:
937
      return target
938
    for nodegroup in self._config_data.nodegroups.values():
939
      if nodegroup.name == target:
940
        return nodegroup.uuid
941
    raise errors.OpPrereqError("Node group '%s' not found" % target,
942
                               errors.ECODE_NOENT)
943

    
944
  def _UnlockedGetNodeGroup(self, uuid):
945
    """Lookup a node group.
946

947
    @type uuid: string
948
    @param uuid: group UUID
949
    @rtype: L{objects.NodeGroup} or None
950
    @return: nodegroup object, or None if not found
951

952
    """
953
    if uuid not in self._config_data.nodegroups:
954
      return None
955

    
956
    return self._config_data.nodegroups[uuid]
957

    
958
  @locking.ssynchronized(_config_lock, shared=1)
959
  def GetNodeGroup(self, uuid):
960
    """Lookup a node group.
961

962
    @type uuid: string
963
    @param uuid: group UUID
964
    @rtype: L{objects.NodeGroup} or None
965
    @return: nodegroup object, or None if not found
966

967
    """
968
    return self._UnlockedGetNodeGroup(uuid)
969

    
970
  @locking.ssynchronized(_config_lock, shared=1)
971
  def GetAllNodeGroupsInfo(self):
972
    """Get the configuration of all node groups.
973

974
    """
975
    return dict(self._config_data.nodegroups)
976

    
977
  @locking.ssynchronized(_config_lock, shared=1)
978
  def GetNodeGroupList(self):
979
    """Get a list of node groups.
980

981
    """
982
    return self._config_data.nodegroups.keys()
983

    
984
  @locking.ssynchronized(_config_lock)
985
  def AddInstance(self, instance, ec_id):
986
    """Add an instance to the config.
987

988
    This should be used after creating a new instance.
989

990
    @type instance: L{objects.Instance}
991
    @param instance: the instance object
992

993
    """
994
    if not isinstance(instance, objects.Instance):
995
      raise errors.ProgrammerError("Invalid type passed to AddInstance")
996

    
997
    if instance.disk_template != constants.DT_DISKLESS:
998
      all_lvs = instance.MapLVsByNode()
999
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
1000

    
1001
    all_macs = self._AllMACs()
1002
    for nic in instance.nics:
1003
      if nic.mac in all_macs:
1004
        raise errors.ConfigurationError("Cannot add instance %s:"
1005
                                        " MAC address '%s' already in use." %
1006
                                        (instance.name, nic.mac))
1007

    
1008
    self._EnsureUUID(instance, ec_id)
1009

    
1010
    instance.serial_no = 1
1011
    instance.ctime = instance.mtime = time.time()
1012
    self._config_data.instances[instance.name] = instance
1013
    self._config_data.cluster.serial_no += 1
1014
    self._UnlockedReleaseDRBDMinors(instance.name)
1015
    self._WriteConfig()
1016

    
1017
  def _EnsureUUID(self, item, ec_id):
1018
    """Ensures a given object has a valid UUID.
1019

1020
    @param item: the instance or node to be checked
1021
    @param ec_id: the execution context id for the uuid reservation
1022

1023
    """
1024
    if not item.uuid:
1025
      item.uuid = self._GenerateUniqueID(ec_id)
1026
    elif item.uuid in self._AllIDs(include_temporary=True):
1027
      raise errors.ConfigurationError("Cannot add '%s': UUID %s already"
1028
                                      " in use" % (item.name, item.uuid))
1029

    
1030
  def _SetInstanceStatus(self, instance_name, status):
1031
    """Set the instance's status to a given value.
1032

1033
    """
1034
    assert isinstance(status, bool), \
1035
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
1036

    
1037
    if instance_name not in self._config_data.instances:
1038
      raise errors.ConfigurationError("Unknown instance '%s'" %
1039
                                      instance_name)
1040
    instance = self._config_data.instances[instance_name]
1041
    if instance.admin_up != status:
1042
      instance.admin_up = status
1043
      instance.serial_no += 1
1044
      instance.mtime = time.time()
1045
      self._WriteConfig()
1046

    
1047
  @locking.ssynchronized(_config_lock)
1048
  def MarkInstanceUp(self, instance_name):
1049
    """Mark the instance status to up in the config.
1050

1051
    """
1052
    self._SetInstanceStatus(instance_name, True)
1053

    
1054
  @locking.ssynchronized(_config_lock)
1055
  def RemoveInstance(self, instance_name):
1056
    """Remove the instance from the configuration.
1057

1058
    """
1059
    if instance_name not in self._config_data.instances:
1060
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
1061
    del self._config_data.instances[instance_name]
1062
    self._config_data.cluster.serial_no += 1
1063
    self._WriteConfig()
1064

    
1065
  @locking.ssynchronized(_config_lock)
1066
  def RenameInstance(self, old_name, new_name):
1067
    """Rename an instance.
1068

1069
    This needs to be done in ConfigWriter and not by RemoveInstance
1070
    combined with AddInstance as only we can guarantee an atomic
1071
    rename.
1072

1073
    """
1074
    if old_name not in self._config_data.instances:
1075
      raise errors.ConfigurationError("Unknown instance '%s'" % old_name)
1076
    inst = self._config_data.instances[old_name]
1077
    del self._config_data.instances[old_name]
1078
    inst.name = new_name
1079

    
1080
    for disk in inst.disks:
1081
      if disk.dev_type == constants.LD_FILE:
1082
        # rename the file paths in logical and physical id
1083
        file_storage_dir = os.path.dirname(os.path.dirname(disk.logical_id[1]))
1084
        disk.physical_id = disk.logical_id = (disk.logical_id[0],
1085
                                              utils.PathJoin(file_storage_dir,
1086
                                                             inst.name,
1087
                                                             disk.iv_name))
1088

    
1089
    # Force update of ssconf files
1090
    self._config_data.cluster.serial_no += 1
1091

    
1092
    self._config_data.instances[inst.name] = inst
1093
    self._WriteConfig()
1094

    
1095
  @locking.ssynchronized(_config_lock)
1096
  def MarkInstanceDown(self, instance_name):
1097
    """Mark the status of an instance to down in the configuration.
1098

1099
    """
1100
    self._SetInstanceStatus(instance_name, False)
1101

    
1102
  def _UnlockedGetInstanceList(self):
1103
    """Get the list of instances.
1104

1105
    This function is for internal use, when the config lock is already held.
1106

1107
    """
1108
    return self._config_data.instances.keys()
1109

    
1110
  @locking.ssynchronized(_config_lock, shared=1)
1111
  def GetInstanceList(self):
1112
    """Get the list of instances.
1113

1114
    @return: array of instances, ex. ['instance2.example.com',
1115
        'instance1.example.com']
1116

1117
    """
1118
    return self._UnlockedGetInstanceList()
1119

    
1120
  @locking.ssynchronized(_config_lock, shared=1)
1121
  def ExpandInstanceName(self, short_name):
1122
    """Attempt to expand an incomplete instance name.
1123

1124
    """
1125
    return utils.MatchNameComponent(short_name,
1126
                                    self._config_data.instances.keys(),
1127
                                    case_sensitive=False)
1128

    
1129
  def _UnlockedGetInstanceInfo(self, instance_name):
1130
    """Returns information about an instance.
1131

1132
    This function is for internal use, when the config lock is already held.
1133

1134
    """
1135
    if instance_name not in self._config_data.instances:
1136
      return None
1137

    
1138
    return self._config_data.instances[instance_name]
1139

    
1140
  @locking.ssynchronized(_config_lock, shared=1)
1141
  def GetInstanceInfo(self, instance_name):
1142
    """Returns information about an instance.
1143

1144
    It takes the information from the configuration file. Other information of
1145
    an instance are taken from the live systems.
1146

1147
    @param instance_name: name of the instance, e.g.
1148
        I{instance1.example.com}
1149

1150
    @rtype: L{objects.Instance}
1151
    @return: the instance object
1152

1153
    """
1154
    return self._UnlockedGetInstanceInfo(instance_name)
1155

    
1156
  @locking.ssynchronized(_config_lock, shared=1)
1157
  def GetAllInstancesInfo(self):
1158
    """Get the configuration of all instances.
1159

1160
    @rtype: dict
1161
    @return: dict of (instance, instance_info), where instance_info is what
1162
              would GetInstanceInfo return for the node
1163

1164
    """
1165
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
1166
                    for instance in self._UnlockedGetInstanceList()])
1167
    return my_dict
1168

    
1169
  @locking.ssynchronized(_config_lock)
1170
  def AddNode(self, node, ec_id):
1171
    """Add a node to the configuration.
1172

1173
    @type node: L{objects.Node}
1174
    @param node: a Node instance
1175

1176
    """
1177
    logging.info("Adding node %s to configuration", node.name)
1178

    
1179
    self._EnsureUUID(node, ec_id)
1180

    
1181
    node.serial_no = 1
1182
    node.ctime = node.mtime = time.time()
1183
    self._UnlockedAddNodeToGroup(node.name, node.group)
1184
    self._config_data.nodes[node.name] = node
1185
    self._config_data.cluster.serial_no += 1
1186
    self._WriteConfig()
1187

    
1188
  @locking.ssynchronized(_config_lock)
1189
  def RemoveNode(self, node_name):
1190
    """Remove a node from the configuration.
1191

1192
    """
1193
    logging.info("Removing node %s from configuration", node_name)
1194

    
1195
    if node_name not in self._config_data.nodes:
1196
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
1197

    
1198
    self._UnlockedRemoveNodeFromGroup(self._config_data.nodes[node_name])
1199
    del self._config_data.nodes[node_name]
1200
    self._config_data.cluster.serial_no += 1
1201
    self._WriteConfig()
1202

    
1203
  @locking.ssynchronized(_config_lock, shared=1)
1204
  def ExpandNodeName(self, short_name):
1205
    """Attempt to expand an incomplete instance name.
1206

1207
    """
1208
    return utils.MatchNameComponent(short_name,
1209
                                    self._config_data.nodes.keys(),
1210
                                    case_sensitive=False)
1211

    
1212
  def _UnlockedGetNodeInfo(self, node_name):
1213
    """Get the configuration of a node, as stored in the config.
1214

1215
    This function is for internal use, when the config lock is already
1216
    held.
1217

1218
    @param node_name: the node name, e.g. I{node1.example.com}
1219

1220
    @rtype: L{objects.Node}
1221
    @return: the node object
1222

1223
    """
1224
    if node_name not in self._config_data.nodes:
1225
      return None
1226

    
1227
    return self._config_data.nodes[node_name]
1228

    
1229
  @locking.ssynchronized(_config_lock, shared=1)
1230
  def GetNodeInfo(self, node_name):
1231
    """Get the configuration of a node, as stored in the config.
1232

1233
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
1234

1235
    @param node_name: the node name, e.g. I{node1.example.com}
1236

1237
    @rtype: L{objects.Node}
1238
    @return: the node object
1239

1240
    """
1241
    return self._UnlockedGetNodeInfo(node_name)
1242

    
1243
  @locking.ssynchronized(_config_lock, shared=1)
1244
  def GetNodeInstances(self, node_name):
1245
    """Get the instances of a node, as stored in the config.
1246

1247
    @param node_name: the node name, e.g. I{node1.example.com}
1248

1249
    @rtype: (list, list)
1250
    @return: a tuple with two lists: the primary and the secondary instances
1251

1252
    """
1253
    pri = []
1254
    sec = []
1255
    for inst in self._config_data.instances.values():
1256
      if inst.primary_node == node_name:
1257
        pri.append(inst.name)
1258
      if node_name in inst.secondary_nodes:
1259
        sec.append(inst.name)
1260
    return (pri, sec)
1261

    
1262
  def _UnlockedGetNodeList(self):
1263
    """Return the list of nodes which are in the configuration.
1264

1265
    This function is for internal use, when the config lock is already
1266
    held.
1267

1268
    @rtype: list
1269

1270
    """
1271
    return self._config_data.nodes.keys()
1272

    
1273
  @locking.ssynchronized(_config_lock, shared=1)
1274
  def GetNodeList(self):
1275
    """Return the list of nodes which are in the configuration.
1276

1277
    """
1278
    return self._UnlockedGetNodeList()
1279

    
1280
  def _UnlockedGetOnlineNodeList(self):
1281
    """Return the list of nodes which are online.
1282

1283
    """
1284
    all_nodes = [self._UnlockedGetNodeInfo(node)
1285
                 for node in self._UnlockedGetNodeList()]
1286
    return [node.name for node in all_nodes if not node.offline]
1287

    
1288
  @locking.ssynchronized(_config_lock, shared=1)
1289
  def GetOnlineNodeList(self):
1290
    """Return the list of nodes which are online.
1291

1292
    """
1293
    return self._UnlockedGetOnlineNodeList()
1294

    
1295
  @locking.ssynchronized(_config_lock, shared=1)
1296
  def GetNonVmCapableNodeList(self):
1297
    """Return the list of nodes which are not vm capable.
1298

1299
    """
1300
    all_nodes = [self._UnlockedGetNodeInfo(node)
1301
                 for node in self._UnlockedGetNodeList()]
1302
    return [node.name for node in all_nodes if not node.vm_capable]
1303

    
1304
  @locking.ssynchronized(_config_lock, shared=1)
1305
  def GetAllNodesInfo(self):
1306
    """Get the configuration of all nodes.
1307

1308
    @rtype: dict
1309
    @return: dict of (node, node_info), where node_info is what
1310
              would GetNodeInfo return for the node
1311

1312
    """
1313
    my_dict = dict([(node, self._UnlockedGetNodeInfo(node))
1314
                    for node in self._UnlockedGetNodeList()])
1315
    return my_dict
1316

    
1317
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1318
    """Get the number of current and maximum desired and possible candidates.
1319

1320
    @type exceptions: list
1321
    @param exceptions: if passed, list of nodes that should be ignored
1322
    @rtype: tuple
1323
    @return: tuple of (current, desired and possible, possible)
1324

1325
    """
1326
    mc_now = mc_should = mc_max = 0
1327
    for node in self._config_data.nodes.values():
1328
      if exceptions and node.name in exceptions:
1329
        continue
1330
      if not (node.offline or node.drained) and node.master_capable:
1331
        mc_max += 1
1332
      if node.master_candidate:
1333
        mc_now += 1
1334
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
1335
    return (mc_now, mc_should, mc_max)
1336

    
1337
  @locking.ssynchronized(_config_lock, shared=1)
1338
  def GetMasterCandidateStats(self, exceptions=None):
1339
    """Get the number of current and maximum possible candidates.
1340

1341
    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.
1342

1343
    @type exceptions: list
1344
    @param exceptions: if passed, list of nodes that should be ignored
1345
    @rtype: tuple
1346
    @return: tuple of (current, max)
1347

1348
    """
1349
    return self._UnlockedGetMasterCandidateStats(exceptions)
1350

    
1351
  @locking.ssynchronized(_config_lock)
1352
  def MaintainCandidatePool(self, exceptions):
1353
    """Try to grow the candidate pool to the desired size.
1354

1355
    @type exceptions: list
1356
    @param exceptions: if passed, list of nodes that should be ignored
1357
    @rtype: list
1358
    @return: list with the adjusted nodes (L{objects.Node} instances)
1359

1360
    """
1361
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1362
    mod_list = []
1363
    if mc_now < mc_max:
1364
      node_list = self._config_data.nodes.keys()
1365
      random.shuffle(node_list)
1366
      for name in node_list:
1367
        if mc_now >= mc_max:
1368
          break
1369
        node = self._config_data.nodes[name]
1370
        if (node.master_candidate or node.offline or node.drained or
1371
            node.name in exceptions or not node.master_capable):
1372
          continue
1373
        mod_list.append(node)
1374
        node.master_candidate = True
1375
        node.serial_no += 1
1376
        mc_now += 1
1377
      if mc_now != mc_max:
1378
        # this should not happen
1379
        logging.warning("Warning: MaintainCandidatePool didn't manage to"
1380
                        " fill the candidate pool (%d/%d)", mc_now, mc_max)
1381
      if mod_list:
1382
        self._config_data.cluster.serial_no += 1
1383
        self._WriteConfig()
1384

    
1385
    return mod_list
1386

    
1387
  def _UnlockedAddNodeToGroup(self, node_name, nodegroup_uuid):
1388
    """Add a given node to the specified group.
1389

1390
    """
1391
    if nodegroup_uuid not in self._config_data.nodegroups:
1392
      # This can happen if a node group gets deleted between its lookup and
1393
      # when we're adding the first node to it, since we don't keep a lock in
1394
      # the meantime. It's ok though, as we'll fail cleanly if the node group
1395
      # is not found anymore.
1396
      raise errors.OpExecError("Unknown node group: %s" % nodegroup_uuid)
1397
    if node_name not in self._config_data.nodegroups[nodegroup_uuid].members:
1398
      self._config_data.nodegroups[nodegroup_uuid].members.append(node_name)
1399

    
1400
  def _UnlockedRemoveNodeFromGroup(self, node):
1401
    """Remove a given node from its group.
1402

1403
    """
1404
    nodegroup = node.group
1405
    if nodegroup not in self._config_data.nodegroups:
1406
      logging.warning("Warning: node '%s' has unknown node group '%s'"
1407
                      " (while being removed from it)", node.name, nodegroup)
1408
    nodegroup_obj = self._config_data.nodegroups[nodegroup]
1409
    if node.name not in nodegroup_obj.members:
1410
      logging.warning("Warning: node '%s' not a member of its node group '%s'"
1411
                      " (while being removed from it)", node.name, nodegroup)
1412
    else:
1413
      nodegroup_obj.members.remove(node.name)
1414

    
1415
  def _BumpSerialNo(self):
1416
    """Bump up the serial number of the config.
1417

1418
    """
1419
    self._config_data.serial_no += 1
1420
    self._config_data.mtime = time.time()
1421

    
1422
  def _AllUUIDObjects(self):
1423
    """Returns all objects with uuid attributes.
1424

1425
    """
1426
    return (self._config_data.instances.values() +
1427
            self._config_data.nodes.values() +
1428
            self._config_data.nodegroups.values() +
1429
            [self._config_data.cluster])
1430

    
1431
  def _OpenConfig(self, accept_foreign):
1432
    """Read the config data from disk.
1433

1434
    """
1435
    raw_data = utils.ReadFile(self._cfg_file)
1436

    
1437
    try:
1438
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
1439
    except Exception, err:
1440
      raise errors.ConfigurationError(err)
1441

    
1442
    # Make sure the configuration has the right version
1443
    _ValidateConfig(data)
1444

    
1445
    if (not hasattr(data, 'cluster') or
1446
        not hasattr(data.cluster, 'rsahostkeypub')):
1447
      raise errors.ConfigurationError("Incomplete configuration"
1448
                                      " (missing cluster.rsahostkeypub)")
1449

    
1450
    if data.cluster.master_node != self._my_hostname and not accept_foreign:
1451
      msg = ("The configuration denotes node %s as master, while my"
1452
             " hostname is %s; opening a foreign configuration is only"
1453
             " possible in accept_foreign mode" %
1454
             (data.cluster.master_node, self._my_hostname))
1455
      raise errors.ConfigurationError(msg)
1456

    
1457
    # Upgrade configuration if needed
1458
    data.UpgradeConfig()
1459

    
1460
    self._config_data = data
1461
    # reset the last serial as -1 so that the next write will cause
1462
    # ssconf update
1463
    self._last_cluster_serial = -1
1464

    
1465
    # And finally run our (custom) config upgrade sequence
1466
    self._UpgradeConfig()
1467

    
1468
    self._cfg_id = utils.GetFileID(path=self._cfg_file)
1469

    
1470
  def _UpgradeConfig(self):
1471
    """Run upgrade steps that cannot be done purely in the objects.
1472

1473
    This is because some data elements need uniqueness across the
1474
    whole configuration, etc.
1475

1476
    @warning: this function will call L{_WriteConfig()}, but also
1477
        L{DropECReservations} so it needs to be called only from a
1478
        "safe" place (the constructor). If one wanted to call it with
1479
        the lock held, a DropECReservationUnlocked would need to be
1480
        created first, to avoid causing deadlock.
1481

1482
    """
1483
    modified = False
1484
    for item in self._AllUUIDObjects():
1485
      if item.uuid is None:
1486
        item.uuid = self._GenerateUniqueID(_UPGRADE_CONFIG_JID)
1487
        modified = True
1488
    if not self._config_data.nodegroups:
1489
      default_nodegroup_name = constants.INITIAL_NODE_GROUP_NAME
1490
      default_nodegroup = objects.NodeGroup(name=default_nodegroup_name,
1491
                                            members=[])
1492
      self._UnlockedAddNodeGroup(default_nodegroup, _UPGRADE_CONFIG_JID, True)
1493
      modified = True
1494
    for node in self._config_data.nodes.values():
1495
      if not node.group:
1496
        node.group = self.LookupNodeGroup(None)
1497
        modified = True
1498
      # This is technically *not* an upgrade, but needs to be done both when
1499
      # nodegroups are being added, and upon normally loading the config,
1500
      # because the members list of a node group is discarded upon
1501
      # serializing/deserializing the object.
1502
      self._UnlockedAddNodeToGroup(node.name, node.group)
1503
    if modified:
1504
      self._WriteConfig()
1505
      # This is ok even if it acquires the internal lock, as _UpgradeConfig is
1506
      # only called at config init time, without the lock held
1507
      self.DropECReservations(_UPGRADE_CONFIG_JID)
1508

    
1509
  def _DistributeConfig(self, feedback_fn):
1510
    """Distribute the configuration to the other nodes.
1511

1512
    Currently, this only copies the configuration file. In the future,
1513
    it could be used to encapsulate the 2/3-phase update mechanism.
1514

1515
    """
1516
    if self._offline:
1517
      return True
1518

    
1519
    bad = False
1520

    
1521
    node_list = []
1522
    addr_list = []
1523
    myhostname = self._my_hostname
1524
    # we can skip checking whether _UnlockedGetNodeInfo returns None
1525
    # since the node list comes from _UnlocketGetNodeList, and we are
1526
    # called with the lock held, so no modifications should take place
1527
    # in between
1528
    for node_name in self._UnlockedGetNodeList():
1529
      if node_name == myhostname:
1530
        continue
1531
      node_info = self._UnlockedGetNodeInfo(node_name)
1532
      if not node_info.master_candidate:
1533
        continue
1534
      node_list.append(node_info.name)
1535
      addr_list.append(node_info.primary_ip)
1536

    
1537
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
1538
                                            address_list=addr_list)
1539
    for to_node, to_result in result.items():
1540
      msg = to_result.fail_msg
1541
      if msg:
1542
        msg = ("Copy of file %s to node %s failed: %s" %
1543
               (self._cfg_file, to_node, msg))
1544
        logging.error(msg)
1545

    
1546
        if feedback_fn:
1547
          feedback_fn(msg)
1548

    
1549
        bad = True
1550

    
1551
    return not bad
1552

    
1553
  def _WriteConfig(self, destination=None, feedback_fn=None):
1554
    """Write the configuration data to persistent storage.
1555

1556
    """
1557
    assert feedback_fn is None or callable(feedback_fn)
1558

    
1559
    # Warn on config errors, but don't abort the save - the
1560
    # configuration has already been modified, and we can't revert;
1561
    # the best we can do is to warn the user and save as is, leaving
1562
    # recovery to the user
1563
    config_errors = self._UnlockedVerifyConfig()
1564
    if config_errors:
1565
      errmsg = ("Configuration data is not consistent: %s" %
1566
                (utils.CommaJoin(config_errors)))
1567
      logging.critical(errmsg)
1568
      if feedback_fn:
1569
        feedback_fn(errmsg)
1570

    
1571
    if destination is None:
1572
      destination = self._cfg_file
1573
    self._BumpSerialNo()
1574
    txt = serializer.Dump(self._config_data.ToDict())
1575

    
1576
    getents = self._getents()
1577
    try:
1578
      fd = utils.SafeWriteFile(destination, self._cfg_id, data=txt,
1579
                               close=False, gid=getents.confd_gid, mode=0640)
1580
    except errors.LockError:
1581
      raise errors.ConfigurationError("The configuration file has been"
1582
                                      " modified since the last write, cannot"
1583
                                      " update")
1584
    try:
1585
      self._cfg_id = utils.GetFileID(fd=fd)
1586
    finally:
1587
      os.close(fd)
1588

    
1589
    self.write_count += 1
1590

    
1591
    # and redistribute the config file to master candidates
1592
    self._DistributeConfig(feedback_fn)
1593

    
1594
    # Write ssconf files on all nodes (including locally)
1595
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1596
      if not self._offline:
1597
        result = rpc.RpcRunner.call_write_ssconf_files(
1598
          self._UnlockedGetOnlineNodeList(),
1599
          self._UnlockedGetSsconfValues())
1600

    
1601
        for nname, nresu in result.items():
1602
          msg = nresu.fail_msg
1603
          if msg:
1604
            errmsg = ("Error while uploading ssconf files to"
1605
                      " node %s: %s" % (nname, msg))
1606
            logging.warning(errmsg)
1607

    
1608
            if feedback_fn:
1609
              feedback_fn(errmsg)
1610

    
1611
      self._last_cluster_serial = self._config_data.cluster.serial_no
1612

    
1613
  def _UnlockedGetSsconfValues(self):
1614
    """Return the values needed by ssconf.
1615

1616
    @rtype: dict
1617
    @return: a dictionary with keys the ssconf names and values their
1618
        associated value
1619

1620
    """
1621
    fn = "\n".join
1622
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1623
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
1624
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]
1625
    node_pri_ips = ["%s %s" % (ninfo.name, ninfo.primary_ip)
1626
                    for ninfo in node_info]
1627
    node_snd_ips = ["%s %s" % (ninfo.name, ninfo.secondary_ip)
1628
                    for ninfo in node_info]
1629

    
1630
    instance_data = fn(instance_names)
1631
    off_data = fn(node.name for node in node_info if node.offline)
1632
    on_data = fn(node.name for node in node_info if not node.offline)
1633
    mc_data = fn(node.name for node in node_info if node.master_candidate)
1634
    mc_ips_data = fn(node.primary_ip for node in node_info
1635
                     if node.master_candidate)
1636
    node_data = fn(node_names)
1637
    node_pri_ips_data = fn(node_pri_ips)
1638
    node_snd_ips_data = fn(node_snd_ips)
1639

    
1640
    cluster = self._config_data.cluster
1641
    cluster_tags = fn(cluster.GetTags())
1642

    
1643
    hypervisor_list = fn(cluster.enabled_hypervisors)
1644

    
1645
    uid_pool = uidpool.FormatUidPool(cluster.uid_pool, separator="\n")
1646

    
1647
    nodegroups = ["%s %s" % (nodegroup.uuid, nodegroup.name) for nodegroup in
1648
                  self._config_data.nodegroups.values()]
1649
    nodegroups_data = fn(utils.NiceSort(nodegroups))
1650

    
1651
    return {
1652
      constants.SS_CLUSTER_NAME: cluster.cluster_name,
1653
      constants.SS_CLUSTER_TAGS: cluster_tags,
1654
      constants.SS_FILE_STORAGE_DIR: cluster.file_storage_dir,
1655
      constants.SS_MASTER_CANDIDATES: mc_data,
1656
      constants.SS_MASTER_CANDIDATES_IPS: mc_ips_data,
1657
      constants.SS_MASTER_IP: cluster.master_ip,
1658
      constants.SS_MASTER_NETDEV: cluster.master_netdev,
1659
      constants.SS_MASTER_NODE: cluster.master_node,
1660
      constants.SS_NODE_LIST: node_data,
1661
      constants.SS_NODE_PRIMARY_IPS: node_pri_ips_data,
1662
      constants.SS_NODE_SECONDARY_IPS: node_snd_ips_data,
1663
      constants.SS_OFFLINE_NODES: off_data,
1664
      constants.SS_ONLINE_NODES: on_data,
1665
      constants.SS_PRIMARY_IP_FAMILY: str(cluster.primary_ip_family),
1666
      constants.SS_INSTANCE_LIST: instance_data,
1667
      constants.SS_RELEASE_VERSION: constants.RELEASE_VERSION,
1668
      constants.SS_HYPERVISOR_LIST: hypervisor_list,
1669
      constants.SS_MAINTAIN_NODE_HEALTH: str(cluster.maintain_node_health),
1670
      constants.SS_UID_POOL: uid_pool,
1671
      constants.SS_NODEGROUPS: nodegroups_data,
1672
      }
1673

    
1674
  @locking.ssynchronized(_config_lock, shared=1)
1675
  def GetSsconfValues(self):
1676
    """Wrapper using lock around _UnlockedGetSsconf().
1677

1678
    """
1679
    return self._UnlockedGetSsconfValues()
1680

    
1681
  @locking.ssynchronized(_config_lock, shared=1)
1682
  def GetVGName(self):
1683
    """Return the volume group name.
1684

1685
    """
1686
    return self._config_data.cluster.volume_group_name
1687

    
1688
  @locking.ssynchronized(_config_lock)
1689
  def SetVGName(self, vg_name):
1690
    """Set the volume group name.
1691

1692
    """
1693
    self._config_data.cluster.volume_group_name = vg_name
1694
    self._config_data.cluster.serial_no += 1
1695
    self._WriteConfig()
1696

    
1697
  @locking.ssynchronized(_config_lock, shared=1)
1698
  def GetDRBDHelper(self):
1699
    """Return DRBD usermode helper.
1700

1701
    """
1702
    return self._config_data.cluster.drbd_usermode_helper
1703

    
1704
  @locking.ssynchronized(_config_lock)
1705
  def SetDRBDHelper(self, drbd_helper):
1706
    """Set DRBD usermode helper.
1707

1708
    """
1709
    self._config_data.cluster.drbd_usermode_helper = drbd_helper
1710
    self._config_data.cluster.serial_no += 1
1711
    self._WriteConfig()
1712

    
1713
  @locking.ssynchronized(_config_lock, shared=1)
1714
  def GetMACPrefix(self):
1715
    """Return the mac prefix.
1716

1717
    """
1718
    return self._config_data.cluster.mac_prefix
1719

    
1720
  @locking.ssynchronized(_config_lock, shared=1)
1721
  def GetClusterInfo(self):
1722
    """Returns information about the cluster
1723

1724
    @rtype: L{objects.Cluster}
1725
    @return: the cluster object
1726

1727
    """
1728
    return self._config_data.cluster
1729

    
1730
  @locking.ssynchronized(_config_lock, shared=1)
1731
  def HasAnyDiskOfType(self, dev_type):
1732
    """Check if in there is at disk of the given type in the configuration.
1733

1734
    """
1735
    return self._config_data.HasAnyDiskOfType(dev_type)
1736

    
1737
  @locking.ssynchronized(_config_lock)
1738
  def Update(self, target, feedback_fn):
1739
    """Notify function to be called after updates.
1740

1741
    This function must be called when an object (as returned by
1742
    GetInstanceInfo, GetNodeInfo, GetCluster) has been updated and the
1743
    caller wants the modifications saved to the backing store. Note
1744
    that all modified objects will be saved, but the target argument
1745
    is the one the caller wants to ensure that it's saved.
1746

1747
    @param target: an instance of either L{objects.Cluster},
1748
        L{objects.Node} or L{objects.Instance} which is existing in
1749
        the cluster
1750
    @param feedback_fn: Callable feedback function
1751

1752
    """
1753
    if self._config_data is None:
1754
      raise errors.ProgrammerError("Configuration file not read,"
1755
                                   " cannot save.")
1756
    update_serial = False
1757
    if isinstance(target, objects.Cluster):
1758
      test = target == self._config_data.cluster
1759
    elif isinstance(target, objects.Node):
1760
      test = target in self._config_data.nodes.values()
1761
      update_serial = True
1762
    elif isinstance(target, objects.Instance):
1763
      test = target in self._config_data.instances.values()
1764
    elif isinstance(target, objects.NodeGroup):
1765
      test = target in self._config_data.nodegroups.values()
1766
    else:
1767
      raise errors.ProgrammerError("Invalid object type (%s) passed to"
1768
                                   " ConfigWriter.Update" % type(target))
1769
    if not test:
1770
      raise errors.ConfigurationError("Configuration updated since object"
1771
                                      " has been read or unknown object")
1772
    target.serial_no += 1
1773
    target.mtime = now = time.time()
1774

    
1775
    if update_serial:
1776
      # for node updates, we need to increase the cluster serial too
1777
      self._config_data.cluster.serial_no += 1
1778
      self._config_data.cluster.mtime = now
1779

    
1780
    if isinstance(target, objects.Instance):
1781
      self._UnlockedReleaseDRBDMinors(target.name)
1782

    
1783
    self._WriteConfig(feedback_fn=feedback_fn)
1784

    
1785
  @locking.ssynchronized(_config_lock)
1786
  def DropECReservations(self, ec_id):
1787
    """Drop per-execution-context reservations
1788

1789
    """
1790
    for rm in self._all_rms:
1791
      rm.DropECReservations(ec_id)