Statistics
| Branch: | Tag: | Revision:

root / lib / config.py @ 0fa753ba

History | View | Annotate | Download (68.4 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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=R0904
35
# R0904: Too many public methods
36

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

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

    
54

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

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

    
60

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

64
  This only verifies the version of the configuration.
65

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

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

    
73

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

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

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

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

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

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

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

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

112
    """
113
    assert callable(generate_one_fn)
114

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

    
128

    
129
def _MatchNameComponentIgnoreCase(short_name, names):
130
  """Wrapper around L{utils.text.MatchNameComponent}.
131

132
  """
133
  return utils.MatchNameComponent(short_name, names, case_sensitive=False)
134

    
135

    
136
class ConfigWriter:
137
  """The interface to the cluster configuration.
138

139
  @ivar _temporary_lvs: reservation manager for temporary LVs
140
  @ivar _all_rms: a list of all temporary reservation managers
141

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

    
170
  # this method needs to be static, so that we can call it on the class
171
  @staticmethod
172
  def IsCluster():
173
    """Check if the cluster is configured.
174

175
    """
176
    return os.path.exists(constants.CLUSTER_CONF_FILE)
177

    
178
  def _GenerateOneMAC(self):
179
    """Generate one mac address
180

181
    """
182
    prefix = self._config_data.cluster.mac_prefix
183
    byte1 = random.randrange(0, 256)
184
    byte2 = random.randrange(0, 256)
185
    byte3 = random.randrange(0, 256)
186
    mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
187
    return mac
188

    
189
  @locking.ssynchronized(_config_lock, shared=1)
190
  def GetNdParams(self, node):
191
    """Get the node params populated with cluster defaults.
192

193
    @type node: L{objects.Node}
194
    @param node: The node we want to know the params for
195
    @return: A dict with the filled in node params
196

197
    """
198
    nodegroup = self._UnlockedGetNodeGroup(node.group)
199
    return self._config_data.cluster.FillND(node, nodegroup)
200

    
201
  @locking.ssynchronized(_config_lock, shared=1)
202
  def GenerateMAC(self, ec_id):
203
    """Generate a MAC for an instance.
204

205
    This should check the current instances for duplicates.
206

207
    """
208
    existing = self._AllMACs()
209
    return self._temporary_ids.Generate(existing, self._GenerateOneMAC, ec_id)
210

    
211
  @locking.ssynchronized(_config_lock, shared=1)
212
  def ReserveMAC(self, mac, ec_id):
213
    """Reserve a MAC for an instance.
214

215
    This only checks instances managed by this cluster, it does not
216
    check for potential collisions elsewhere.
217

218
    """
219
    all_macs = self._AllMACs()
220
    if mac in all_macs:
221
      raise errors.ReservationError("mac already in use")
222
    else:
223
      self._temporary_macs.Reserve(ec_id, mac)
224

    
225
  @locking.ssynchronized(_config_lock, shared=1)
226
  def ReserveLV(self, lv_name, ec_id):
227
    """Reserve an VG/LV pair for an instance.
228

229
    @type lv_name: string
230
    @param lv_name: the logical volume name to reserve
231

232
    """
233
    all_lvs = self._AllLVs()
234
    if lv_name in all_lvs:
235
      raise errors.ReservationError("LV already in use")
236
    else:
237
      self._temporary_lvs.Reserve(ec_id, lv_name)
238

    
239
  @locking.ssynchronized(_config_lock, shared=1)
240
  def GenerateDRBDSecret(self, ec_id):
241
    """Generate a DRBD secret.
242

243
    This checks the current disks for duplicates.
244

245
    """
246
    return self._temporary_secrets.Generate(self._AllDRBDSecrets(),
247
                                            utils.GenerateSecret,
248
                                            ec_id)
249

    
250
  def _AllLVs(self):
251
    """Compute the list of all LVs.
252

253
    """
254
    lvnames = set()
255
    for instance in self._config_data.instances.values():
256
      node_data = instance.MapLVsByNode()
257
      for lv_list in node_data.values():
258
        lvnames.update(lv_list)
259
    return lvnames
260

    
261
  def _AllIDs(self, include_temporary):
262
    """Compute the list of all UUIDs and names we have.
263

264
    @type include_temporary: boolean
265
    @param include_temporary: whether to include the _temporary_ids set
266
    @rtype: set
267
    @return: a set of IDs
268

269
    """
270
    existing = set()
271
    if include_temporary:
272
      existing.update(self._temporary_ids.GetReserved())
273
    existing.update(self._AllLVs())
274
    existing.update(self._config_data.instances.keys())
275
    existing.update(self._config_data.nodes.keys())
276
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
277
    return existing
278

    
279
  def _GenerateUniqueID(self, ec_id):
280
    """Generate an unique UUID.
281

282
    This checks the current node, instances and disk names for
283
    duplicates.
284

285
    @rtype: string
286
    @return: the unique id
287

288
    """
289
    existing = self._AllIDs(include_temporary=False)
290
    return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
291

    
292
  @locking.ssynchronized(_config_lock, shared=1)
293
  def GenerateUniqueID(self, ec_id):
294
    """Generate an unique ID.
295

296
    This is just a wrapper over the unlocked version.
297

298
    @type ec_id: string
299
    @param ec_id: unique id for the job to reserve the id to
300

301
    """
302
    return self._GenerateUniqueID(ec_id)
303

    
304
  def _AllMACs(self):
305
    """Return all MACs present in the config.
306

307
    @rtype: list
308
    @return: the list of all MACs
309

310
    """
311
    result = []
312
    for instance in self._config_data.instances.values():
313
      for nic in instance.nics:
314
        result.append(nic.mac)
315

    
316
    return result
317

    
318
  def _AllDRBDSecrets(self):
319
    """Return all DRBD secrets present in the config.
320

321
    @rtype: list
322
    @return: the list of all DRBD secrets
323

324
    """
325
    def helper(disk, result):
326
      """Recursively gather secrets from this disk."""
327
      if disk.dev_type == constants.DT_DRBD8:
328
        result.append(disk.logical_id[5])
329
      if disk.children:
330
        for child in disk.children:
331
          helper(child, result)
332

    
333
    result = []
334
    for instance in self._config_data.instances.values():
335
      for disk in instance.disks:
336
        helper(disk, result)
337

    
338
    return result
339

    
340
  def _CheckDiskIDs(self, disk, l_ids, p_ids):
341
    """Compute duplicate disk IDs
342

343
    @type disk: L{objects.Disk}
344
    @param disk: the disk at which to start searching
345
    @type l_ids: list
346
    @param l_ids: list of current logical ids
347
    @type p_ids: list
348
    @param p_ids: list of current physical ids
349
    @rtype: list
350
    @return: a list of error messages
351

352
    """
353
    result = []
354
    if disk.logical_id is not None:
355
      if disk.logical_id in l_ids:
356
        result.append("duplicate logical id %s" % str(disk.logical_id))
357
      else:
358
        l_ids.append(disk.logical_id)
359
    if disk.physical_id is not None:
360
      if disk.physical_id in p_ids:
361
        result.append("duplicate physical id %s" % str(disk.physical_id))
362
      else:
363
        p_ids.append(disk.physical_id)
364

    
365
    if disk.children:
366
      for child in disk.children:
367
        result.extend(self._CheckDiskIDs(child, l_ids, p_ids))
368
    return result
369

    
370
  def _UnlockedVerifyConfig(self):
371
    """Verify function.
372

373
    @rtype: list
374
    @return: a list of error messages; a non-empty list signifies
375
        configuration errors
376

377
    """
378
    # pylint: disable=R0914
379
    result = []
380
    seen_macs = []
381
    ports = {}
382
    data = self._config_data
383
    cluster = data.cluster
384
    seen_lids = []
385
    seen_pids = []
386

    
387
    # global cluster checks
388
    if not cluster.enabled_hypervisors:
389
      result.append("enabled hypervisors list doesn't have any entries")
390
    invalid_hvs = set(cluster.enabled_hypervisors) - constants.HYPER_TYPES
391
    if invalid_hvs:
392
      result.append("enabled hypervisors contains invalid entries: %s" %
393
                    invalid_hvs)
394
    missing_hvp = (set(cluster.enabled_hypervisors) -
395
                   set(cluster.hvparams.keys()))
396
    if missing_hvp:
397
      result.append("hypervisor parameters missing for the enabled"
398
                    " hypervisor(s) %s" % utils.CommaJoin(missing_hvp))
399

    
400
    if cluster.master_node not in data.nodes:
401
      result.append("cluster has invalid primary node '%s'" %
402
                    cluster.master_node)
403

    
404
    def _helper(owner, attr, value, template):
405
      try:
406
        utils.ForceDictType(value, template)
407
      except errors.GenericError, err:
408
        result.append("%s has invalid %s: %s" % (owner, attr, err))
409

    
410
    def _helper_nic(owner, params):
411
      try:
412
        objects.NIC.CheckParameterSyntax(params)
413
      except errors.ConfigurationError, err:
414
        result.append("%s has invalid nicparams: %s" % (owner, err))
415

    
416
    # check cluster parameters
417
    _helper("cluster", "beparams", cluster.SimpleFillBE({}),
418
            constants.BES_PARAMETER_TYPES)
419
    _helper("cluster", "nicparams", cluster.SimpleFillNIC({}),
420
            constants.NICS_PARAMETER_TYPES)
421
    _helper_nic("cluster", cluster.SimpleFillNIC({}))
422
    _helper("cluster", "ndparams", cluster.SimpleFillND({}),
423
            constants.NDS_PARAMETER_TYPES)
424

    
425
    # per-instance checks
426
    for instance_name in data.instances:
427
      instance = data.instances[instance_name]
428
      if instance.name != instance_name:
429
        result.append("instance '%s' is indexed by wrong name '%s'" %
430
                      (instance.name, instance_name))
431
      if instance.primary_node not in data.nodes:
432
        result.append("instance '%s' has invalid primary node '%s'" %
433
                      (instance_name, instance.primary_node))
434
      for snode in instance.secondary_nodes:
435
        if snode not in data.nodes:
436
          result.append("instance '%s' has invalid secondary node '%s'" %
437
                        (instance_name, snode))
438
      for idx, nic in enumerate(instance.nics):
439
        if nic.mac in seen_macs:
440
          result.append("instance '%s' has NIC %d mac %s duplicate" %
441
                        (instance_name, idx, nic.mac))
442
        else:
443
          seen_macs.append(nic.mac)
444
        if nic.nicparams:
445
          filled = cluster.SimpleFillNIC(nic.nicparams)
446
          owner = "instance %s nic %d" % (instance.name, idx)
447
          _helper(owner, "nicparams",
448
                  filled, constants.NICS_PARAMETER_TYPES)
449
          _helper_nic(owner, filled)
450

    
451
      # parameter checks
452
      if instance.beparams:
453
        _helper("instance %s" % instance.name, "beparams",
454
                cluster.FillBE(instance), constants.BES_PARAMETER_TYPES)
455

    
456
      # gather the drbd ports for duplicate checks
457
      for dsk in instance.disks:
458
        if dsk.dev_type in constants.LDS_DRBD:
459
          tcp_port = dsk.logical_id[2]
460
          if tcp_port not in ports:
461
            ports[tcp_port] = []
462
          ports[tcp_port].append((instance.name, "drbd disk %s" % dsk.iv_name))
463
      # gather network port reservation
464
      net_port = getattr(instance, "network_port", None)
465
      if net_port is not None:
466
        if net_port not in ports:
467
          ports[net_port] = []
468
        ports[net_port].append((instance.name, "network port"))
469

    
470
      # instance disk verify
471
      for idx, disk in enumerate(instance.disks):
472
        result.extend(["instance '%s' disk %d error: %s" %
473
                       (instance.name, idx, msg) for msg in disk.Verify()])
474
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
475

    
476
    # cluster-wide pool of free ports
477
    for free_port in cluster.tcpudp_port_pool:
478
      if free_port not in ports:
479
        ports[free_port] = []
480
      ports[free_port].append(("cluster", "port marked as free"))
481

    
482
    # compute tcp/udp duplicate ports
483
    keys = ports.keys()
484
    keys.sort()
485
    for pnum in keys:
486
      pdata = ports[pnum]
487
      if len(pdata) > 1:
488
        txt = utils.CommaJoin(["%s/%s" % val for val in pdata])
489
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))
490

    
491
    # highest used tcp port check
492
    if keys:
493
      if keys[-1] > cluster.highest_used_port:
494
        result.append("Highest used port mismatch, saved %s, computed %s" %
495
                      (cluster.highest_used_port, keys[-1]))
496

    
497
    if not data.nodes[cluster.master_node].master_candidate:
498
      result.append("Master node is not a master candidate")
499

    
500
    # master candidate checks
501
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
502
    if mc_now < mc_max:
503
      result.append("Not enough master candidates: actual %d, target %d" %
504
                    (mc_now, mc_max))
505

    
506
    # node checks
507
    for node_name, node in data.nodes.items():
508
      if node.name != node_name:
509
        result.append("Node '%s' is indexed by wrong name '%s'" %
510
                      (node.name, node_name))
511
      if [node.master_candidate, node.drained, node.offline].count(True) > 1:
512
        result.append("Node %s state is invalid: master_candidate=%s,"
513
                      " drain=%s, offline=%s" %
514
                      (node.name, node.master_candidate, node.drained,
515
                       node.offline))
516
      if node.group not in data.nodegroups:
517
        result.append("Node '%s' has invalid group '%s'" %
518
                      (node.name, node.group))
519
      else:
520
        _helper("node %s" % node.name, "ndparams",
521
                cluster.FillND(node, data.nodegroups[node.group]),
522
                constants.NDS_PARAMETER_TYPES)
523

    
524
    # nodegroups checks
525
    nodegroups_names = set()
526
    for nodegroup_uuid in data.nodegroups:
527
      nodegroup = data.nodegroups[nodegroup_uuid]
528
      if nodegroup.uuid != nodegroup_uuid:
529
        result.append("node group '%s' (uuid: '%s') indexed by wrong uuid '%s'"
530
                      % (nodegroup.name, nodegroup.uuid, nodegroup_uuid))
531
      if utils.UUID_RE.match(nodegroup.name.lower()):
532
        result.append("node group '%s' (uuid: '%s') has uuid-like name" %
533
                      (nodegroup.name, nodegroup.uuid))
534
      if nodegroup.name in nodegroups_names:
535
        result.append("duplicate node group name '%s'" % nodegroup.name)
536
      else:
537
        nodegroups_names.add(nodegroup.name)
538
      if nodegroup.ndparams:
539
        _helper("group %s" % nodegroup.name, "ndparams",
540
                cluster.SimpleFillND(nodegroup.ndparams),
541
                constants.NDS_PARAMETER_TYPES)
542

    
543
    # drbd minors check
544
    _, duplicates = self._UnlockedComputeDRBDMap()
545
    for node, minor, instance_a, instance_b in duplicates:
546
      result.append("DRBD minor %d on node %s is assigned twice to instances"
547
                    " %s and %s" % (minor, node, instance_a, instance_b))
548

    
549
    # IP checks
550
    default_nicparams = cluster.nicparams[constants.PP_DEFAULT]
551
    ips = {}
552

    
553
    def _AddIpAddress(ip, name):
554
      ips.setdefault(ip, []).append(name)
555

    
556
    _AddIpAddress(cluster.master_ip, "cluster_ip")
557

    
558
    for node in data.nodes.values():
559
      _AddIpAddress(node.primary_ip, "node:%s/primary" % node.name)
560
      if node.secondary_ip != node.primary_ip:
561
        _AddIpAddress(node.secondary_ip, "node:%s/secondary" % node.name)
562

    
563
    for instance in data.instances.values():
564
      for idx, nic in enumerate(instance.nics):
565
        if nic.ip is None:
566
          continue
567

    
568
        nicparams = objects.FillDict(default_nicparams, nic.nicparams)
569
        nic_mode = nicparams[constants.NIC_MODE]
570
        nic_link = nicparams[constants.NIC_LINK]
571

    
572
        if nic_mode == constants.NIC_MODE_BRIDGED:
573
          link = "bridge:%s" % nic_link
574
        elif nic_mode == constants.NIC_MODE_ROUTED:
575
          link = "route:%s" % nic_link
576
        else:
577
          raise errors.ProgrammerError("NIC mode '%s' not handled" % nic_mode)
578

    
579
        _AddIpAddress("%s/%s" % (link, nic.ip),
580
                      "instance:%s/nic:%d" % (instance.name, idx))
581

    
582
    for ip, owners in ips.items():
583
      if len(owners) > 1:
584
        result.append("IP address %s is used by multiple owners: %s" %
585
                      (ip, utils.CommaJoin(owners)))
586

    
587
    return result
588

    
589
  @locking.ssynchronized(_config_lock, shared=1)
590
  def VerifyConfig(self):
591
    """Verify function.
592

593
    This is just a wrapper over L{_UnlockedVerifyConfig}.
594

595
    @rtype: list
596
    @return: a list of error messages; a non-empty list signifies
597
        configuration errors
598

599
    """
600
    return self._UnlockedVerifyConfig()
601

    
602
  def _UnlockedSetDiskID(self, disk, node_name):
603
    """Convert the unique ID to the ID needed on the target nodes.
604

605
    This is used only for drbd, which needs ip/port configuration.
606

607
    The routine descends down and updates its children also, because
608
    this helps when the only the top device is passed to the remote
609
    node.
610

611
    This function is for internal use, when the config lock is already held.
612

613
    """
614
    if disk.children:
615
      for child in disk.children:
616
        self._UnlockedSetDiskID(child, node_name)
617

    
618
    if disk.logical_id is None and disk.physical_id is not None:
619
      return
620
    if disk.dev_type == constants.LD_DRBD8:
621
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
622
      if node_name not in (pnode, snode):
623
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
624
                                        node_name)
625
      pnode_info = self._UnlockedGetNodeInfo(pnode)
626
      snode_info = self._UnlockedGetNodeInfo(snode)
627
      if pnode_info is None or snode_info is None:
628
        raise errors.ConfigurationError("Can't find primary or secondary node"
629
                                        " for %s" % str(disk))
630
      p_data = (pnode_info.secondary_ip, port)
631
      s_data = (snode_info.secondary_ip, port)
632
      if pnode == node_name:
633
        disk.physical_id = p_data + s_data + (pminor, secret)
634
      else: # it must be secondary, we tested above
635
        disk.physical_id = s_data + p_data + (sminor, secret)
636
    else:
637
      disk.physical_id = disk.logical_id
638
    return
639

    
640
  @locking.ssynchronized(_config_lock)
641
  def SetDiskID(self, disk, node_name):
642
    """Convert the unique ID to the ID needed on the target nodes.
643

644
    This is used only for drbd, which needs ip/port configuration.
645

646
    The routine descends down and updates its children also, because
647
    this helps when the only the top device is passed to the remote
648
    node.
649

650
    """
651
    return self._UnlockedSetDiskID(disk, node_name)
652

    
653
  @locking.ssynchronized(_config_lock)
654
  def AddTcpUdpPort(self, port):
655
    """Adds a new port to the available port pool.
656

657
    """
658
    if not isinstance(port, int):
659
      raise errors.ProgrammerError("Invalid type passed for port")
660

    
661
    self._config_data.cluster.tcpudp_port_pool.add(port)
662
    self._WriteConfig()
663

    
664
  @locking.ssynchronized(_config_lock, shared=1)
665
  def GetPortList(self):
666
    """Returns a copy of the current port list.
667

668
    """
669
    return self._config_data.cluster.tcpudp_port_pool.copy()
670

    
671
  @locking.ssynchronized(_config_lock)
672
  def AllocatePort(self):
673
    """Allocate a port.
674

675
    The port will be taken from the available port pool or from the
676
    default port range (and in this case we increase
677
    highest_used_port).
678

679
    """
680
    # If there are TCP/IP ports configured, we use them first.
681
    if self._config_data.cluster.tcpudp_port_pool:
682
      port = self._config_data.cluster.tcpudp_port_pool.pop()
683
    else:
684
      port = self._config_data.cluster.highest_used_port + 1
685
      if port >= constants.LAST_DRBD_PORT:
686
        raise errors.ConfigurationError("The highest used port is greater"
687
                                        " than %s. Aborting." %
688
                                        constants.LAST_DRBD_PORT)
689
      self._config_data.cluster.highest_used_port = port
690

    
691
    self._WriteConfig()
692
    return port
693

    
694
  def _UnlockedComputeDRBDMap(self):
695
    """Compute the used DRBD minor/nodes.
696

697
    @rtype: (dict, list)
698
    @return: dictionary of node_name: dict of minor: instance_name;
699
        the returned dict will have all the nodes in it (even if with
700
        an empty list), and a list of duplicates; if the duplicates
701
        list is not empty, the configuration is corrupted and its caller
702
        should raise an exception
703

704
    """
705
    def _AppendUsedPorts(instance_name, disk, used):
706
      duplicates = []
707
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
708
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
709
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
710
          assert node in used, ("Node '%s' of instance '%s' not found"
711
                                " in node list" % (node, instance_name))
712
          if port in used[node]:
713
            duplicates.append((node, port, instance_name, used[node][port]))
714
          else:
715
            used[node][port] = instance_name
716
      if disk.children:
717
        for child in disk.children:
718
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
719
      return duplicates
720

    
721
    duplicates = []
722
    my_dict = dict((node, {}) for node in self._config_data.nodes)
723
    for instance in self._config_data.instances.itervalues():
724
      for disk in instance.disks:
725
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
726
    for (node, minor), instance in self._temporary_drbds.iteritems():
727
      if minor in my_dict[node] and my_dict[node][minor] != instance:
728
        duplicates.append((node, minor, instance, my_dict[node][minor]))
729
      else:
730
        my_dict[node][minor] = instance
731
    return my_dict, duplicates
732

    
733
  @locking.ssynchronized(_config_lock)
734
  def ComputeDRBDMap(self):
735
    """Compute the used DRBD minor/nodes.
736

737
    This is just a wrapper over L{_UnlockedComputeDRBDMap}.
738

739
    @return: dictionary of node_name: dict of minor: instance_name;
740
        the returned dict will have all the nodes in it (even if with
741
        an empty list).
742

743
    """
744
    d_map, duplicates = self._UnlockedComputeDRBDMap()
745
    if duplicates:
746
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
747
                                      str(duplicates))
748
    return d_map
749

    
750
  @locking.ssynchronized(_config_lock)
751
  def AllocateDRBDMinor(self, nodes, instance):
752
    """Allocate a drbd minor.
753

754
    The free minor will be automatically computed from the existing
755
    devices. A node can be given multiple times in order to allocate
756
    multiple minors. The result is the list of minors, in the same
757
    order as the passed nodes.
758

759
    @type instance: string
760
    @param instance: the instance for which we allocate minors
761

762
    """
763
    assert isinstance(instance, basestring), \
764
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
765

    
766
    d_map, duplicates = self._UnlockedComputeDRBDMap()
767
    if duplicates:
768
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
769
                                      str(duplicates))
770
    result = []
771
    for nname in nodes:
772
      ndata = d_map[nname]
773
      if not ndata:
774
        # no minors used, we can start at 0
775
        result.append(0)
776
        ndata[0] = instance
777
        self._temporary_drbds[(nname, 0)] = instance
778
        continue
779
      keys = ndata.keys()
780
      keys.sort()
781
      ffree = utils.FirstFree(keys)
782
      if ffree is None:
783
        # return the next minor
784
        # TODO: implement high-limit check
785
        minor = keys[-1] + 1
786
      else:
787
        minor = ffree
788
      # double-check minor against current instances
789
      assert minor not in d_map[nname], \
790
             ("Attempt to reuse allocated DRBD minor %d on node %s,"
791
              " already allocated to instance %s" %
792
              (minor, nname, d_map[nname][minor]))
793
      ndata[minor] = instance
794
      # double-check minor against reservation
795
      r_key = (nname, minor)
796
      assert r_key not in self._temporary_drbds, \
797
             ("Attempt to reuse reserved DRBD minor %d on node %s,"
798
              " reserved for instance %s" %
799
              (minor, nname, self._temporary_drbds[r_key]))
800
      self._temporary_drbds[r_key] = instance
801
      result.append(minor)
802
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
803
                  nodes, result)
804
    return result
805

    
806
  def _UnlockedReleaseDRBDMinors(self, instance):
807
    """Release temporary drbd minors allocated for a given instance.
808

809
    @type instance: string
810
    @param instance: the instance for which temporary minors should be
811
                     released
812

813
    """
814
    assert isinstance(instance, basestring), \
815
           "Invalid argument passed to ReleaseDRBDMinors"
816
    for key, name in self._temporary_drbds.items():
817
      if name == instance:
818
        del self._temporary_drbds[key]
819

    
820
  @locking.ssynchronized(_config_lock)
821
  def ReleaseDRBDMinors(self, instance):
822
    """Release temporary drbd minors allocated for a given instance.
823

824
    This should be called on the error paths, on the success paths
825
    it's automatically called by the ConfigWriter add and update
826
    functions.
827

828
    This function is just a wrapper over L{_UnlockedReleaseDRBDMinors}.
829

830
    @type instance: string
831
    @param instance: the instance for which temporary minors should be
832
                     released
833

834
    """
835
    self._UnlockedReleaseDRBDMinors(instance)
836

    
837
  @locking.ssynchronized(_config_lock, shared=1)
838
  def GetConfigVersion(self):
839
    """Get the configuration version.
840

841
    @return: Config version
842

843
    """
844
    return self._config_data.version
845

    
846
  @locking.ssynchronized(_config_lock, shared=1)
847
  def GetClusterName(self):
848
    """Get cluster name.
849

850
    @return: Cluster name
851

852
    """
853
    return self._config_data.cluster.cluster_name
854

    
855
  @locking.ssynchronized(_config_lock, shared=1)
856
  def GetMasterNode(self):
857
    """Get the hostname of the master node for this cluster.
858

859
    @return: Master hostname
860

861
    """
862
    return self._config_data.cluster.master_node
863

    
864
  @locking.ssynchronized(_config_lock, shared=1)
865
  def GetMasterIP(self):
866
    """Get the IP of the master node for this cluster.
867

868
    @return: Master IP
869

870
    """
871
    return self._config_data.cluster.master_ip
872

    
873
  @locking.ssynchronized(_config_lock, shared=1)
874
  def GetMasterNetdev(self):
875
    """Get the master network device for this cluster.
876

877
    """
878
    return self._config_data.cluster.master_netdev
879

    
880
  @locking.ssynchronized(_config_lock, shared=1)
881
  def GetFileStorageDir(self):
882
    """Get the file storage dir for this cluster.
883

884
    """
885
    return self._config_data.cluster.file_storage_dir
886

    
887
  @locking.ssynchronized(_config_lock, shared=1)
888
  def GetSharedFileStorageDir(self):
889
    """Get the shared file storage dir for this cluster.
890

891
    """
892
    return self._config_data.cluster.shared_file_storage_dir
893

    
894
  @locking.ssynchronized(_config_lock, shared=1)
895
  def GetHypervisorType(self):
896
    """Get the hypervisor type for this cluster.
897

898
    """
899
    return self._config_data.cluster.enabled_hypervisors[0]
900

    
901
  @locking.ssynchronized(_config_lock, shared=1)
902
  def GetHostKey(self):
903
    """Return the rsa hostkey from the config.
904

905
    @rtype: string
906
    @return: the rsa hostkey
907

908
    """
909
    return self._config_data.cluster.rsahostkeypub
910

    
911
  @locking.ssynchronized(_config_lock, shared=1)
912
  def GetDefaultIAllocator(self):
913
    """Get the default instance allocator for this cluster.
914

915
    """
916
    return self._config_data.cluster.default_iallocator
917

    
918
  @locking.ssynchronized(_config_lock, shared=1)
919
  def GetPrimaryIPFamily(self):
920
    """Get cluster primary ip family.
921

922
    @return: primary ip family
923

924
    """
925
    return self._config_data.cluster.primary_ip_family
926

    
927
  @locking.ssynchronized(_config_lock)
928
  def AddNodeGroup(self, group, ec_id, check_uuid=True):
929
    """Add a node group to the configuration.
930

931
    This method calls group.UpgradeConfig() to fill any missing attributes
932
    according to their default values.
933

934
    @type group: L{objects.NodeGroup}
935
    @param group: the NodeGroup object to add
936
    @type ec_id: string
937
    @param ec_id: unique id for the job to use when creating a missing UUID
938
    @type check_uuid: bool
939
    @param check_uuid: add an UUID to the group if it doesn't have one or, if
940
                       it does, ensure that it does not exist in the
941
                       configuration already
942

943
    """
944
    self._UnlockedAddNodeGroup(group, ec_id, check_uuid)
945
    self._WriteConfig()
946

    
947
  def _UnlockedAddNodeGroup(self, group, ec_id, check_uuid):
948
    """Add a node group to the configuration.
949

950
    """
951
    logging.info("Adding node group %s to configuration", group.name)
952

    
953
    # Some code might need to add a node group with a pre-populated UUID
954
    # generated with ConfigWriter.GenerateUniqueID(). We allow them to bypass
955
    # the "does this UUID" exist already check.
956
    if check_uuid:
957
      self._EnsureUUID(group, ec_id)
958

    
959
    try:
960
      existing_uuid = self._UnlockedLookupNodeGroup(group.name)
961
    except errors.OpPrereqError:
962
      pass
963
    else:
964
      raise errors.OpPrereqError("Desired group name '%s' already exists as a"
965
                                 " node group (UUID: %s)" %
966
                                 (group.name, existing_uuid),
967
                                 errors.ECODE_EXISTS)
968

    
969
    group.serial_no = 1
970
    group.ctime = group.mtime = time.time()
971
    group.UpgradeConfig()
972

    
973
    self._config_data.nodegroups[group.uuid] = group
974
    self._config_data.cluster.serial_no += 1
975

    
976
  @locking.ssynchronized(_config_lock)
977
  def RemoveNodeGroup(self, group_uuid):
978
    """Remove a node group from the configuration.
979

980
    @type group_uuid: string
981
    @param group_uuid: the UUID of the node group to remove
982

983
    """
984
    logging.info("Removing node group %s from configuration", group_uuid)
985

    
986
    if group_uuid not in self._config_data.nodegroups:
987
      raise errors.ConfigurationError("Unknown node group '%s'" % group_uuid)
988

    
989
    assert len(self._config_data.nodegroups) != 1, \
990
            "Group '%s' is the only group, cannot be removed" % group_uuid
991

    
992
    del self._config_data.nodegroups[group_uuid]
993
    self._config_data.cluster.serial_no += 1
994
    self._WriteConfig()
995

    
996
  def _UnlockedLookupNodeGroup(self, target):
997
    """Lookup a node group's UUID.
998

999
    @type target: string or None
1000
    @param target: group name or UUID or None to look for the default
1001
    @rtype: string
1002
    @return: nodegroup UUID
1003
    @raises errors.OpPrereqError: when the target group cannot be found
1004

1005
    """
1006
    if target is None:
1007
      if len(self._config_data.nodegroups) != 1:
1008
        raise errors.OpPrereqError("More than one node group exists. Target"
1009
                                   " group must be specified explicitely.")
1010
      else:
1011
        return self._config_data.nodegroups.keys()[0]
1012
    if target in self._config_data.nodegroups:
1013
      return target
1014
    for nodegroup in self._config_data.nodegroups.values():
1015
      if nodegroup.name == target:
1016
        return nodegroup.uuid
1017
    raise errors.OpPrereqError("Node group '%s' not found" % target,
1018
                               errors.ECODE_NOENT)
1019

    
1020
  @locking.ssynchronized(_config_lock, shared=1)
1021
  def LookupNodeGroup(self, target):
1022
    """Lookup a node group's UUID.
1023

1024
    This function is just a wrapper over L{_UnlockedLookupNodeGroup}.
1025

1026
    @type target: string or None
1027
    @param target: group name or UUID or None to look for the default
1028
    @rtype: string
1029
    @return: nodegroup UUID
1030

1031
    """
1032
    return self._UnlockedLookupNodeGroup(target)
1033

    
1034
  def _UnlockedGetNodeGroup(self, uuid):
1035
    """Lookup a node group.
1036

1037
    @type uuid: string
1038
    @param uuid: group UUID
1039
    @rtype: L{objects.NodeGroup} or None
1040
    @return: nodegroup object, or None if not found
1041

1042
    """
1043
    if uuid not in self._config_data.nodegroups:
1044
      return None
1045

    
1046
    return self._config_data.nodegroups[uuid]
1047

    
1048
  @locking.ssynchronized(_config_lock, shared=1)
1049
  def GetNodeGroup(self, uuid):
1050
    """Lookup a node group.
1051

1052
    @type uuid: string
1053
    @param uuid: group UUID
1054
    @rtype: L{objects.NodeGroup} or None
1055
    @return: nodegroup object, or None if not found
1056

1057
    """
1058
    return self._UnlockedGetNodeGroup(uuid)
1059

    
1060
  @locking.ssynchronized(_config_lock, shared=1)
1061
  def GetAllNodeGroupsInfo(self):
1062
    """Get the configuration of all node groups.
1063

1064
    """
1065
    return dict(self._config_data.nodegroups)
1066

    
1067
  @locking.ssynchronized(_config_lock, shared=1)
1068
  def GetNodeGroupList(self):
1069
    """Get a list of node groups.
1070

1071
    """
1072
    return self._config_data.nodegroups.keys()
1073

    
1074
  @locking.ssynchronized(_config_lock, shared=1)
1075
  def GetNodeGroupMembersByNodes(self, nodes):
1076
    """Get nodes which are member in the same nodegroups as the given nodes.
1077

1078
    """
1079
    ngfn = lambda node_name: self._UnlockedGetNodeInfo(node_name).group
1080
    return frozenset(member_name
1081
                     for node_name in nodes
1082
                     for member_name in
1083
                       self._UnlockedGetNodeGroup(ngfn(node_name)).members)
1084

    
1085
  @locking.ssynchronized(_config_lock)
1086
  def AddInstance(self, instance, ec_id):
1087
    """Add an instance to the config.
1088

1089
    This should be used after creating a new instance.
1090

1091
    @type instance: L{objects.Instance}
1092
    @param instance: the instance object
1093

1094
    """
1095
    if not isinstance(instance, objects.Instance):
1096
      raise errors.ProgrammerError("Invalid type passed to AddInstance")
1097

    
1098
    if instance.disk_template != constants.DT_DISKLESS:
1099
      all_lvs = instance.MapLVsByNode()
1100
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
1101

    
1102
    all_macs = self._AllMACs()
1103
    for nic in instance.nics:
1104
      if nic.mac in all_macs:
1105
        raise errors.ConfigurationError("Cannot add instance %s:"
1106
                                        " MAC address '%s' already in use." %
1107
                                        (instance.name, nic.mac))
1108

    
1109
    self._EnsureUUID(instance, ec_id)
1110

    
1111
    instance.serial_no = 1
1112
    instance.ctime = instance.mtime = time.time()
1113
    self._config_data.instances[instance.name] = instance
1114
    self._config_data.cluster.serial_no += 1
1115
    self._UnlockedReleaseDRBDMinors(instance.name)
1116
    self._WriteConfig()
1117

    
1118
  def _EnsureUUID(self, item, ec_id):
1119
    """Ensures a given object has a valid UUID.
1120

1121
    @param item: the instance or node to be checked
1122
    @param ec_id: the execution context id for the uuid reservation
1123

1124
    """
1125
    if not item.uuid:
1126
      item.uuid = self._GenerateUniqueID(ec_id)
1127
    elif item.uuid in self._AllIDs(include_temporary=True):
1128
      raise errors.ConfigurationError("Cannot add '%s': UUID %s already"
1129
                                      " in use" % (item.name, item.uuid))
1130

    
1131
  def _SetInstanceStatus(self, instance_name, status):
1132
    """Set the instance's status to a given value.
1133

1134
    """
1135
    assert isinstance(status, bool), \
1136
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
1137

    
1138
    if instance_name not in self._config_data.instances:
1139
      raise errors.ConfigurationError("Unknown instance '%s'" %
1140
                                      instance_name)
1141
    instance = self._config_data.instances[instance_name]
1142
    if instance.admin_up != status:
1143
      instance.admin_up = status
1144
      instance.serial_no += 1
1145
      instance.mtime = time.time()
1146
      self._WriteConfig()
1147

    
1148
  @locking.ssynchronized(_config_lock)
1149
  def MarkInstanceUp(self, instance_name):
1150
    """Mark the instance status to up in the config.
1151

1152
    """
1153
    self._SetInstanceStatus(instance_name, True)
1154

    
1155
  @locking.ssynchronized(_config_lock)
1156
  def RemoveInstance(self, instance_name):
1157
    """Remove the instance from the configuration.
1158

1159
    """
1160
    if instance_name not in self._config_data.instances:
1161
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
1162

    
1163
    # If a network port has been allocated to the instance,
1164
    # return it to the pool of free ports.
1165
    inst = self._config_data.instances[instance_name]
1166
    network_port = getattr(inst, "network_port", None)
1167
    if network_port is not None:
1168
      self._config_data.cluster.tcpudp_port_pool.add(network_port)
1169

    
1170
    del self._config_data.instances[instance_name]
1171
    self._config_data.cluster.serial_no += 1
1172
    self._WriteConfig()
1173

    
1174
  @locking.ssynchronized(_config_lock)
1175
  def RenameInstance(self, old_name, new_name):
1176
    """Rename an instance.
1177

1178
    This needs to be done in ConfigWriter and not by RemoveInstance
1179
    combined with AddInstance as only we can guarantee an atomic
1180
    rename.
1181

1182
    """
1183
    if old_name not in self._config_data.instances:
1184
      raise errors.ConfigurationError("Unknown instance '%s'" % old_name)
1185
    inst = self._config_data.instances[old_name]
1186
    del self._config_data.instances[old_name]
1187
    inst.name = new_name
1188

    
1189
    for disk in inst.disks:
1190
      if disk.dev_type == constants.LD_FILE:
1191
        # rename the file paths in logical and physical id
1192
        file_storage_dir = os.path.dirname(os.path.dirname(disk.logical_id[1]))
1193
        disk_fname = "disk%s" % disk.iv_name.split("/")[1]
1194
        disk.physical_id = disk.logical_id = (disk.logical_id[0],
1195
                                              utils.PathJoin(file_storage_dir,
1196
                                                             inst.name,
1197
                                                             disk_fname))
1198

    
1199
    # Force update of ssconf files
1200
    self._config_data.cluster.serial_no += 1
1201

    
1202
    self._config_data.instances[inst.name] = inst
1203
    self._WriteConfig()
1204

    
1205
  @locking.ssynchronized(_config_lock)
1206
  def MarkInstanceDown(self, instance_name):
1207
    """Mark the status of an instance to down in the configuration.
1208

1209
    """
1210
    self._SetInstanceStatus(instance_name, False)
1211

    
1212
  def _UnlockedGetInstanceList(self):
1213
    """Get the list of instances.
1214

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

1217
    """
1218
    return self._config_data.instances.keys()
1219

    
1220
  @locking.ssynchronized(_config_lock, shared=1)
1221
  def GetInstanceList(self):
1222
    """Get the list of instances.
1223

1224
    @return: array of instances, ex. ['instance2.example.com',
1225
        'instance1.example.com']
1226

1227
    """
1228
    return self._UnlockedGetInstanceList()
1229

    
1230
  def ExpandInstanceName(self, short_name):
1231
    """Attempt to expand an incomplete instance name.
1232

1233
    """
1234
    # Locking is done in L{ConfigWriter.GetInstanceList}
1235
    return _MatchNameComponentIgnoreCase(short_name, self.GetInstanceList())
1236

    
1237
  def _UnlockedGetInstanceInfo(self, instance_name):
1238
    """Returns information about an instance.
1239

1240
    This function is for internal use, when the config lock is already held.
1241

1242
    """
1243
    if instance_name not in self._config_data.instances:
1244
      return None
1245

    
1246
    return self._config_data.instances[instance_name]
1247

    
1248
  @locking.ssynchronized(_config_lock, shared=1)
1249
  def GetInstanceInfo(self, instance_name):
1250
    """Returns information about an instance.
1251

1252
    It takes the information from the configuration file. Other information of
1253
    an instance are taken from the live systems.
1254

1255
    @param instance_name: name of the instance, e.g.
1256
        I{instance1.example.com}
1257

1258
    @rtype: L{objects.Instance}
1259
    @return: the instance object
1260

1261
    """
1262
    return self._UnlockedGetInstanceInfo(instance_name)
1263

    
1264
  @locking.ssynchronized(_config_lock, shared=1)
1265
  def GetInstanceNodeGroups(self, instance_name, primary_only=False):
1266
    """Returns set of node group UUIDs for instance's nodes.
1267

1268
    @rtype: frozenset
1269

1270
    """
1271
    instance = self._UnlockedGetInstanceInfo(instance_name)
1272
    if not instance:
1273
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
1274

    
1275
    if primary_only:
1276
      nodes = [instance.primary_node]
1277
    else:
1278
      nodes = instance.all_nodes
1279

    
1280
    return frozenset(self._UnlockedGetNodeInfo(node_name).group
1281
                     for node_name in nodes)
1282

    
1283
  @locking.ssynchronized(_config_lock, shared=1)
1284
  def GetMultiInstanceInfo(self, instances):
1285
    """Get the configuration of multiple instances.
1286

1287
    @param instances: list of instance names
1288
    @rtype: list
1289
    @return: list of tuples (instance, instance_info), where
1290
        instance_info is what would GetInstanceInfo return for the
1291
        node, while keeping the original order
1292

1293
    """
1294
    return [(name, self._UnlockedGetInstanceInfo(name)) for name in instances]
1295

    
1296
  @locking.ssynchronized(_config_lock, shared=1)
1297
  def GetAllInstancesInfo(self):
1298
    """Get the configuration of all instances.
1299

1300
    @rtype: dict
1301
    @return: dict of (instance, instance_info), where instance_info is what
1302
              would GetInstanceInfo return for the node
1303

1304
    """
1305
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
1306
                    for instance in self._UnlockedGetInstanceList()])
1307
    return my_dict
1308

    
1309
  @locking.ssynchronized(_config_lock)
1310
  def AddNode(self, node, ec_id):
1311
    """Add a node to the configuration.
1312

1313
    @type node: L{objects.Node}
1314
    @param node: a Node instance
1315

1316
    """
1317
    logging.info("Adding node %s to configuration", node.name)
1318

    
1319
    self._EnsureUUID(node, ec_id)
1320

    
1321
    node.serial_no = 1
1322
    node.ctime = node.mtime = time.time()
1323
    self._UnlockedAddNodeToGroup(node.name, node.group)
1324
    self._config_data.nodes[node.name] = node
1325
    self._config_data.cluster.serial_no += 1
1326
    self._WriteConfig()
1327

    
1328
  @locking.ssynchronized(_config_lock)
1329
  def RemoveNode(self, node_name):
1330
    """Remove a node from the configuration.
1331

1332
    """
1333
    logging.info("Removing node %s from configuration", node_name)
1334

    
1335
    if node_name not in self._config_data.nodes:
1336
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
1337

    
1338
    self._UnlockedRemoveNodeFromGroup(self._config_data.nodes[node_name])
1339
    del self._config_data.nodes[node_name]
1340
    self._config_data.cluster.serial_no += 1
1341
    self._WriteConfig()
1342

    
1343
  def ExpandNodeName(self, short_name):
1344
    """Attempt to expand an incomplete node name.
1345

1346
    """
1347
    # Locking is done in L{ConfigWriter.GetNodeList}
1348
    return _MatchNameComponentIgnoreCase(short_name, self.GetNodeList())
1349

    
1350
  def _UnlockedGetNodeInfo(self, node_name):
1351
    """Get the configuration of a node, as stored in the config.
1352

1353
    This function is for internal use, when the config lock is already
1354
    held.
1355

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

1358
    @rtype: L{objects.Node}
1359
    @return: the node object
1360

1361
    """
1362
    if node_name not in self._config_data.nodes:
1363
      return None
1364

    
1365
    return self._config_data.nodes[node_name]
1366

    
1367
  @locking.ssynchronized(_config_lock, shared=1)
1368
  def GetNodeInfo(self, node_name):
1369
    """Get the configuration of a node, as stored in the config.
1370

1371
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
1372

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

1375
    @rtype: L{objects.Node}
1376
    @return: the node object
1377

1378
    """
1379
    return self._UnlockedGetNodeInfo(node_name)
1380

    
1381
  @locking.ssynchronized(_config_lock, shared=1)
1382
  def GetNodeInstances(self, node_name):
1383
    """Get the instances of a node, as stored in the config.
1384

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

1387
    @rtype: (list, list)
1388
    @return: a tuple with two lists: the primary and the secondary instances
1389

1390
    """
1391
    pri = []
1392
    sec = []
1393
    for inst in self._config_data.instances.values():
1394
      if inst.primary_node == node_name:
1395
        pri.append(inst.name)
1396
      if node_name in inst.secondary_nodes:
1397
        sec.append(inst.name)
1398
    return (pri, sec)
1399

    
1400
  @locking.ssynchronized(_config_lock, shared=1)
1401
  def GetNodeGroupInstances(self, uuid, primary_only=False):
1402
    """Get the instances of a node group.
1403

1404
    @param uuid: Node group UUID
1405
    @param primary_only: Whether to only consider primary nodes
1406
    @rtype: frozenset
1407
    @return: List of instance names in node group
1408

1409
    """
1410
    if primary_only:
1411
      nodes_fn = lambda inst: [inst.primary_node]
1412
    else:
1413
      nodes_fn = lambda inst: inst.all_nodes
1414

    
1415
    return frozenset(inst.name
1416
                     for inst in self._config_data.instances.values()
1417
                     for node_name in nodes_fn(inst)
1418
                     if self._UnlockedGetNodeInfo(node_name).group == uuid)
1419

    
1420
  def _UnlockedGetNodeList(self):
1421
    """Return the list of nodes which are in the configuration.
1422

1423
    This function is for internal use, when the config lock is already
1424
    held.
1425

1426
    @rtype: list
1427

1428
    """
1429
    return self._config_data.nodes.keys()
1430

    
1431
  @locking.ssynchronized(_config_lock, shared=1)
1432
  def GetNodeList(self):
1433
    """Return the list of nodes which are in the configuration.
1434

1435
    """
1436
    return self._UnlockedGetNodeList()
1437

    
1438
  def _UnlockedGetOnlineNodeList(self):
1439
    """Return the list of nodes which are online.
1440

1441
    """
1442
    all_nodes = [self._UnlockedGetNodeInfo(node)
1443
                 for node in self._UnlockedGetNodeList()]
1444
    return [node.name for node in all_nodes if not node.offline]
1445

    
1446
  @locking.ssynchronized(_config_lock, shared=1)
1447
  def GetOnlineNodeList(self):
1448
    """Return the list of nodes which are online.
1449

1450
    """
1451
    return self._UnlockedGetOnlineNodeList()
1452

    
1453
  @locking.ssynchronized(_config_lock, shared=1)
1454
  def GetVmCapableNodeList(self):
1455
    """Return the list of nodes which are not vm capable.
1456

1457
    """
1458
    all_nodes = [self._UnlockedGetNodeInfo(node)
1459
                 for node in self._UnlockedGetNodeList()]
1460
    return [node.name for node in all_nodes if node.vm_capable]
1461

    
1462
  @locking.ssynchronized(_config_lock, shared=1)
1463
  def GetNonVmCapableNodeList(self):
1464
    """Return the list of nodes which are not vm capable.
1465

1466
    """
1467
    all_nodes = [self._UnlockedGetNodeInfo(node)
1468
                 for node in self._UnlockedGetNodeList()]
1469
    return [node.name for node in all_nodes if not node.vm_capable]
1470

    
1471
  @locking.ssynchronized(_config_lock, shared=1)
1472
  def GetMultiNodeInfo(self, nodes):
1473
    """Get the configuration of multiple nodes.
1474

1475
    @param nodes: list of node names
1476
    @rtype: list
1477
    @return: list of tuples of (node, node_info), where node_info is
1478
        what would GetNodeInfo return for the node, in the original
1479
        order
1480

1481
    """
1482
    return [(name, self._UnlockedGetNodeInfo(name)) for name in nodes]
1483

    
1484
  @locking.ssynchronized(_config_lock, shared=1)
1485
  def GetAllNodesInfo(self):
1486
    """Get the configuration of all nodes.
1487

1488
    @rtype: dict
1489
    @return: dict of (node, node_info), where node_info is what
1490
              would GetNodeInfo return for the node
1491

1492
    """
1493
    my_dict = dict([(node, self._UnlockedGetNodeInfo(node))
1494
                    for node in self._UnlockedGetNodeList()])
1495
    return my_dict
1496

    
1497
  @locking.ssynchronized(_config_lock, shared=1)
1498
  def GetNodeGroupsFromNodes(self, nodes):
1499
    """Returns groups for a list of nodes.
1500

1501
    @type nodes: list of string
1502
    @param nodes: List of node names
1503
    @rtype: frozenset
1504

1505
    """
1506
    return frozenset(self._UnlockedGetNodeInfo(name).group for name in nodes)
1507

    
1508
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1509
    """Get the number of current and maximum desired and possible candidates.
1510

1511
    @type exceptions: list
1512
    @param exceptions: if passed, list of nodes that should be ignored
1513
    @rtype: tuple
1514
    @return: tuple of (current, desired and possible, possible)
1515

1516
    """
1517
    mc_now = mc_should = mc_max = 0
1518
    for node in self._config_data.nodes.values():
1519
      if exceptions and node.name in exceptions:
1520
        continue
1521
      if not (node.offline or node.drained) and node.master_capable:
1522
        mc_max += 1
1523
      if node.master_candidate:
1524
        mc_now += 1
1525
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
1526
    return (mc_now, mc_should, mc_max)
1527

    
1528
  @locking.ssynchronized(_config_lock, shared=1)
1529
  def GetMasterCandidateStats(self, exceptions=None):
1530
    """Get the number of current and maximum possible candidates.
1531

1532
    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.
1533

1534
    @type exceptions: list
1535
    @param exceptions: if passed, list of nodes that should be ignored
1536
    @rtype: tuple
1537
    @return: tuple of (current, max)
1538

1539
    """
1540
    return self._UnlockedGetMasterCandidateStats(exceptions)
1541

    
1542
  @locking.ssynchronized(_config_lock)
1543
  def MaintainCandidatePool(self, exceptions):
1544
    """Try to grow the candidate pool to the desired size.
1545

1546
    @type exceptions: list
1547
    @param exceptions: if passed, list of nodes that should be ignored
1548
    @rtype: list
1549
    @return: list with the adjusted nodes (L{objects.Node} instances)
1550

1551
    """
1552
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1553
    mod_list = []
1554
    if mc_now < mc_max:
1555
      node_list = self._config_data.nodes.keys()
1556
      random.shuffle(node_list)
1557
      for name in node_list:
1558
        if mc_now >= mc_max:
1559
          break
1560
        node = self._config_data.nodes[name]
1561
        if (node.master_candidate or node.offline or node.drained or
1562
            node.name in exceptions or not node.master_capable):
1563
          continue
1564
        mod_list.append(node)
1565
        node.master_candidate = True
1566
        node.serial_no += 1
1567
        mc_now += 1
1568
      if mc_now != mc_max:
1569
        # this should not happen
1570
        logging.warning("Warning: MaintainCandidatePool didn't manage to"
1571
                        " fill the candidate pool (%d/%d)", mc_now, mc_max)
1572
      if mod_list:
1573
        self._config_data.cluster.serial_no += 1
1574
        self._WriteConfig()
1575

    
1576
    return mod_list
1577

    
1578
  def _UnlockedAddNodeToGroup(self, node_name, nodegroup_uuid):
1579
    """Add a given node to the specified group.
1580

1581
    """
1582
    if nodegroup_uuid not in self._config_data.nodegroups:
1583
      # This can happen if a node group gets deleted between its lookup and
1584
      # when we're adding the first node to it, since we don't keep a lock in
1585
      # the meantime. It's ok though, as we'll fail cleanly if the node group
1586
      # is not found anymore.
1587
      raise errors.OpExecError("Unknown node group: %s" % nodegroup_uuid)
1588
    if node_name not in self._config_data.nodegroups[nodegroup_uuid].members:
1589
      self._config_data.nodegroups[nodegroup_uuid].members.append(node_name)
1590

    
1591
  def _UnlockedRemoveNodeFromGroup(self, node):
1592
    """Remove a given node from its group.
1593

1594
    """
1595
    nodegroup = node.group
1596
    if nodegroup not in self._config_data.nodegroups:
1597
      logging.warning("Warning: node '%s' has unknown node group '%s'"
1598
                      " (while being removed from it)", node.name, nodegroup)
1599
    nodegroup_obj = self._config_data.nodegroups[nodegroup]
1600
    if node.name not in nodegroup_obj.members:
1601
      logging.warning("Warning: node '%s' not a member of its node group '%s'"
1602
                      " (while being removed from it)", node.name, nodegroup)
1603
    else:
1604
      nodegroup_obj.members.remove(node.name)
1605

    
1606
  @locking.ssynchronized(_config_lock)
1607
  def AssignGroupNodes(self, mods):
1608
    """Changes the group of a number of nodes.
1609

1610
    @type mods: list of tuples; (node name, new group UUID)
1611
    @param mods: Node membership modifications
1612

1613
    """
1614
    groups = self._config_data.nodegroups
1615
    nodes = self._config_data.nodes
1616

    
1617
    resmod = []
1618

    
1619
    # Try to resolve names/UUIDs first
1620
    for (node_name, new_group_uuid) in mods:
1621
      try:
1622
        node = nodes[node_name]
1623
      except KeyError:
1624
        raise errors.ConfigurationError("Unable to find node '%s'" % node_name)
1625

    
1626
      if node.group == new_group_uuid:
1627
        # Node is being assigned to its current group
1628
        logging.debug("Node '%s' was assigned to its current group (%s)",
1629
                      node_name, node.group)
1630
        continue
1631

    
1632
      # Try to find current group of node
1633
      try:
1634
        old_group = groups[node.group]
1635
      except KeyError:
1636
        raise errors.ConfigurationError("Unable to find old group '%s'" %
1637
                                        node.group)
1638

    
1639
      # Try to find new group for node
1640
      try:
1641
        new_group = groups[new_group_uuid]
1642
      except KeyError:
1643
        raise errors.ConfigurationError("Unable to find new group '%s'" %
1644
                                        new_group_uuid)
1645

    
1646
      assert node.name in old_group.members, \
1647
        ("Inconsistent configuration: node '%s' not listed in members for its"
1648
         " old group '%s'" % (node.name, old_group.uuid))
1649
      assert node.name not in new_group.members, \
1650
        ("Inconsistent configuration: node '%s' already listed in members for"
1651
         " its new group '%s'" % (node.name, new_group.uuid))
1652

    
1653
      resmod.append((node, old_group, new_group))
1654

    
1655
    # Apply changes
1656
    for (node, old_group, new_group) in resmod:
1657
      assert node.uuid != new_group.uuid and old_group.uuid != new_group.uuid, \
1658
        "Assigning to current group is not possible"
1659

    
1660
      node.group = new_group.uuid
1661

    
1662
      # Update members of involved groups
1663
      if node.name in old_group.members:
1664
        old_group.members.remove(node.name)
1665
      if node.name not in new_group.members:
1666
        new_group.members.append(node.name)
1667

    
1668
    # Update timestamps and serials (only once per node/group object)
1669
    now = time.time()
1670
    for obj in frozenset(itertools.chain(*resmod)): # pylint: disable-msg=W0142
1671
      obj.serial_no += 1
1672
      obj.mtime = now
1673

    
1674
    # Force ssconf update
1675
    self._config_data.cluster.serial_no += 1
1676

    
1677
    self._WriteConfig()
1678

    
1679
  def _BumpSerialNo(self):
1680
    """Bump up the serial number of the config.
1681

1682
    """
1683
    self._config_data.serial_no += 1
1684
    self._config_data.mtime = time.time()
1685

    
1686
  def _AllUUIDObjects(self):
1687
    """Returns all objects with uuid attributes.
1688

1689
    """
1690
    return (self._config_data.instances.values() +
1691
            self._config_data.nodes.values() +
1692
            self._config_data.nodegroups.values() +
1693
            [self._config_data.cluster])
1694

    
1695
  def _OpenConfig(self, accept_foreign):
1696
    """Read the config data from disk.
1697

1698
    """
1699
    raw_data = utils.ReadFile(self._cfg_file)
1700

    
1701
    try:
1702
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
1703
    except Exception, err:
1704
      raise errors.ConfigurationError(err)
1705

    
1706
    # Make sure the configuration has the right version
1707
    _ValidateConfig(data)
1708

    
1709
    if (not hasattr(data, 'cluster') or
1710
        not hasattr(data.cluster, 'rsahostkeypub')):
1711
      raise errors.ConfigurationError("Incomplete configuration"
1712
                                      " (missing cluster.rsahostkeypub)")
1713

    
1714
    if data.cluster.master_node != self._my_hostname and not accept_foreign:
1715
      msg = ("The configuration denotes node %s as master, while my"
1716
             " hostname is %s; opening a foreign configuration is only"
1717
             " possible in accept_foreign mode" %
1718
             (data.cluster.master_node, self._my_hostname))
1719
      raise errors.ConfigurationError(msg)
1720

    
1721
    # Upgrade configuration if needed
1722
    data.UpgradeConfig()
1723

    
1724
    self._config_data = data
1725
    # reset the last serial as -1 so that the next write will cause
1726
    # ssconf update
1727
    self._last_cluster_serial = -1
1728

    
1729
    # And finally run our (custom) config upgrade sequence
1730
    self._UpgradeConfig()
1731

    
1732
    self._cfg_id = utils.GetFileID(path=self._cfg_file)
1733

    
1734
  def _UpgradeConfig(self):
1735
    """Run upgrade steps that cannot be done purely in the objects.
1736

1737
    This is because some data elements need uniqueness across the
1738
    whole configuration, etc.
1739

1740
    @warning: this function will call L{_WriteConfig()}, but also
1741
        L{DropECReservations} so it needs to be called only from a
1742
        "safe" place (the constructor). If one wanted to call it with
1743
        the lock held, a DropECReservationUnlocked would need to be
1744
        created first, to avoid causing deadlock.
1745

1746
    """
1747
    modified = False
1748
    for item in self._AllUUIDObjects():
1749
      if item.uuid is None:
1750
        item.uuid = self._GenerateUniqueID(_UPGRADE_CONFIG_JID)
1751
        modified = True
1752
    if not self._config_data.nodegroups:
1753
      default_nodegroup_name = constants.INITIAL_NODE_GROUP_NAME
1754
      default_nodegroup = objects.NodeGroup(name=default_nodegroup_name,
1755
                                            members=[])
1756
      self._UnlockedAddNodeGroup(default_nodegroup, _UPGRADE_CONFIG_JID, True)
1757
      modified = True
1758
    for node in self._config_data.nodes.values():
1759
      if not node.group:
1760
        node.group = self.LookupNodeGroup(None)
1761
        modified = True
1762
      # This is technically *not* an upgrade, but needs to be done both when
1763
      # nodegroups are being added, and upon normally loading the config,
1764
      # because the members list of a node group is discarded upon
1765
      # serializing/deserializing the object.
1766
      self._UnlockedAddNodeToGroup(node.name, node.group)
1767
    if modified:
1768
      self._WriteConfig()
1769
      # This is ok even if it acquires the internal lock, as _UpgradeConfig is
1770
      # only called at config init time, without the lock held
1771
      self.DropECReservations(_UPGRADE_CONFIG_JID)
1772

    
1773
  def _DistributeConfig(self, feedback_fn):
1774
    """Distribute the configuration to the other nodes.
1775

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

1779
    """
1780
    if self._offline:
1781
      return True
1782

    
1783
    bad = False
1784

    
1785
    node_list = []
1786
    addr_list = []
1787
    myhostname = self._my_hostname
1788
    # we can skip checking whether _UnlockedGetNodeInfo returns None
1789
    # since the node list comes from _UnlocketGetNodeList, and we are
1790
    # called with the lock held, so no modifications should take place
1791
    # in between
1792
    for node_name in self._UnlockedGetNodeList():
1793
      if node_name == myhostname:
1794
        continue
1795
      node_info = self._UnlockedGetNodeInfo(node_name)
1796
      if not node_info.master_candidate:
1797
        continue
1798
      node_list.append(node_info.name)
1799
      addr_list.append(node_info.primary_ip)
1800

    
1801
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
1802
                                            address_list=addr_list)
1803
    for to_node, to_result in result.items():
1804
      msg = to_result.fail_msg
1805
      if msg:
1806
        msg = ("Copy of file %s to node %s failed: %s" %
1807
               (self._cfg_file, to_node, msg))
1808
        logging.error(msg)
1809

    
1810
        if feedback_fn:
1811
          feedback_fn(msg)
1812

    
1813
        bad = True
1814

    
1815
    return not bad
1816

    
1817
  def _WriteConfig(self, destination=None, feedback_fn=None):
1818
    """Write the configuration data to persistent storage.
1819

1820
    """
1821
    assert feedback_fn is None or callable(feedback_fn)
1822

    
1823
    # Warn on config errors, but don't abort the save - the
1824
    # configuration has already been modified, and we can't revert;
1825
    # the best we can do is to warn the user and save as is, leaving
1826
    # recovery to the user
1827
    config_errors = self._UnlockedVerifyConfig()
1828
    if config_errors:
1829
      errmsg = ("Configuration data is not consistent: %s" %
1830
                (utils.CommaJoin(config_errors)))
1831
      logging.critical(errmsg)
1832
      if feedback_fn:
1833
        feedback_fn(errmsg)
1834

    
1835
    if destination is None:
1836
      destination = self._cfg_file
1837
    self._BumpSerialNo()
1838
    txt = serializer.Dump(self._config_data.ToDict())
1839

    
1840
    getents = self._getents()
1841
    try:
1842
      fd = utils.SafeWriteFile(destination, self._cfg_id, data=txt,
1843
                               close=False, gid=getents.confd_gid, mode=0640)
1844
    except errors.LockError:
1845
      raise errors.ConfigurationError("The configuration file has been"
1846
                                      " modified since the last write, cannot"
1847
                                      " update")
1848
    try:
1849
      self._cfg_id = utils.GetFileID(fd=fd)
1850
    finally:
1851
      os.close(fd)
1852

    
1853
    self.write_count += 1
1854

    
1855
    # and redistribute the config file to master candidates
1856
    self._DistributeConfig(feedback_fn)
1857

    
1858
    # Write ssconf files on all nodes (including locally)
1859
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1860
      if not self._offline:
1861
        result = rpc.RpcRunner.call_write_ssconf_files(
1862
          self._UnlockedGetOnlineNodeList(),
1863
          self._UnlockedGetSsconfValues())
1864

    
1865
        for nname, nresu in result.items():
1866
          msg = nresu.fail_msg
1867
          if msg:
1868
            errmsg = ("Error while uploading ssconf files to"
1869
                      " node %s: %s" % (nname, msg))
1870
            logging.warning(errmsg)
1871

    
1872
            if feedback_fn:
1873
              feedback_fn(errmsg)
1874

    
1875
      self._last_cluster_serial = self._config_data.cluster.serial_no
1876

    
1877
  def _UnlockedGetSsconfValues(self):
1878
    """Return the values needed by ssconf.
1879

1880
    @rtype: dict
1881
    @return: a dictionary with keys the ssconf names and values their
1882
        associated value
1883

1884
    """
1885
    fn = "\n".join
1886
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1887
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
1888
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]
1889
    node_pri_ips = ["%s %s" % (ninfo.name, ninfo.primary_ip)
1890
                    for ninfo in node_info]
1891
    node_snd_ips = ["%s %s" % (ninfo.name, ninfo.secondary_ip)
1892
                    for ninfo in node_info]
1893

    
1894
    instance_data = fn(instance_names)
1895
    off_data = fn(node.name for node in node_info if node.offline)
1896
    on_data = fn(node.name for node in node_info if not node.offline)
1897
    mc_data = fn(node.name for node in node_info if node.master_candidate)
1898
    mc_ips_data = fn(node.primary_ip for node in node_info
1899
                     if node.master_candidate)
1900
    node_data = fn(node_names)
1901
    node_pri_ips_data = fn(node_pri_ips)
1902
    node_snd_ips_data = fn(node_snd_ips)
1903

    
1904
    cluster = self._config_data.cluster
1905
    cluster_tags = fn(cluster.GetTags())
1906

    
1907
    hypervisor_list = fn(cluster.enabled_hypervisors)
1908

    
1909
    uid_pool = uidpool.FormatUidPool(cluster.uid_pool, separator="\n")
1910

    
1911
    nodegroups = ["%s %s" % (nodegroup.uuid, nodegroup.name) for nodegroup in
1912
                  self._config_data.nodegroups.values()]
1913
    nodegroups_data = fn(utils.NiceSort(nodegroups))
1914

    
1915
    ssconf_values = {
1916
      constants.SS_CLUSTER_NAME: cluster.cluster_name,
1917
      constants.SS_CLUSTER_TAGS: cluster_tags,
1918
      constants.SS_FILE_STORAGE_DIR: cluster.file_storage_dir,
1919
      constants.SS_SHARED_FILE_STORAGE_DIR: cluster.shared_file_storage_dir,
1920
      constants.SS_MASTER_CANDIDATES: mc_data,
1921
      constants.SS_MASTER_CANDIDATES_IPS: mc_ips_data,
1922
      constants.SS_MASTER_IP: cluster.master_ip,
1923
      constants.SS_MASTER_NETDEV: cluster.master_netdev,
1924
      constants.SS_MASTER_NODE: cluster.master_node,
1925
      constants.SS_NODE_LIST: node_data,
1926
      constants.SS_NODE_PRIMARY_IPS: node_pri_ips_data,
1927
      constants.SS_NODE_SECONDARY_IPS: node_snd_ips_data,
1928
      constants.SS_OFFLINE_NODES: off_data,
1929
      constants.SS_ONLINE_NODES: on_data,
1930
      constants.SS_PRIMARY_IP_FAMILY: str(cluster.primary_ip_family),
1931
      constants.SS_INSTANCE_LIST: instance_data,
1932
      constants.SS_RELEASE_VERSION: constants.RELEASE_VERSION,
1933
      constants.SS_HYPERVISOR_LIST: hypervisor_list,
1934
      constants.SS_MAINTAIN_NODE_HEALTH: str(cluster.maintain_node_health),
1935
      constants.SS_UID_POOL: uid_pool,
1936
      constants.SS_NODEGROUPS: nodegroups_data,
1937
      }
1938
    bad_values = [(k, v) for k, v in ssconf_values.items()
1939
                  if not isinstance(v, (str, basestring))]
1940
    if bad_values:
1941
      err = utils.CommaJoin("%s=%s" % (k, v) for k, v in bad_values)
1942
      raise errors.ConfigurationError("Some ssconf key(s) have non-string"
1943
                                      " values: %s" % err)
1944
    return ssconf_values
1945

    
1946
  @locking.ssynchronized(_config_lock, shared=1)
1947
  def GetSsconfValues(self):
1948
    """Wrapper using lock around _UnlockedGetSsconf().
1949

1950
    """
1951
    return self._UnlockedGetSsconfValues()
1952

    
1953
  @locking.ssynchronized(_config_lock, shared=1)
1954
  def GetVGName(self):
1955
    """Return the volume group name.
1956

1957
    """
1958
    return self._config_data.cluster.volume_group_name
1959

    
1960
  @locking.ssynchronized(_config_lock)
1961
  def SetVGName(self, vg_name):
1962
    """Set the volume group name.
1963

1964
    """
1965
    self._config_data.cluster.volume_group_name = vg_name
1966
    self._config_data.cluster.serial_no += 1
1967
    self._WriteConfig()
1968

    
1969
  @locking.ssynchronized(_config_lock, shared=1)
1970
  def GetDRBDHelper(self):
1971
    """Return DRBD usermode helper.
1972

1973
    """
1974
    return self._config_data.cluster.drbd_usermode_helper
1975

    
1976
  @locking.ssynchronized(_config_lock)
1977
  def SetDRBDHelper(self, drbd_helper):
1978
    """Set DRBD usermode helper.
1979

1980
    """
1981
    self._config_data.cluster.drbd_usermode_helper = drbd_helper
1982
    self._config_data.cluster.serial_no += 1
1983
    self._WriteConfig()
1984

    
1985
  @locking.ssynchronized(_config_lock, shared=1)
1986
  def GetMACPrefix(self):
1987
    """Return the mac prefix.
1988

1989
    """
1990
    return self._config_data.cluster.mac_prefix
1991

    
1992
  @locking.ssynchronized(_config_lock, shared=1)
1993
  def GetClusterInfo(self):
1994
    """Returns information about the cluster
1995

1996
    @rtype: L{objects.Cluster}
1997
    @return: the cluster object
1998

1999
    """
2000
    return self._config_data.cluster
2001

    
2002
  @locking.ssynchronized(_config_lock, shared=1)
2003
  def HasAnyDiskOfType(self, dev_type):
2004
    """Check if in there is at disk of the given type in the configuration.
2005

2006
    """
2007
    return self._config_data.HasAnyDiskOfType(dev_type)
2008

    
2009
  @locking.ssynchronized(_config_lock)
2010
  def Update(self, target, feedback_fn):
2011
    """Notify function to be called after updates.
2012

2013
    This function must be called when an object (as returned by
2014
    GetInstanceInfo, GetNodeInfo, GetCluster) has been updated and the
2015
    caller wants the modifications saved to the backing store. Note
2016
    that all modified objects will be saved, but the target argument
2017
    is the one the caller wants to ensure that it's saved.
2018

2019
    @param target: an instance of either L{objects.Cluster},
2020
        L{objects.Node} or L{objects.Instance} which is existing in
2021
        the cluster
2022
    @param feedback_fn: Callable feedback function
2023

2024
    """
2025
    if self._config_data is None:
2026
      raise errors.ProgrammerError("Configuration file not read,"
2027
                                   " cannot save.")
2028
    update_serial = False
2029
    if isinstance(target, objects.Cluster):
2030
      test = target == self._config_data.cluster
2031
    elif isinstance(target, objects.Node):
2032
      test = target in self._config_data.nodes.values()
2033
      update_serial = True
2034
    elif isinstance(target, objects.Instance):
2035
      test = target in self._config_data.instances.values()
2036
    elif isinstance(target, objects.NodeGroup):
2037
      test = target in self._config_data.nodegroups.values()
2038
    else:
2039
      raise errors.ProgrammerError("Invalid object type (%s) passed to"
2040
                                   " ConfigWriter.Update" % type(target))
2041
    if not test:
2042
      raise errors.ConfigurationError("Configuration updated since object"
2043
                                      " has been read or unknown object")
2044
    target.serial_no += 1
2045
    target.mtime = now = time.time()
2046

    
2047
    if update_serial:
2048
      # for node updates, we need to increase the cluster serial too
2049
      self._config_data.cluster.serial_no += 1
2050
      self._config_data.cluster.mtime = now
2051

    
2052
    if isinstance(target, objects.Instance):
2053
      self._UnlockedReleaseDRBDMinors(target.name)
2054

    
2055
    self._WriteConfig(feedback_fn=feedback_fn)
2056

    
2057
  @locking.ssynchronized(_config_lock)
2058
  def DropECReservations(self, ec_id):
2059
    """Drop per-execution-context reservations
2060

2061
    """
2062
    for rm in self._all_rms:
2063
      rm.DropECReservations(ec_id)