config.py 45.9 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#

# Copyright (C) 2006, 2007 Google Inc.
#
# 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

"""

import os
import random
36
import logging
37
import time
Iustin Pop's avatar
Iustin Pop committed
38
39

from ganeti import errors
40
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
41
42
43
44
from ganeti import utils
from ganeti import constants
from ganeti import rpc
from ganeti import objects
45
from ganeti import serializer
46
47


48
49
_config_lock = locking.SharedLock()

50
51
52
# job id used for resource management at config upgrade time
_UPGRADE_CONFIG_JID="jid-cfg-upgrade"

53

Michael Hanselmann's avatar
Michael Hanselmann committed
54
def _ValidateConfig(data):
Iustin Pop's avatar
Iustin Pop committed
55
56
57
58
59
60
61
62
  """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
63
  if data.version != constants.CONFIG_VERSION:
64
65
    raise errors.ConfigurationError("Cluster configuration version"
                                    " mismatch, got %s instead of %s" %
Michael Hanselmann's avatar
Michael Hanselmann committed
66
                                    (data.version,
67
                                     constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
68

69

Guido Trotter's avatar
Guido Trotter committed
70
71
72
73
74
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
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
125
class ConfigWriter:
126
  """The interface to the cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
127

128
  """
Iustin Pop's avatar
Iustin Pop committed
129
  def __init__(self, cfg_file=None, offline=False):
130
    self.write_count = 0
131
    self._lock = _config_lock
Iustin Pop's avatar
Iustin Pop committed
132
133
134
135
136
137
    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
138
    self._temporary_ids = TemporaryReservationManager()
139
    self._temporary_drbds = {}
140
    self._temporary_macs = set()
141
142
143
144
145
    # 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
    self._my_hostname = utils.HostInfo().name
146
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
147
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
148
149
150
151
152
153
154
155
156

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

157
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
158
159
160
161
162
163
164
165
166
167
168
169
170
171
  def GenerateMAC(self):
    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """
    prefix = self._config_data.cluster.mac_prefix
    all_macs = self._AllMACs()
    retries = 64
    while retries > 0:
      byte1 = random.randrange(0, 256)
      byte2 = random.randrange(0, 256)
      byte3 = random.randrange(0, 256)
      mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
172
      if mac not in all_macs and mac not in self._temporary_macs:
Iustin Pop's avatar
Iustin Pop committed
173
174
175
        break
      retries -= 1
    else:
176
      raise errors.ConfigurationError("Can't generate unique MAC")
177
    self._temporary_macs.add(mac)
Iustin Pop's avatar
Iustin Pop committed
178
179
    return mac

180
  @locking.ssynchronized(_config_lock, shared=1)
181
182
183
184
185
186
187
188
  def IsMacInUse(self, mac):
    """Predicate: check if the specified MAC is in use in the Ganeti cluster.

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

    """
    all_macs = self._AllMACs()
189
    return mac in all_macs or mac in self._temporary_macs
190

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
  @locking.ssynchronized(_config_lock, shared=1)
  def GenerateDRBDSecret(self):
    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """
    all_secrets = self._AllDRBDSecrets()
    retries = 64
    while retries > 0:
      secret = utils.GenerateSecret()
      if secret not in all_secrets:
        break
      retries -= 1
    else:
      raise errors.ConfigurationError("Can't generate unique DRBD secret")
    return secret

209
  def _AllLVs(self):
210
211
212
213
214
215
216
217
218
219
    """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

220
221
222
223
224
225
226
227
228
229
230
  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:
231
      existing.update(self._temporary_ids.GetReserved())
232
233
234
    existing.update(self._AllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
235
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
236
237
    return existing

238
  def _GenerateUniqueID(self, ec_id):
239
    """Generate an unique UUID.
240
241
242
243

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

Iustin Pop's avatar
Iustin Pop committed
244
245
    @rtype: string
    @return: the unique id
246
247

    """
248
249
    existing = self._AllIDs(include_temporary=False)
    return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
250

251
  @locking.ssynchronized(_config_lock, shared=1)
252
  def GenerateUniqueID(self, ec_id):
253
254
255
256
    """Generate an unique ID.

    This is just a wrapper over the unlocked version.

257
258
    @type ec_id: string
    @param ec_id: unique id for the job to reserve the id to
259
260

    """
261
    return self._GenerateUniqueID(ec_id)
262

Iustin Pop's avatar
Iustin Pop committed
263
264
265
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
266
267
268
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
269
270
271
272
273
274
275
276
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

277
278
279
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
280
281
282
    @rtype: list
    @return: the list of all DRBD secrets

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
    """
    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

299
300
301
302
303
304
305
306
307
308
309
310
311
312
  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 = []
313
314
315
316
317
318
319
320
321
322
    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)
323
324
325
326
327
328

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

329
  def _UnlockedVerifyConfig(self):
330
331
    """Verify function.

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

Iustin Pop's avatar
Iustin Pop committed
336
337
338
    """
    result = []
    seen_macs = []
339
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
340
    data = self._config_data
341
342
    seen_lids = []
    seen_pids = []
343
344
345
346
347
348
349
350
351
352
353
354
355
356

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

    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
357
358
359
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
360
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
361
362
363
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
364
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
365
366
367
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
368
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
369
370
371
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386

      # 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"))

387
388
389
390
      # 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()])
391
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
392

393
    # cluster-wide pool of free ports
394
    for free_port in data.cluster.tcpudp_port_pool:
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
      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:
        txt = ", ".join(["%s/%s" % val for val in pdata])
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))

    # highest used tcp port check
    if keys:
410
      if keys[-1] > data.cluster.highest_used_port:
411
        result.append("Highest used port mismatch, saved %s, computed %s" %
412
413
                      (data.cluster.highest_used_port, keys[-1]))

414
415
416
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

417
    # master candidate checks
418
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
419
420
421
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
422

423
424
425
426
427
428
429
430
    # node checks
    for node in data.nodes.values():
      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))

431
432
433
434
435
436
    # drbd minors check
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    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))

437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
    # IP checks
    ips = { data.cluster.master_ip: ["cluster_ip"] }
    def _helper(ip, name):
      if ip in ips:
        ips[ip].append(name)
      else:
        ips[ip] = [name]

    for node in data.nodes.values():
      _helper(node.primary_ip, "node:%s/primary" % node.name)
      if node.secondary_ip != node.primary_ip:
        _helper(node.secondary_ip, "node:%s/secondary" % node.name)

    for ip, owners in ips.items():
      if len(owners) > 1:
        result.append("IP address %s is used by multiple owners: %s" %
                      (ip, ", ".join(owners)))
Iustin Pop's avatar
Iustin Pop committed
454
455
    return result

456
457
458
459
460
461
462
463
464
465
466
467
468
  @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()

469
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
470
471
472
473
474
475
476
477
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
480
481
482
    """
    if disk.children:
      for child in disk.children:
483
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
484
485
486

    if disk.logical_id is None and disk.physical_id is not None:
      return
487
    if disk.dev_type == constants.LD_DRBD8:
488
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
489
      if node_name not in (pnode, snode):
490
491
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
492
493
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
494
495
496
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
497
498
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
499
      if pnode == node_name:
500
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
501
      else: # it must be secondary, we tested above
502
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
503
504
505
506
    else:
      disk.physical_id = disk.logical_id
    return

507
508
509
510
511
512
513
514
515
516
517
518
519
520
  @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)
521
522
523
524
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
525
    if not isinstance(port, int):
526
      raise errors.ProgrammerError("Invalid type passed for port")
527

528
    self._config_data.cluster.tcpudp_port_pool.add(port)
529
530
    self._WriteConfig()

531
  @locking.ssynchronized(_config_lock, shared=1)
532
  def GetPortList(self):
533
534
535
    """Returns a copy of the current port list.

    """
536
    return self._config_data.cluster.tcpudp_port_pool.copy()
537

538
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
539
540
541
  def AllocatePort(self):
    """Allocate a port.

542
543
544
    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
545
546

    """
547
    # If there are TCP/IP ports configured, we use them first.
548
549
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
550
551
552
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
553
554
555
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
556
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
557
558
559
560

    self._WriteConfig()
    return port

561
  def _UnlockedComputeDRBDMap(self):
562
563
    """Compute the used DRBD minor/nodes.

564
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
565
566
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
567
568
569
        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
570
571
572

    """
    def _AppendUsedPorts(instance_name, disk, used):
573
      duplicates = []
574
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
575
576
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
577
578
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
579
          if port in used[node]:
580
581
582
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
583
584
      if disk.children:
        for child in disk.children:
585
586
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
587

588
    duplicates = []
589
    my_dict = dict((node, {}) for node in self._config_data.nodes)
590
591
592
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
593
    for (node, minor), instance in self._temporary_drbds.iteritems():
594
      if minor in my_dict[node] and my_dict[node][minor] != instance:
595
596
597
598
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
599

600
601
602
603
604
605
606
607
608
609
610
  @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).

    """
611
612
613
614
615
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
616

617
618
619
620
621
622
623
624
625
  @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.

626
627
628
    @type instance: string
    @param instance: the instance for which we allocate minors

629
    """
630
    assert isinstance(instance, basestring), \
631
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
632

633
634
635
636
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
637
638
639
640
641
642
643
    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
644
        self._temporary_drbds[(nname, 0)] = instance
645
646
647
648
649
650
651
652
653
654
        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
655
656
657
658
659
      # 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]))
660
      ndata[minor] = instance
661
662
663
664
665
666
667
668
      # 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)
669
670
671
672
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

673
  def _UnlockedReleaseDRBDMinors(self, instance):
674
675
676
677
678
679
680
    """Release temporary drbd minors allocated for a given instance.

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

    """
681
682
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
683
684
685
686
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
  @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)

704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
  @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.

    """
759
    return self._config_data.cluster.enabled_hypervisors[0]
760

761
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
762
763
764
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
765
766
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
767
768
769
770

    """
    return self._config_data.cluster.rsahostkeypub

771
  @locking.ssynchronized(_config_lock)
772
  def AddInstance(self, instance, ec_id):
Iustin Pop's avatar
Iustin Pop committed
773
774
775
776
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
777
778
779
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
780
781
782
783
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

784
785
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
786
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
787

788
789
790
791
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
792
793
794
                                        " MAC address '%s' already in use." %
                                        (instance.name, nic.mac))

795
    self._EnsureUUID(instance, ec_id)
796

797
    instance.serial_no = 1
798
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
799
    self._config_data.instances[instance.name] = instance
800
    self._config_data.cluster.serial_no += 1
801
    self._UnlockedReleaseDRBDMinors(instance.name)
802
803
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
804
805
    self._WriteConfig()

806
  def _EnsureUUID(self, item, ec_id):
807
808
809
    """Ensures a given object has a valid UUID.

    @param item: the instance or node to be checked
810
    @param ec_id: the execution context id for the uuid reservation
811
812
813

    """
    if not item.uuid:
814
      item.uuid = self._GenerateUniqueID(ec_id)
815
816
817
818
    elif item.uuid in self._AllIDs(temporary=True):
      raise errors.ConfigurationError("Cannot add '%s': UUID already in use" %
                                      (item.name, item.uuid))

819
820
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
821
822

    """
823
824
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
825
826

    if instance_name not in self._config_data.instances:
827
828
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
829
    instance = self._config_data.instances[instance_name]
830
831
    if instance.admin_up != status:
      instance.admin_up = status
832
      instance.serial_no += 1
833
      instance.mtime = time.time()
834
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
835

836
  @locking.ssynchronized(_config_lock)
837
838
839
840
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
841
    self._SetInstanceStatus(instance_name, True)
842

843
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
844
845
846
847
848
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
849
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
850
    del self._config_data.instances[instance_name]
851
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
852
853
    self._WriteConfig()

854
  @locking.ssynchronized(_config_lock)
855
856
857
858
859
860
861
862
863
864
865
866
867
  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
868
869
870
871
872
873
874
875
876
877

    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],
                                              os.path.join(file_storage_dir,
                                                           inst.name,
                                                           disk.iv_name))

878
879
880
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

881
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
882
883
884
885
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
886
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
887

888
889
890
891
892
893
894
895
  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()

896
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
897
898
899
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
900
901
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
902
903

    """
904
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
905

906
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
907
908
909
910
911
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
912
913
                                    self._config_data.instances.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
914

915
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
916
    """Returns information about an instance.
917
918
919
920
921
922
923
924
925

    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]

926
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
927
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
928
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
929

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

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

Iustin Pop's avatar
Iustin Pop committed
936
937
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
938
939

    """
940
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
941

942
943
944
945
946
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
947
    @return: dict of (instance, instance_info), where instance_info is what
948
949
950
              would GetInstanceInfo return for the node

    """
951
952
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
953
954
    return my_dict

955
  @locking.ssynchronized(_config_lock)
956
  def AddNode(self, node, ec_id):
Iustin Pop's avatar
Iustin Pop committed
957
958
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
959
960
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
961
962

    """
963
    logging.info("Adding node %s to configuration", node.name)
964

965
    self._EnsureUUID(node, ec_id)
966

967
    node.serial_no = 1
968
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
969
    self._config_data.nodes[node.name] = node
970
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
971
972
    self._WriteConfig()

973
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
974
975
976
977
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
978
    logging.info("Removing node %s from configuration", node_name)
979

Iustin Pop's avatar
Iustin Pop committed
980
    if node_name not in self._config_data.nodes:
981
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
982
983

    del self._config_data.nodes[node_name]
984
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
985
986
    self._WriteConfig()

987
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
988
989
990
991
992
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
993
994
                                    self._config_data.nodes.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
995

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

Iustin Pop's avatar
Iustin Pop committed
999
1000
    This function is for internal use, when the config lock is already
    held.
1001

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

Iustin Pop's avatar
Iustin Pop committed
1004
1005
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
1006
1007
1008
1009
1010
1011
1012

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

    return self._config_data.nodes[node_name]

1013
1014
1015
1016
1017

  @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
1018
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
1019

Iustin Pop's avatar
Iustin Pop committed
1020
1021
1022
1023
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
1024
1025
1026
1027
1028

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
1031
1032
1033
1034
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
1035

Iustin Pop's avatar
Iustin Pop committed
1036
1037
1038
    """
    return self._config_data.nodes.keys()

1039
1040
1041
1042
1043
1044
1045
1046

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

    """
    return self._UnlockedGetNodeList()

Iustin Pop's avatar
Iustin Pop committed
1047
1048
1049
1050
1051
1052
1053
1054
1055
  @locking.ssynchronized(_config_lock, shared=1)
  def GetOnlineNodeList(self):
    """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]

1056
1057
1058
1059
1060
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
1061
    @return: dict of (node, node_info), where node_info is what
1062
1063
1064
1065
1066
1067
1068
              would GetNodeInfo return for the node

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

1069
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1070
1071
    """Get the number of current and maximum desired and possible candidates.

1072
1073
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1074
    @rtype: tuple
1075
    @return: tuple of (current, desired and possible, possible)
1076
1077

    """
1078
    mc_now = mc_should = mc_max = 0
1079
1080
1081
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
1082
      if not (node.offline or node.drained):
1083
1084
1085
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
1086
1087
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_should, mc_max)
1088
1089

  @locking.ssynchronized(_config_lock, shared=1)
1090
  def GetMasterCandidateStats(self, exceptions=None):
1091
1092
1093
1094
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1095
1096
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1097
1098
1099
1100
    @rtype: tuple
    @return: tuple of (current, max)

    """
1101
    return self._UnlockedGetMasterCandidateStats(exceptions)
1102
1103

  @locking.ssynchronized(_config_lock)
Guido Trotter's avatar
Guido Trotter committed
1104
  def MaintainCandidatePool(self, exceptions):
1105
1106
    """Try to grow the candidate pool to the desired size.

Guido Trotter's avatar
Guido Trotter committed
1107
1108
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1109
    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1110
    @return: list with the adjusted nodes (L{objects.Node} instances)
1111
1112

    """
Guido Trotter's avatar
Guido Trotter committed
1113
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1114
1115
1116
1117
1118
1119
1120
1121
    mod_list = []
    if mc_now < mc_max:
      node_list = self._config_data.nodes.keys()
      random.shuffle(node_list)
      for name in node_list:
        if mc_now >= mc_max:
          break
        node = self._config_data.nodes[name]
Guido Trotter's avatar
Guido Trotter committed
1122
1123
        if (node.master_candidate or node.offline or node.drained or
            node.name in exceptions):
1124
          continue
Iustin Pop's avatar
Iustin Pop committed
1125
        mod_list.append(node)
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
        node.master_candidate = True
        node.serial_no += 1
        mc_now += 1
      if mc_now != mc_max:
        # this should not happen
        logging.warning("Warning: MaintainCandidatePool didn't manage to"
                        " fill the candidate pool (%d/%d)", mc_now, mc_max)
      if mod_list:
        self._config_data.cluster.serial_no += 1
        self._WriteConfig()

    return mod_list

Iustin Pop's avatar
Iustin Pop committed
1139
1140
1141
1142
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1143
    self._config_data.serial_no += 1
1144
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1145

1146
1147
1148
1149
1150
1151
1152
1153
  def _AllUUIDObjects(self):
    """Returns all objects with uuid attributes.

    """
    return (self._config_data.instances.values() +
            self._config_data.nodes.values() +
            [self._config_data.cluster])

Iustin Pop's avatar
Iustin Pop committed
1154
1155
1156
1157
  def _OpenConfig(self):
    """Read the config data from disk.

    """
1158
1159
    raw_data = utils.ReadFile(self._cfg_file)

Iustin Pop's avatar
Iustin Pop committed
1160
    try:
1161
1162
1163
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
    except Exception, err:
      raise errors.ConfigurationError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1164
1165
1166
1167

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

Iustin Pop's avatar
Iustin Pop committed
1168
    if (not hasattr(data, 'cluster') or
1169
        not hasattr(data.cluster, 'rsahostkeypub')):
1170
      raise errors.ConfigurationError("Incomplete configuration"
1171
                                      " (missing cluster.rsahostkeypub)")
1172
1173
1174
1175

    # Upgrade configuration if needed
    data.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
1176
    self._config_data = data
1177
    # reset the last serial as -1 so that the next write will cause
1178
1179
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1180

1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
    # And finally run our (custom) config upgrade sequence
    self._UpgradeConfig()

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

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

    @warning: this function will call L{_WriteConfig()}, so it needs
        to either be called with the lock held or from a safe place
        (the constructor)

    """
    modified = False
    for item in self._AllUUIDObjects():
      if item.uuid is None:
1198
        item.uuid = self._GenerateUniqueID(_UPGRADE_CONFIG_JID)