config.py 47.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
Balazs Lecz's avatar
Balazs Lecz committed
46
from ganeti import uidpool
47
48


49
50
_config_lock = locking.SharedLock()

51
# job id used for resource management at config upgrade time
Michael Hanselmann's avatar
Michael Hanselmann committed
52
_UPGRADE_CONFIG_JID = "jid-cfg-upgrade"
53

54

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

70

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

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

132
  """
Iustin Pop's avatar
Iustin Pop committed
133
  def __init__(self, cfg_file=None, offline=False):
134
    self.write_count = 0
135
    self._lock = _config_lock
Iustin Pop's avatar
Iustin Pop committed
136
137
138
139
140
141
    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
142
    self._temporary_ids = TemporaryReservationManager()
143
    self._temporary_drbds = {}
144
    self._temporary_macs = TemporaryReservationManager()
145
    self._temporary_secrets = TemporaryReservationManager()
146
147
148
    self._temporary_lvs = TemporaryReservationManager()
    self._all_rms = [self._temporary_ids, self._temporary_macs,
                     self._temporary_secrets, self._temporary_lvs]
149
150
151
152
153
    # 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
154
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
155
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
156
157
158
159
160
161
162
163
164

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

165
166
167
168
169
170
171
172
173
174
175
  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

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

    This should check the current instances for duplicates.

    """
183
184
    existing = self._AllMACs()
    return self._temporary_ids.Generate(existing, self._GenerateOneMAC, ec_id)
Iustin Pop's avatar
Iustin Pop committed
185

186
  @locking.ssynchronized(_config_lock, shared=1)
187
188
  def ReserveMAC(self, mac, ec_id):
    """Reserve a MAC for an instance.
189
190
191
192
193
194

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

    """
    all_macs = self._AllMACs()
195
196
197
198
    if mac in all_macs:
      raise errors.ReservationError("mac already in use")
    else:
      self._temporary_macs.Reserve(mac, ec_id)
199

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

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

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

214
  @locking.ssynchronized(_config_lock, shared=1)
215
  def GenerateDRBDSecret(self, ec_id):
216
217
218
219
220
    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """
221
222
223
    return self._temporary_secrets.Generate(self._AllDRBDSecrets(),
                                            utils.GenerateSecret,
                                            ec_id)
Michael Hanselmann's avatar
Michael Hanselmann committed
224

225
  def _AllLVs(self):
226
227
228
229
230
231
232
233
234
235
    """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

236
237
238
239
240
241
242
243
244
245
246
  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:
247
      existing.update(self._temporary_ids.GetReserved())
248
249
250
    existing.update(self._AllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
251
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
252
253
    return existing

254
  def _GenerateUniqueID(self, ec_id):
255
    """Generate an unique UUID.
256
257
258
259

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

Iustin Pop's avatar
Iustin Pop committed
260
261
    @rtype: string
    @return: the unique id
262
263

    """
264
265
    existing = self._AllIDs(include_temporary=False)
    return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
266

267
  @locking.ssynchronized(_config_lock, shared=1)
268
  def GenerateUniqueID(self, ec_id):
269
270
271
272
    """Generate an unique ID.

    This is just a wrapper over the unlocked version.

273
274
    @type ec_id: string
    @param ec_id: unique id for the job to reserve the id to
275
276

    """
277
    return self._GenerateUniqueID(ec_id)
278

Iustin Pop's avatar
Iustin Pop committed
279
280
281
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
282
283
284
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
285
286
287
288
289
290
291
292
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

293
294
295
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
296
297
298
    @rtype: list
    @return: the list of all DRBD secrets

299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
    """
    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

315
316
317
318
319
320
321
322
323
324
325
326
327
328
  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 = []
329
330
331
332
333
334
335
336
337
338
    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)
339
340
341
342
343
344

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

345
  def _UnlockedVerifyConfig(self):
346
347
    """Verify function.

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

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

    # 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
373
374
    for instance_name in data.instances:
      instance = data.instances[instance_name]
375
376
377
      if instance.name != instance_name:
        result.append("instance '%s' is indexed by wrong name '%s'" %
                      (instance.name, instance_name))
Iustin Pop's avatar
Iustin Pop committed
378
      if instance.primary_node not in data.nodes:
379
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
380
381
382
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
383
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
384
385
386
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
387
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
388
389
390
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

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

406
407
408
409
      # 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()])
410
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
411

412
    # cluster-wide pool of free ports
413
    for free_port in data.cluster.tcpudp_port_pool:
414
415
416
417
418
419
420
421
422
423
      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:
424
        txt = utils.CommaJoin(["%s/%s" % val for val in pdata])
425
426
427
428
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))

    # highest used tcp port check
    if keys:
429
      if keys[-1] > data.cluster.highest_used_port:
430
        result.append("Highest used port mismatch, saved %s, computed %s" %
431
432
                      (data.cluster.highest_used_port, keys[-1]))

433
434
435
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

436
    # master candidate checks
437
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
438
439
440
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
441

442
    # node checks
443
444
445
446
    for node_name, node in data.nodes.items():
      if node.name != node_name:
        result.append("Node '%s' is indexed by wrong name '%s'" %
                      (node.name, node_name))
447
448
449
450
451
452
      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))

453
    # drbd minors check
454
    _, duplicates = self._UnlockedComputeDRBDMap()
455
456
457
458
    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))

459
    # IP checks
460
461
462
463
464
465
466
    default_nicparams = data.cluster.nicparams[constants.PP_DEFAULT]
    ips = {}

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

    _AddIpAddress(data.cluster.master_ip, "cluster_ip")
467
468

    for node in data.nodes.values():
469
      _AddIpAddress(node.primary_ip, "node:%s/primary" % node.name)
470
      if node.secondary_ip != node.primary_ip:
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
        _AddIpAddress(node.secondary_ip, "node:%s/secondary" % node.name)

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

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

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

        _AddIpAddress("%s/%s" % (link, nic.ip),
                      "instance:%s/nic:%d" % (instance.name, idx))
491
492
493
494

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

Iustin Pop's avatar
Iustin Pop committed
497
498
    return result

499
500
501
502
503
504
505
506
507
508
509
510
511
  @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()

512
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
513
514
515
516
517
518
519
520
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
523
524
525
    """
    if disk.children:
      for child in disk.children:
526
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
527
528
529

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

550
551
552
553
554
555
556
557
558
559
560
561
562
563
  @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)
564
565
566
567
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
568
    if not isinstance(port, int):
569
      raise errors.ProgrammerError("Invalid type passed for port")
570

571
    self._config_data.cluster.tcpudp_port_pool.add(port)
572
573
    self._WriteConfig()

574
  @locking.ssynchronized(_config_lock, shared=1)
575
  def GetPortList(self):
576
577
578
    """Returns a copy of the current port list.

    """
579
    return self._config_data.cluster.tcpudp_port_pool.copy()
580

581
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
582
583
584
  def AllocatePort(self):
    """Allocate a port.

585
586
587
    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
588
589

    """
590
    # If there are TCP/IP ports configured, we use them first.
591
592
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
593
594
595
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
596
597
598
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
599
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
600
601
602
603

    self._WriteConfig()
    return port

604
  def _UnlockedComputeDRBDMap(self):
605
606
    """Compute the used DRBD minor/nodes.

607
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
608
609
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
610
611
612
        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
613
614
615

    """
    def _AppendUsedPorts(instance_name, disk, used):
616
      duplicates = []
617
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
618
619
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
620
621
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
622
          if port in used[node]:
623
624
625
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
626
627
      if disk.children:
        for child in disk.children:
628
629
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
630

631
    duplicates = []
632
    my_dict = dict((node, {}) for node in self._config_data.nodes)
633
634
635
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
636
    for (node, minor), instance in self._temporary_drbds.iteritems():
637
      if minor in my_dict[node] and my_dict[node][minor] != instance:
638
639
640
641
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
642

643
644
645
646
647
648
649
650
651
652
653
  @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).

    """
654
655
656
657
658
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
659

660
661
662
663
664
665
666
667
668
  @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.

669
670
671
    @type instance: string
    @param instance: the instance for which we allocate minors

672
    """
673
    assert isinstance(instance, basestring), \
674
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
675

676
677
678
679
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
680
681
682
683
684
685
686
    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
687
        self._temporary_drbds[(nname, 0)] = instance
688
689
690
691
692
693
694
695
696
697
        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
698
699
700
701
702
      # 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]))
703
      ndata[minor] = instance
704
705
706
707
708
709
710
711
      # 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)
712
713
714
715
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

716
  def _UnlockedReleaseDRBDMinors(self, instance):
717
718
719
720
721
722
723
    """Release temporary drbd minors allocated for a given instance.

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

    """
724
725
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
726
727
728
729
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
  @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)

747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
  @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.

    """
802
    return self._config_data.cluster.enabled_hypervisors[0]
803

804
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
805
806
807
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
808
809
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
810
811
812
813

    """
    return self._config_data.cluster.rsahostkeypub

814
  @locking.ssynchronized(_config_lock)
815
  def AddInstance(self, instance, ec_id):
Iustin Pop's avatar
Iustin Pop committed
816
817
818
819
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
820
821
822
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
823
824
825
826
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

827
828
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
829
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
830

831
832
833
834
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
835
836
837
                                        " MAC address '%s' already in use." %
                                        (instance.name, nic.mac))

838
    self._EnsureUUID(instance, ec_id)
839

840
    instance.serial_no = 1
841
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
842
    self._config_data.instances[instance.name] = instance
843
    self._config_data.cluster.serial_no += 1
844
    self._UnlockedReleaseDRBDMinors(instance.name)
Iustin Pop's avatar
Iustin Pop committed
845
846
    self._WriteConfig()

847
  def _EnsureUUID(self, item, ec_id):
848
849
850
    """Ensures a given object has a valid UUID.

    @param item: the instance or node to be checked
851
    @param ec_id: the execution context id for the uuid reservation
852
853
854

    """
    if not item.uuid:
855
      item.uuid = self._GenerateUniqueID(ec_id)
856
857
858
    elif item.uuid in self._AllIDs(include_temporary=True):
      raise errors.ConfigurationError("Cannot add '%s': UUID %s already"
                                      " in use" % (item.name, item.uuid))
859

860
861
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
862
863

    """
864
865
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
866
867

    if instance_name not in self._config_data.instances:
868
869
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
870
    instance = self._config_data.instances[instance_name]
871
872
    if instance.admin_up != status:
      instance.admin_up = status
873
      instance.serial_no += 1
874
      instance.mtime = time.time()
875
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
876

877
  @locking.ssynchronized(_config_lock)
878
879
880
881
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
882
    self._SetInstanceStatus(instance_name, True)
883

884
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
885
886
887
888
889
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
890
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
891
    del self._config_data.instances[instance_name]
892
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
893
894
    self._WriteConfig()

895
  @locking.ssynchronized(_config_lock)
896
897
898
899
900
901
902
903
904
905
906
907
908
  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
909
910
911
912
913
914

    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],
915
916
917
                                              utils.PathJoin(file_storage_dir,
                                                             inst.name,
                                                             disk.iv_name))
918

919
920
921
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

922
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
923
924
925
926
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
927
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
928

929
930
931
932
933
934
935
936
  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()

937
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
938
939
940
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
941
942
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
943
944

    """
945
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
946

947
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
948
949
950
951
952
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
953
954
                                    self._config_data.instances.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
955

956
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
957
    """Returns information about an instance.
958
959
960
961
962
963
964
965
966

    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]

967
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
968
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
969
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
970

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

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

Iustin Pop's avatar
Iustin Pop committed
977
978
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
979
980

    """
981
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
982

983
984
985
986
987
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
988
    @return: dict of (instance, instance_info), where instance_info is what
989
990
991
              would GetInstanceInfo return for the node

    """
992
993
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
994
995
    return my_dict

996
  @locking.ssynchronized(_config_lock)
997
  def AddNode(self, node, ec_id):
Iustin Pop's avatar
Iustin Pop committed
998
999
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
1000
1001
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
1002
1003

    """
1004
    logging.info("Adding node %s to configuration", node.name)
1005

1006
    self._EnsureUUID(node, ec_id)
1007

1008
    node.serial_no = 1
1009
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1010
    self._config_data.nodes[node.name] = node
1011
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
1012
1013
    self._WriteConfig()

1014
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
1015
1016
1017
1018
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
1019
    logging.info("Removing node %s from configuration", node_name)
1020

Iustin Pop's avatar
Iustin Pop committed
1021
    if node_name not in self._config_data.nodes:
1022
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
1023
1024

    del self._config_data.nodes[node_name]
1025
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
1026
1027
    self._WriteConfig()

1028
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1029
1030
1031
1032
1033
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
1034
1035
                                    self._config_data.nodes.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
1036

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

Iustin Pop's avatar
Iustin Pop committed
1040
1041
    This function is for internal use, when the config lock is already
    held.
1042

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

Iustin Pop's avatar
Iustin Pop committed
1045
1046
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
1047
1048
1049
1050
1051
1052
1053

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

    return self._config_data.nodes[node_name]

1054
1055
1056
1057
  @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
1058
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
1059

Iustin Pop's avatar
Iustin Pop committed
1060
1061
1062
1063
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
1064
1065
1066
1067
1068

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
1071
1072
1073
1074
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
1075

Iustin Pop's avatar
Iustin Pop committed
1076
1077
1078
    """
    return self._config_data.nodes.keys()

1079
1080
1081
1082
1083
1084
1085
  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeList(self):
    """Return the list of nodes which are in the configuration.

    """
    return self._UnlockedGetNodeList()

1086
  def _UnlockedGetOnlineNodeList(self):
Iustin Pop's avatar
Iustin Pop committed
1087
1088
1089
1090
1091
1092
1093
    """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]

1094
1095
1096
1097
1098
1099
1100
  @locking.ssynchronized(_config_lock, shared=1)
  def GetOnlineNodeList(self):
    """Return the list of nodes which are online.

    """
    return self._UnlockedGetOnlineNodeList()

1101
1102
1103
1104
1105
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
1106
    @return: dict of (node, node_info), where node_info is what
1107
1108
1109
1110
1111
1112
1113
              would GetNodeInfo return for the node

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

1114
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1115
1116
    """Get the number of current and maximum desired and possible candidates.

1117
1118
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1119
    @rtype: tuple
1120
    @return: tuple of (current, desired and possible, possible)
1121
1122

    """
1123
    mc_now = mc_should = mc_max = 0
1124
1125
1126
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
1127
      if not (node.offline or node.drained):
1128
1129
1130
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
1131
1132
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_should, mc_max)
1133
1134

  @locking.ssynchronized(_config_lock, shared=1)
1135
  def GetMasterCandidateStats(self, exceptions=None):
1136
1137
1138
1139
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1140
1141
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1142
1143
1144
1145
    @rtype: tuple
    @return: tuple of (current, max)

    """
1146
    return self._UnlockedGetMasterCandidateStats(exceptions)
1147
1148

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

Guido Trotter's avatar
Guido Trotter committed
1152
1153
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1154
    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1155
    @return: list with the adjusted nodes (L{objects.Node} instances)
1156
1157

    """
Guido Trotter's avatar
Guido Trotter committed
1158
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1159
1160
1161
1162
1163
1164
1165
1166
    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]