config.py 45.7 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 = TemporaryReservationManager()
141
    self._temporary_secrets = TemporaryReservationManager()
142
143
144
145
146
    # 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
147
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
148
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
149
150
151
152
153
154
155
156
157

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

158
159
160
161
162
163
164
165
166
167
168
  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

169
  @locking.ssynchronized(_config_lock, shared=1)
170
  def GenerateMAC(self, ec_id):
Iustin Pop's avatar
Iustin Pop committed
171
172
173
174
175
    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """
176
177
    existing = self._AllMACs()
    return self._temporary_ids.Generate(existing, self._GenerateOneMAC, ec_id)
Iustin Pop's avatar
Iustin Pop committed
178

179
  @locking.ssynchronized(_config_lock, shared=1)
180
181
  def ReserveMAC(self, mac, ec_id):
    """Reserve a MAC for an instance.
182
183
184
185
186
187

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

    """
    all_macs = self._AllMACs()
188
189
190
191
    if mac in all_macs:
      raise errors.ReservationError("mac already in use")
    else:
      self._temporary_macs.Reserve(mac, ec_id)
192

193
  @locking.ssynchronized(_config_lock, shared=1)
194
  def GenerateDRBDSecret(self, ec_id):
195
196
197
198
199
    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """
200
201
202
    return self._temporary_secrets.Generate(self._AllDRBDSecrets(),
                                            utils.GenerateSecret,
                                            ec_id)
203
  def _AllLVs(self):
204
205
206
207
208
209
210
211
212
213
    """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

214
215
216
217
218
219
220
221
222
223
224
  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:
225
      existing.update(self._temporary_ids.GetReserved())
226
227
228
    existing.update(self._AllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
229
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
230
231
    return existing

232
  def _GenerateUniqueID(self, ec_id):
233
    """Generate an unique UUID.
234
235
236
237

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

Iustin Pop's avatar
Iustin Pop committed
238
239
    @rtype: string
    @return: the unique id
240
241

    """
242
243
    existing = self._AllIDs(include_temporary=False)
    return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
244

245
  @locking.ssynchronized(_config_lock, shared=1)
246
  def GenerateUniqueID(self, ec_id):
247
248
249
250
    """Generate an unique ID.

    This is just a wrapper over the unlocked version.

251
252
    @type ec_id: string
    @param ec_id: unique id for the job to reserve the id to
253
254

    """
255
    return self._GenerateUniqueID(ec_id)
256

Iustin Pop's avatar
Iustin Pop committed
257
258
259
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
260
261
262
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
263
264
265
266
267
268
269
270
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

271
272
273
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
274
275
276
    @rtype: list
    @return: the list of all DRBD secrets

277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
    """
    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

293
294
295
296
297
298
299
300
301
302
303
304
305
306
  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 = []
307
308
309
310
311
312
313
314
315
316
    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)
317
318
319
320
321
322

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

323
  def _UnlockedVerifyConfig(self):
324
325
    """Verify function.

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

Iustin Pop's avatar
Iustin Pop committed
330
331
332
    """
    result = []
    seen_macs = []
333
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
334
    data = self._config_data
335
336
    seen_lids = []
    seen_pids = []
337
338
339
340
341
342
343
344
345
346
347
348
349
350

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

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

381
382
383
384
      # 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()])
385
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
386

387
    # cluster-wide pool of free ports
388
    for free_port in data.cluster.tcpudp_port_pool:
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
      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:
404
      if keys[-1] > data.cluster.highest_used_port:
405
        result.append("Highest used port mismatch, saved %s, computed %s" %
406
407
                      (data.cluster.highest_used_port, keys[-1]))

408
409
410
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

411
    # master candidate checks
412
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
413
414
415
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
416

417
418
419
420
421
422
423
424
    # 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))

425
426
427
428
429
430
    # 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))

431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
    # 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
448
449
    return result

450
451
452
453
454
455
456
457
458
459
460
461
462
  @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()

463
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
464
465
466
467
468
469
470
471
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
474
475
476
    """
    if disk.children:
      for child in disk.children:
477
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
478
479
480

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

501
502
503
504
505
506
507
508
509
510
511
512
513
514
  @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)
515
516
517
518
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
519
    if not isinstance(port, int):
520
      raise errors.ProgrammerError("Invalid type passed for port")
521

522
    self._config_data.cluster.tcpudp_port_pool.add(port)
523
524
    self._WriteConfig()

525
  @locking.ssynchronized(_config_lock, shared=1)
526
  def GetPortList(self):
527
528
529
    """Returns a copy of the current port list.

    """
530
    return self._config_data.cluster.tcpudp_port_pool.copy()
531

532
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
533
534
535
  def AllocatePort(self):
    """Allocate a port.

536
537
538
    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
539
540

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

    self._WriteConfig()
    return port

555
  def _UnlockedComputeDRBDMap(self):
556
557
    """Compute the used DRBD minor/nodes.

558
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
559
560
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
561
562
563
        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
564
565
566

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

582
    duplicates = []
583
    my_dict = dict((node, {}) for node in self._config_data.nodes)
584
585
586
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
587
    for (node, minor), instance in self._temporary_drbds.iteritems():
588
      if minor in my_dict[node] and my_dict[node][minor] != instance:
589
590
591
592
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
593

594
595
596
597
598
599
600
601
602
603
604
  @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).

    """
605
606
607
608
609
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
610

611
612
613
614
615
616
617
618
619
  @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.

620
621
622
    @type instance: string
    @param instance: the instance for which we allocate minors

623
    """
624
    assert isinstance(instance, basestring), \
625
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
626

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

667
  def _UnlockedReleaseDRBDMinors(self, instance):
668
669
670
671
672
673
674
    """Release temporary drbd minors allocated for a given instance.

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

    """
675
676
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
677
678
679
680
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
  @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)

698
699
700
701
702
703
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
  @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.

    """
753
    return self._config_data.cluster.enabled_hypervisors[0]
754

755
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
756
757
758
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
759
760
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
761
762
763
764

    """
    return self._config_data.cluster.rsahostkeypub

765
  @locking.ssynchronized(_config_lock)
766
  def AddInstance(self, instance, ec_id):
Iustin Pop's avatar
Iustin Pop committed
767
768
769
770
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
771
772
773
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
774
775
776
777
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

778
779
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
780
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
781

782
783
784
785
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
786
787
788
                                        " MAC address '%s' already in use." %
                                        (instance.name, nic.mac))

789
    self._EnsureUUID(instance, ec_id)
790

791
    instance.serial_no = 1
792
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
793
    self._config_data.instances[instance.name] = instance
794
    self._config_data.cluster.serial_no += 1
795
    self._UnlockedReleaseDRBDMinors(instance.name)
Iustin Pop's avatar
Iustin Pop committed
796
797
    self._WriteConfig()

798
  def _EnsureUUID(self, item, ec_id):
799
800
801
    """Ensures a given object has a valid UUID.

    @param item: the instance or node to be checked
802
    @param ec_id: the execution context id for the uuid reservation
803
804
805

    """
    if not item.uuid:
806
      item.uuid = self._GenerateUniqueID(ec_id)
807
808
809
810
    elif item.uuid in self._AllIDs(temporary=True):
      raise errors.ConfigurationError("Cannot add '%s': UUID already in use" %
                                      (item.name, item.uuid))

811
812
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
813
814

    """
815
816
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
817
818

    if instance_name not in self._config_data.instances:
819
820
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
821
    instance = self._config_data.instances[instance_name]
822
823
    if instance.admin_up != status:
      instance.admin_up = status
824
      instance.serial_no += 1
825
      instance.mtime = time.time()
826
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
827

828
  @locking.ssynchronized(_config_lock)
829
830
831
832
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
833
    self._SetInstanceStatus(instance_name, True)
834

835
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
836
837
838
839
840
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
841
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
842
    del self._config_data.instances[instance_name]
843
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
844
845
    self._WriteConfig()

846
  @locking.ssynchronized(_config_lock)
847
848
849
850
851
852
853
854
855
856
857
858
859
  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
860
861
862
863
864
865
866
867
868
869

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

870
871
872
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

873
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
874
875
876
877
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
878
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
879

880
881
882
883
884
885
886
887
  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()

888
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
889
890
891
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
892
893
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
894
895

    """
896
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
897

898
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
899
900
901
902
903
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
904
905
                                    self._config_data.instances.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
906

907
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
908
    """Returns information about an instance.
909
910
911
912
913
914
915
916
917

    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]

918
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
919
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
920
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
921

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

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

Iustin Pop's avatar
Iustin Pop committed
928
929
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
930
931

    """
932
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
933

934
935
936
937
938
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
939
    @return: dict of (instance, instance_info), where instance_info is what
940
941
942
              would GetInstanceInfo return for the node

    """
943
944
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
945
946
    return my_dict

947
  @locking.ssynchronized(_config_lock)
948
  def AddNode(self, node, ec_id):
Iustin Pop's avatar
Iustin Pop committed
949
950
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
951
952
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
953
954

    """
955
    logging.info("Adding node %s to configuration", node.name)
956

957
    self._EnsureUUID(node, ec_id)
958

959
    node.serial_no = 1
960
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
961
    self._config_data.nodes[node.name] = node
962
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
963
964
    self._WriteConfig()

965
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
966
967
968
969
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
970
    logging.info("Removing node %s from configuration", node_name)
971

Iustin Pop's avatar
Iustin Pop committed
972
    if node_name not in self._config_data.nodes:
973
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
974
975

    del self._config_data.nodes[node_name]
976
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
977
978
    self._WriteConfig()

979
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
980
981
982
983
984
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
985
986
                                    self._config_data.nodes.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
987

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

Iustin Pop's avatar
Iustin Pop committed
991
992
    This function is for internal use, when the config lock is already
    held.
993

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

Iustin Pop's avatar
Iustin Pop committed
996
997
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
998
999
1000
1001
1002
1003
1004

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

    return self._config_data.nodes[node_name]

1005
1006
1007
1008
1009

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

Iustin Pop's avatar
Iustin Pop committed
1012
1013
1014
1015
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
1016
1017
1018
1019
1020

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
1023
1024
1025
1026
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
1027

Iustin Pop's avatar
Iustin Pop committed
1028
1029
1030
    """
    return self._config_data.nodes.keys()

1031
1032
1033
1034
1035
1036
1037
1038

  @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
1039
1040
1041
1042
1043
1044
1045
1046
1047
  @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]

1048
1049
1050
1051
1052
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
1053
    @return: dict of (node, node_info), where node_info is what
1054
1055
1056
1057
1058
1059
1060
              would GetNodeInfo return for the node

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

1061
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1062
1063
    """Get the number of current and maximum desired and possible candidates.

1064
1065
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1066
    @rtype: tuple
1067
    @return: tuple of (current, desired and possible, possible)
1068
1069

    """
1070
    mc_now = mc_should = mc_max = 0
1071
1072
1073
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
1074
      if not (node.offline or node.drained):
1075
1076
1077
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
1078
1079
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_should, mc_max)
1080
1081

  @locking.ssynchronized(_config_lock, shared=1)
1082
  def GetMasterCandidateStats(self, exceptions=None):
1083
1084
1085
1086
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1087
1088
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1089
1090
1091
1092
    @rtype: tuple
    @return: tuple of (current, max)

    """
1093
    return self._UnlockedGetMasterCandidateStats(exceptions)
1094
1095

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

Guido Trotter's avatar
Guido Trotter committed
1099
1100
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1101
    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1102
    @return: list with the adjusted nodes (L{objects.Node} instances)
1103
1104

    """
Guido Trotter's avatar
Guido Trotter committed
1105
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1106
1107
1108
1109
1110
1111
1112
1113
    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
1114
1115
        if (node.master_candidate or node.offline or node.drained or
            node.name in exceptions):
1116
          continue
Iustin Pop's avatar
Iustin Pop committed
1117
        mod_list.append(node)
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
        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
1131
1132
1133
1134
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1135
    self._config_data.serial_no += 1
1136
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1137

1138
1139
1140
1141
1142
1143
1144
1145
  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
1146
1147
1148
1149
  def _OpenConfig(self):
    """Read the config data from disk.

    """
1150
1151
    raw_data = utils.ReadFile(self._cfg_file)

Iustin Pop's avatar
Iustin Pop committed
1152
    try:
1153
1154
1155
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
    except Exception, err:
      raise errors.ConfigurationError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1156
1157
1158
1159

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

Iustin Pop's avatar
Iustin Pop committed
1160
    if (not hasattr(data, 'cluster') or
1161
        not hasattr(data.cluster, 'rsahostkeypub')):
1162
      raise errors.ConfigurationError("Incomplete configuration"
1163
                                      " (missing cluster.rsahostkeypub)")
1164
1165
1166
1167

    # Upgrade configuration if needed
    data.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
1168
    self._config_data = data
1169
    # reset the last serial as -1 so that the next write will cause
1170
1171
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1172

1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
    # 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: