config.py 49.8 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

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


"""Configuration management for Ganeti

24
This module provides the interface to the Ganeti cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
25

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

29
30
Currently, the data storage format is JSON. YAML was slow and consuming too
much memory.
Iustin Pop's avatar
Iustin Pop committed
31
32
33

"""

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

Iustin Pop's avatar
Iustin Pop committed
37
38
import os
import random
39
import logging
40
import time
Iustin Pop's avatar
Iustin Pop committed
41
42

from ganeti import errors
43
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
44
45
46
47
from ganeti import utils
from ganeti import constants
from ganeti import rpc
from ganeti import objects
48
from ganeti import serializer
Balazs Lecz's avatar
Balazs Lecz committed
49
from ganeti import uidpool
50
from ganeti import netutils
51
52


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

55
# job id used for resource management at config upgrade time
Michael Hanselmann's avatar
Michael Hanselmann committed
56
_UPGRADE_CONFIG_JID = "jid-cfg-upgrade"
57

58

Michael Hanselmann's avatar
Michael Hanselmann committed
59
def _ValidateConfig(data):
Iustin Pop's avatar
Iustin Pop committed
60
61
62
63
64
65
66
67
  """Verifies that a configuration objects looks valid.

  This only verifies the version of the configuration.

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

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
68
  if data.version != constants.CONFIG_VERSION:
69
70
    raise errors.ConfigurationError("Cluster configuration version"
                                    " mismatch, got %s instead of %s" %
Michael Hanselmann's avatar
Michael Hanselmann committed
71
                                    (data.version,
72
                                     constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
73

74

Guido Trotter's avatar
Guido Trotter committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
class TemporaryReservationManager:
  """A temporary resource reservation manager.

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

  """
  def __init__(self):
    self._ec_reserved = {}

  def Reserved(self, resource):
    for holder_reserved in self._ec_reserved.items():
      if resource in holder_reserved:
        return True
    return False

  def Reserve(self, ec_id, resource):
    if self.Reserved(resource):
      raise errors.ReservationError("Duplicate reservation for resource: %s." %
                                    (resource))
    if ec_id not in self._ec_reserved:
      self._ec_reserved[ec_id] = set([resource])
    else:
      self._ec_reserved[ec_id].add(resource)

  def DropECReservations(self, ec_id):
    if ec_id in self._ec_reserved:
      del self._ec_reserved[ec_id]

  def GetReserved(self):
    all_reserved = set()
    for holder_reserved in self._ec_reserved.values():
      all_reserved.update(holder_reserved)
    return all_reserved

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

    """
    assert callable(generate_one_fn)

    all_elems = self.GetReserved()
    all_elems.update(existing)
    retries = 64
    while retries > 0:
      new_resource = generate_one_fn()
      if new_resource is not None and new_resource not in all_elems:
        break
    else:
      raise errors.ConfigurationError("Not able generate new resource"
                                      " (last tried: %s)" % new_resource)
    self.Reserve(ec_id, new_resource)
    return new_resource


Iustin Pop's avatar
Iustin Pop committed
130
class ConfigWriter:
131
  """The interface to the cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
132

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

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

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

    """
    return os.path.exists(constants.CLUSTER_CONF_FILE)

169
170
171
172
173
174
175
176
177
178
179
  def _GenerateOneMAC(self):
    """Generate one mac address

    """
    prefix = self._config_data.cluster.mac_prefix
    byte1 = random.randrange(0, 256)
    byte2 = random.randrange(0, 256)
    byte3 = random.randrange(0, 256)
    mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
    return mac

180
  @locking.ssynchronized(_config_lock, shared=1)
181
  def GenerateMAC(self, ec_id):
Iustin Pop's avatar
Iustin Pop committed
182
183
184
185
186
    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """
187
188
    existing = self._AllMACs()
    return self._temporary_ids.Generate(existing, self._GenerateOneMAC, ec_id)
Iustin Pop's avatar
Iustin Pop committed
189

190
  @locking.ssynchronized(_config_lock, shared=1)
191
192
  def ReserveMAC(self, mac, ec_id):
    """Reserve a MAC for an instance.
193
194
195
196
197
198

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

    """
    all_macs = self._AllMACs()
199
200
201
202
    if mac in all_macs:
      raise errors.ReservationError("mac already in use")
    else:
      self._temporary_macs.Reserve(mac, ec_id)
203

204
205
206
207
208
209
210
211
212
213
214
215
216
217
  @locking.ssynchronized(_config_lock, shared=1)
  def ReserveLV(self, lv_name, ec_id):
    """Reserve an VG/LV pair for an instance.

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

    """
    all_lvs = self._AllLVs()
    if lv_name in all_lvs:
      raise errors.ReservationError("LV already in use")
    else:
      self._temporary_lvs.Reserve(lv_name, ec_id)

218
  @locking.ssynchronized(_config_lock, shared=1)
219
  def GenerateDRBDSecret(self, ec_id):
220
221
222
223
224
    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """
225
226
227
    return self._temporary_secrets.Generate(self._AllDRBDSecrets(),
                                            utils.GenerateSecret,
                                            ec_id)
Michael Hanselmann's avatar
Michael Hanselmann committed
228

229
  def _AllLVs(self):
230
231
232
233
234
235
236
237
238
239
    """Compute the list of all LVs.

    """
    lvnames = set()
    for instance in self._config_data.instances.values():
      node_data = instance.MapLVsByNode()
      for lv_list in node_data.values():
        lvnames.update(lv_list)
    return lvnames

240
241
242
243
244
245
246
247
248
249
250
  def _AllIDs(self, include_temporary):
    """Compute the list of all UUIDs and names we have.

    @type include_temporary: boolean
    @param include_temporary: whether to include the _temporary_ids set
    @rtype: set
    @return: a set of IDs

    """
    existing = set()
    if include_temporary:
251
      existing.update(self._temporary_ids.GetReserved())
252
253
254
    existing.update(self._AllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
255
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
256
257
    return existing

258
  def _GenerateUniqueID(self, ec_id):
259
    """Generate an unique UUID.
260
261
262
263

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

Iustin Pop's avatar
Iustin Pop committed
264
265
    @rtype: string
    @return: the unique id
266
267

    """
268
269
    existing = self._AllIDs(include_temporary=False)
    return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
270

271
  @locking.ssynchronized(_config_lock, shared=1)
272
  def GenerateUniqueID(self, ec_id):
273
274
275
276
    """Generate an unique ID.

    This is just a wrapper over the unlocked version.

277
278
    @type ec_id: string
    @param ec_id: unique id for the job to reserve the id to
279
280

    """
281
    return self._GenerateUniqueID(ec_id)
282

Iustin Pop's avatar
Iustin Pop committed
283
284
285
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
286
287
288
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
289
290
291
292
293
294
295
296
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

297
298
299
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
300
301
302
    @rtype: list
    @return: the list of all DRBD secrets

303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
    """
    def helper(disk, result):
      """Recursively gather secrets from this disk."""
      if disk.dev_type == constants.DT_DRBD8:
        result.append(disk.logical_id[5])
      if disk.children:
        for child in disk.children:
          helper(child, result)

    result = []
    for instance in self._config_data.instances.values():
      for disk in instance.disks:
        helper(disk, result)

    return result

319
320
321
322
323
324
325
326
327
328
329
330
331
332
  def _CheckDiskIDs(self, disk, l_ids, p_ids):
    """Compute duplicate disk IDs

    @type disk: L{objects.Disk}
    @param disk: the disk at which to start searching
    @type l_ids: list
    @param l_ids: list of current logical ids
    @type p_ids: list
    @param p_ids: list of current physical ids
    @rtype: list
    @return: a list of error messages

    """
    result = []
333
334
335
336
337
338
339
340
341
342
    if disk.logical_id is not None:
      if disk.logical_id in l_ids:
        result.append("duplicate logical id %s" % str(disk.logical_id))
      else:
        l_ids.append(disk.logical_id)
    if disk.physical_id is not None:
      if disk.physical_id in p_ids:
        result.append("duplicate physical id %s" % str(disk.physical_id))
      else:
        p_ids.append(disk.physical_id)
343
344
345
346
347
348

    if disk.children:
      for child in disk.children:
        result.extend(self._CheckDiskIDs(child, l_ids, p_ids))
    return result

349
  def _UnlockedVerifyConfig(self):
350
351
    """Verify function.

352
353
354
355
    @rtype: list
    @return: a list of error messages; a non-empty list signifies
        configuration errors

Iustin Pop's avatar
Iustin Pop committed
356
357
358
    """
    result = []
    seen_macs = []
359
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
360
    data = self._config_data
361
362
    seen_lids = []
    seen_pids = []
363
364
365
366
367
368
369
370

    # global cluster checks
    if not data.cluster.enabled_hypervisors:
      result.append("enabled hypervisors list doesn't have any entries")
    invalid_hvs = set(data.cluster.enabled_hypervisors) - constants.HYPER_TYPES
    if invalid_hvs:
      result.append("enabled hypervisors contains invalid entries: %s" %
                    invalid_hvs)
371
372
373
374
375
    missing_hvp = (set(data.cluster.enabled_hypervisors) -
                   set(data.cluster.hvparams.keys()))
    if missing_hvp:
      result.append("hypervisor parameters missing for the enabled"
                    " hypervisor(s) %s" % utils.CommaJoin(missing_hvp))
376
377
378
379
380
381

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

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

      # gather the drbd ports for duplicate checks
      for dsk in instance.disks:
        if dsk.dev_type in constants.LDS_DRBD:
          tcp_port = dsk.logical_id[2]
          if tcp_port not in ports:
            ports[tcp_port] = []
          ports[tcp_port].append((instance.name, "drbd disk %s" % dsk.iv_name))
      # gather network port reservation
      net_port = getattr(instance, "network_port", None)
      if net_port is not None:
        if net_port not in ports:
          ports[net_port] = []
        ports[net_port].append((instance.name, "network port"))

415
416
417
418
      # instance disk verify
      for idx, disk in enumerate(instance.disks):
        result.extend(["instance '%s' disk %d error: %s" %
                       (instance.name, idx, msg) for msg in disk.Verify()])
419
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
420

421
    # cluster-wide pool of free ports
422
    for free_port in data.cluster.tcpudp_port_pool:
423
424
425
426
427
428
429
430
431
432
      if free_port not in ports:
        ports[free_port] = []
      ports[free_port].append(("cluster", "port marked as free"))

    # compute tcp/udp duplicate ports
    keys = ports.keys()
    keys.sort()
    for pnum in keys:
      pdata = ports[pnum]
      if len(pdata) > 1:
433
        txt = utils.CommaJoin(["%s/%s" % val for val in pdata])
434
435
436
437
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))

    # highest used tcp port check
    if keys:
438
      if keys[-1] > data.cluster.highest_used_port:
439
        result.append("Highest used port mismatch, saved %s, computed %s" %
440
441
                      (data.cluster.highest_used_port, keys[-1]))

442
443
444
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

445
    # master candidate checks
446
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
447
448
449
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
450

451
    # node checks
452
453
454
455
    for node_name, node in data.nodes.items():
      if node.name != node_name:
        result.append("Node '%s' is indexed by wrong name '%s'" %
                      (node.name, node_name))
456
457
458
459
460
461
      if [node.master_candidate, node.drained, node.offline].count(True) > 1:
        result.append("Node %s state is invalid: master_candidate=%s,"
                      " drain=%s, offline=%s" %
                      (node.name, node.master_candidate, node.drain,
                       node.offline))

462
    # drbd minors check
463
    _, duplicates = self._UnlockedComputeDRBDMap()
464
465
466
467
    for node, minor, instance_a, instance_b in duplicates:
      result.append("DRBD minor %d on node %s is assigned twice to instances"
                    " %s and %s" % (minor, node, instance_a, instance_b))

468
    # IP checks
469
470
471
472
473
474
475
    default_nicparams = data.cluster.nicparams[constants.PP_DEFAULT]
    ips = {}

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

    _AddIpAddress(data.cluster.master_ip, "cluster_ip")
476
477

    for node in data.nodes.values():
478
      _AddIpAddress(node.primary_ip, "node:%s/primary" % node.name)
479
      if node.secondary_ip != node.primary_ip:
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
        _AddIpAddress(node.secondary_ip, "node:%s/secondary" % node.name)

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

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

        if nic_mode == constants.NIC_MODE_BRIDGED:
          link = "bridge:%s" % nic_link
        elif nic_mode == constants.NIC_MODE_ROUTED:
          link = "route:%s" % nic_link
        else:
          raise errors.ProgrammerError("NIC mode '%s' not handled" % nic_mode)

        _AddIpAddress("%s/%s" % (link, nic.ip),
                      "instance:%s/nic:%d" % (instance.name, idx))
500
501
502
503

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

Iustin Pop's avatar
Iustin Pop committed
506
507
    return result

508
509
510
511
512
513
514
515
516
517
518
519
520
  @locking.ssynchronized(_config_lock, shared=1)
  def VerifyConfig(self):
    """Verify function.

    This is just a wrapper over L{_UnlockedVerifyConfig}.

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

    """
    return self._UnlockedVerifyConfig()

521
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
522
523
524
525
526
527
528
529
    """Convert the unique ID to the ID needed on the target nodes.

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

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

530
531
    This function is for internal use, when the config lock is already held.

Iustin Pop's avatar
Iustin Pop committed
532
533
534
    """
    if disk.children:
      for child in disk.children:
535
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
536
537
538

    if disk.logical_id is None and disk.physical_id is not None:
      return
539
    if disk.dev_type == constants.LD_DRBD8:
540
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
541
      if node_name not in (pnode, snode):
542
543
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
544
545
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
546
547
548
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
549
550
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
551
      if pnode == node_name:
552
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
553
      else: # it must be secondary, we tested above
554
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
555
556
557
558
    else:
      disk.physical_id = disk.logical_id
    return

559
560
561
562
563
564
565
566
567
568
569
570
571
572
  @locking.ssynchronized(_config_lock)
  def SetDiskID(self, disk, node_name):
    """Convert the unique ID to the ID needed on the target nodes.

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

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

    """
    return self._UnlockedSetDiskID(disk, node_name)

  @locking.ssynchronized(_config_lock)
573
574
575
576
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
577
    if not isinstance(port, int):
578
      raise errors.ProgrammerError("Invalid type passed for port")
579

580
    self._config_data.cluster.tcpudp_port_pool.add(port)
581
582
    self._WriteConfig()

583
  @locking.ssynchronized(_config_lock, shared=1)
584
  def GetPortList(self):
585
586
587
    """Returns a copy of the current port list.

    """
588
    return self._config_data.cluster.tcpudp_port_pool.copy()
589

590
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
591
592
593
  def AllocatePort(self):
    """Allocate a port.

594
595
596
    The port will be taken from the available port pool or from the
    default port range (and in this case we increase
    highest_used_port).
Iustin Pop's avatar
Iustin Pop committed
597
598

    """
599
    # If there are TCP/IP ports configured, we use them first.
600
601
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
602
603
604
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
605
606
607
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
608
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
609
610
611
612

    self._WriteConfig()
    return port

613
  def _UnlockedComputeDRBDMap(self):
614
615
    """Compute the used DRBD minor/nodes.

616
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
617
618
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
619
620
621
        an empty list), and a list of duplicates; if the duplicates
        list is not empty, the configuration is corrupted and its caller
        should raise an exception
622
623
624

    """
    def _AppendUsedPorts(instance_name, disk, used):
625
      duplicates = []
626
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
627
628
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
629
630
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
631
          if port in used[node]:
632
633
634
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
635
636
      if disk.children:
        for child in disk.children:
637
638
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
639

640
    duplicates = []
641
    my_dict = dict((node, {}) for node in self._config_data.nodes)
642
643
644
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
645
    for (node, minor), instance in self._temporary_drbds.iteritems():
646
      if minor in my_dict[node] and my_dict[node][minor] != instance:
647
648
649
650
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
651

652
653
654
655
656
657
658
659
660
661
662
  @locking.ssynchronized(_config_lock)
  def ComputeDRBDMap(self):
    """Compute the used DRBD minor/nodes.

    This is just a wrapper over L{_UnlockedComputeDRBDMap}.

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

    """
663
664
665
666
667
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
668

669
670
671
672
673
674
675
676
677
  @locking.ssynchronized(_config_lock)
  def AllocateDRBDMinor(self, nodes, instance):
    """Allocate a drbd minor.

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

678
679
680
    @type instance: string
    @param instance: the instance for which we allocate minors

681
    """
682
    assert isinstance(instance, basestring), \
683
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
684

685
686
687
688
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
689
690
691
692
693
694
695
    result = []
    for nname in nodes:
      ndata = d_map[nname]
      if not ndata:
        # no minors used, we can start at 0
        result.append(0)
        ndata[0] = instance
696
        self._temporary_drbds[(nname, 0)] = instance
697
698
699
700
701
702
703
704
705
706
        continue
      keys = ndata.keys()
      keys.sort()
      ffree = utils.FirstFree(keys)
      if ffree is None:
        # return the next minor
        # TODO: implement high-limit check
        minor = keys[-1] + 1
      else:
        minor = ffree
707
708
709
710
711
      # double-check minor against current instances
      assert minor not in d_map[nname], \
             ("Attempt to reuse allocated DRBD minor %d on node %s,"
              " already allocated to instance %s" %
              (minor, nname, d_map[nname][minor]))
712
      ndata[minor] = instance
713
714
715
716
717
718
719
720
      # double-check minor against reservation
      r_key = (nname, minor)
      assert r_key not in self._temporary_drbds, \
             ("Attempt to reuse reserved DRBD minor %d on node %s,"
              " reserved for instance %s" %
              (minor, nname, self._temporary_drbds[r_key]))
      self._temporary_drbds[r_key] = instance
      result.append(minor)
721
722
723
724
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

725
  def _UnlockedReleaseDRBDMinors(self, instance):
726
727
728
729
730
731
732
    """Release temporary drbd minors allocated for a given instance.

    @type instance: string
    @param instance: the instance for which temporary minors should be
                     released

    """
733
734
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
735
736
737
738
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
  @locking.ssynchronized(_config_lock)
  def ReleaseDRBDMinors(self, instance):
    """Release temporary drbd minors allocated for a given instance.

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

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

    @type instance: string
    @param instance: the instance for which temporary minors should be
                     released

    """
    self._UnlockedReleaseDRBDMinors(instance)

756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
  @locking.ssynchronized(_config_lock, shared=1)
  def GetConfigVersion(self):
    """Get the configuration version.

    @return: Config version

    """
    return self._config_data.version

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

    @return: Cluster name

    """
    return self._config_data.cluster.cluster_name

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

    @return: Master hostname

    """
    return self._config_data.cluster.master_node

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

    @return: Master IP

    """
    return self._config_data.cluster.master_ip

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

    """
    return self._config_data.cluster.master_netdev

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

    """
    return self._config_data.cluster.file_storage_dir

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

    """
811
    return self._config_data.cluster.enabled_hypervisors[0]
812

813
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
814
815
816
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
817
818
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
819
820
821
822

    """
    return self._config_data.cluster.rsahostkeypub

823
824
825
826
827
828
829
  @locking.ssynchronized(_config_lock, shared=1)
  def GetDefaultIAllocator(self):
    """Get the default instance allocator for this cluster.

    """
    return self._config_data.cluster.default_iallocator

830
831
832
833
834
835
836
837
838
  @locking.ssynchronized(_config_lock, shared=1)
  def GetPrimaryIPFamily(self):
    """Get cluster primary ip family.

    @return: primary ip family

    """
    return self._config_data.cluster.primary_ip_family

839
  @locking.ssynchronized(_config_lock)
840
  def AddInstance(self, instance, ec_id):
Iustin Pop's avatar
Iustin Pop committed
841
842
843
844
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
845
846
847
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
848
849
850
851
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

852
853
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
854
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
855

856
857
858
859
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
860
861
862
                                        " MAC address '%s' already in use." %
                                        (instance.name, nic.mac))

863
    self._EnsureUUID(instance, ec_id)
864

865
    instance.serial_no = 1
866
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
867
    self._config_data.instances[instance.name] = instance
868
    self._config_data.cluster.serial_no += 1
869
    self._UnlockedReleaseDRBDMinors(instance.name)
Iustin Pop's avatar
Iustin Pop committed
870
871
    self._WriteConfig()

872
  def _EnsureUUID(self, item, ec_id):
873
874
875
    """Ensures a given object has a valid UUID.

    @param item: the instance or node to be checked
876
    @param ec_id: the execution context id for the uuid reservation
877
878
879

    """
    if not item.uuid:
880
      item.uuid = self._GenerateUniqueID(ec_id)
881
882
883
    elif item.uuid in self._AllIDs(include_temporary=True):
      raise errors.ConfigurationError("Cannot add '%s': UUID %s already"
                                      " in use" % (item.name, item.uuid))
884

885
886
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
887
888

    """
889
890
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
891
892

    if instance_name not in self._config_data.instances:
893
894
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
895
    instance = self._config_data.instances[instance_name]
896
897
    if instance.admin_up != status:
      instance.admin_up = status
898
      instance.serial_no += 1
899
      instance.mtime = time.time()
900
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
901

902
  @locking.ssynchronized(_config_lock)
903
904
905
906
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
907
    self._SetInstanceStatus(instance_name, True)
908

909
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
910
911
912
913
914
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
915
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
916
    del self._config_data.instances[instance_name]
917
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
918
919
    self._WriteConfig()

920
  @locking.ssynchronized(_config_lock)
921
922
923
924
925
926
927
928
929
930
931
932
933
  def RenameInstance(self, old_name, new_name):
    """Rename an instance.

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

    """
    if old_name not in self._config_data.instances:
      raise errors.ConfigurationError("Unknown instance '%s'" % old_name)
    inst = self._config_data.instances[old_name]
    del self._config_data.instances[old_name]
    inst.name = new_name
934
935
936
937
938
939

    for disk in inst.disks:
      if disk.dev_type == constants.LD_FILE:
        # rename the file paths in logical and physical id
        file_storage_dir = os.path.dirname(os.path.dirname(disk.logical_id[1]))
        disk.physical_id = disk.logical_id = (disk.logical_id[0],
940
941
942
                                              utils.PathJoin(file_storage_dir,
                                                             inst.name,
                                                             disk.iv_name))
943

944
945
946
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

947
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
948
949
950
951
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
952
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
953

954
955
956
957
958
959
960
961
  def _UnlockedGetInstanceList(self):
    """Get the list of instances.

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

    """
    return self._config_data.instances.keys()

962
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
963
964
965
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
966
967
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
968
969

    """
970
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
971

972
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
973
974
975
976
977
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
978
979
                                    self._config_data.instances.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
980

981
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
982
    """Returns information about an instance.
983
984
985
986
987
988
989
990
991

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

    """
    if instance_name not in self._config_data.instances:
      return None

    return self._config_data.instances[instance_name]

992
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
993
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
994
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
995

Michael Hanselmann's avatar
Michael Hanselmann committed
996
    It takes the information from the configuration file. Other information of
Iustin Pop's avatar
Iustin Pop committed
997
998
    an instance are taken from the live systems.

Iustin Pop's avatar
Iustin Pop committed
999
1000
    @param instance_name: name of the instance, e.g.
        I{instance1.example.com}
Iustin Pop's avatar
Iustin Pop committed
1001

Iustin Pop's avatar
Iustin Pop committed
1002
1003
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
1004
1005

    """
1006
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
1007

1008
1009
1010
1011
1012
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
1013
    @return: dict of (instance, instance_info), where instance_info is what
1014
1015
1016
              would GetInstanceInfo return for the node

    """
1017
1018
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
1019
1020
    return my_dict

1021
  @locking.ssynchronized(_config_lock)
1022
  def AddNode(self, node, ec_id):
Iustin Pop's avatar
Iustin Pop committed
1023
1024
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
1025
1026
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
1027
1028

    """
1029
    logging.info("Adding node %s to configuration", node.name)
1030

1031
    self._EnsureUUID(node, ec_id)
1032

1033
    node.serial_no = 1
1034
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1035
    self._config_data.nodes[node.name] = node
1036
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
1037
1038
    self._WriteConfig()

1039
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
1040
1041
1042
1043
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
1044
    logging.info("Removing node %s from configuration", node_name)
1045

Iustin Pop's avatar
Iustin Pop committed
1046
    if node_name not in self._config_data.nodes:
1047
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
1048
1049

    del self._config_data.nodes[node_name]
1050
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
1051
1052
    self._WriteConfig()

1053
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1054
1055
1056
1057
1058
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
1059
1060
                                    self._config_data.nodes.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
1061

1062
  def _UnlockedGetNodeInfo(self, node_name):
Iustin Pop's avatar
Iustin Pop committed
1063
1064
    """Get the configuration of a node, as stored in the config.

Iustin Pop's avatar
Iustin Pop committed
1065
1066
    This function is for internal use, when the config lock is already
    held.
1067

Iustin Pop's avatar
Iustin Pop committed
1068
    @param node_name: the node name, e.g. I{node1.example.com}
Iustin Pop's avatar
Iustin Pop committed
1069

Iustin Pop's avatar
Iustin Pop committed
1070
1071
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
1072
1073
1074
1075
1076
1077
1078

    """
    if node_name not in self._config_data.nodes:
      return None

    return self._config_data.nodes[node_name]

1079
1080
1081
1082
  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeInfo(self, node_name):
    """Get the configuration of a node, as stored in the config.

Iustin Pop's avatar
Iustin Pop committed
1083
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
1084

Iustin Pop's avatar
Iustin Pop committed
1085
1086
1087
1088
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
1089
1090
1091
1092
1093

    """
    return self._UnlockedGetNodeInfo(node_name)

  def _UnlockedGetNodeList(self):
Iustin Pop's avatar
Iustin Pop committed
1094
1095
    """Return the list of nodes which are in the configuration.

Iustin Pop's avatar
Iustin Pop committed
1096
1097
1098
1099
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
1100

Iustin Pop's avatar
Iustin Pop committed
1101
1102
1103
    """
    return self._config_data.nodes.keys()

1104
1105
1106
1107
1108
1109
1110
  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeList(self):
    """Return the list of nodes which are in the configuration.

    """
    return self._UnlockedGetNodeList()

1111
  def _UnlockedGetOnlineNodeList(self):
Iustin Pop's avatar
Iustin Pop committed
1112
1113
1114
1115
1116
1117
1118
    """Return the list of nodes which are online.

    """
    all_nodes = [self._UnlockedGetNodeInfo(node)
                 for node in self._UnlockedGetNodeList()]
    return [node.name for node in all_nodes if not node.offline]

1119
1120
1121
1122
1123
1124
1125
  @locking.ssynchronized(_config_lock, shared=1)
  def GetOnlineNodeList(self):
    """Return the list of nodes which are online.

    """
    return self._UnlockedGetOnlineNodeList()

1126
1127
1128
1129
1130
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
1131
    @return: dict of (node, node_info), where node_info is what
1132
1133
1134
1135
1136
1137
1138
              would GetNodeInfo return for the node

    """
    my_dict = dict([(node, self._UnlockedGetNodeInfo(node))
                    for node in self._UnlockedGetNodeList()])
    return my_dict

1139
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1140
1141
    """Get the number of current and maximum desired and possible candidates.

1142
1143
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1144
    @rtype: tuple
1145
    @return: tuple of (current, desired and possible, possible)
1146
1147

    """
1148
    mc_now = mc_should = mc_max = 0
1149
1150
1151
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
1152
      if not (node.offline or node.drained):
1153
1154
1155
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
1156
1157
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_should, mc_max)
1158
1159

  @locking.ssynchronized(_config_lock, shared=1)
1160
  def GetMasterCandidateStats(self, exceptions=None):
1161
1162
1163
1164
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1165
1166
    @type exceptions: list