Synnefo » snf-ganeti

#

#

# 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

This module provides the interface to the Ganeti cluster configuration.

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.

Currently, the data storage format is JSON. YAML was slow and consuming too

much memory.

"""

import os

import tempfile

import random

import logging

import time

from ganeti import errors

from ganeti import locking

from ganeti import utils

from ganeti import constants

from ganeti import rpc

from ganeti import objects

from ganeti import serializer

_config_lock = locking.SharedLock()

def _ValidateConfig(data):

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

  """

  if data.version != constants.CONFIG_VERSION:

    raise errors.ConfigurationError("Cluster configuration version"

                                    " mismatch, got %s instead of %s" %

                                    (data.version,

                                     constants.CONFIG_VERSION))

class ConfigWriter:

  """The interface to the cluster configuration.

  """

  def __init__(self, cfg_file=None, offline=False):

    self.write_count = 0

    self._lock = _config_lock

    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

    self._temporary_ids = set()

    self._temporary_drbds = {}

    self._temporary_macs = set()

    # 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

    self._last_cluster_serial = -1

    self._OpenConfig()

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

  @locking.ssynchronized(_config_lock, shared=1)

  def GenerateMAC(self):

    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """

    prefix = self._config_data.cluster.mac_prefix

    all_macs = self._AllMACs()

    retries = 64

    while retries > 0:

      byte1 = random.randrange(0, 256)

      byte2 = random.randrange(0, 256)

      byte3 = random.randrange(0, 256)

      mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)

      if mac not in all_macs and mac not in self._temporary_macs:

        break

      retries -= 1

    else:

      raise errors.ConfigurationError("Can't generate unique MAC")

    self._temporary_macs.add(mac)

    return mac

  @locking.ssynchronized(_config_lock, shared=1)

  def IsMacInUse(self, mac):

    """Predicate: check if the specified MAC is in use in the Ganeti cluster.

    This only checks instances managed by this cluster, it does not

    check for potential collisions elsewhere.

    """

    all_macs = self._AllMACs()

    return mac in all_macs or mac in self._temporary_macs

  @locking.ssynchronized(_config_lock, shared=1)

  def GenerateDRBDSecret(self):

    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """

    all_secrets = self._AllDRBDSecrets()

    retries = 64

    while retries > 0:

      secret = utils.GenerateSecret()

      if secret not in all_secrets:

        break

      retries -= 1

    else:

      raise errors.ConfigurationError("Can't generate unique DRBD secret")

    return secret

  def _AllLVs(self):

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

  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:

      existing.update(self._temporary_ids)

    existing.update(self._AllLVs())

    existing.update(self._config_data.instances.keys())

    existing.update(self._config_data.nodes.keys())

    return existing

  @locking.ssynchronized(_config_lock, shared=1)

  def GenerateUniqueID(self, exceptions=None):

    """Generate an unique disk name.

    This checks the current node, instances and disk names for

    duplicates.

    @param exceptions: a list with some other names which should be checked

        for uniqueness (used for example when you want to get

        more than one id at one time without adding each one in

        turn to the config file)

    @rtype: string

    @return: the unique id

    """

    existing = self._AllIDs(include_temporary=True)

    if exceptions is not None:

      existing.update(exceptions)

    retries = 64

    while retries > 0:

      unique_id = utils.NewUUID()

      if unique_id not in existing and unique_id is not None:

        break

    else:

      raise errors.ConfigurationError("Not able generate an unique ID"

                                      " (last tried ID: %s" % unique_id)

    self._temporary_ids.add(unique_id)

    return unique_id

  def _CleanupTemporaryIDs(self):

    """Cleanups the _temporary_ids structure.

    """

    existing = self._AllIDs(include_temporary=False)

    self._temporary_ids = self._temporary_ids - existing

  def _AllMACs(self):

    """Return all MACs present in the config.

    @rtype: list

    @return: the list of all MACs

    """

    result = []

    for instance in self._config_data.instances.values():

      for nic in instance.nics:

        result.append(nic.mac)

    return result

  def _AllDRBDSecrets(self):

    """Return all DRBD secrets present in the config.

    @rtype: list

    @return: the list of all DRBD secrets

    """

    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

  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 = []

    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)

    if disk.children:

      for child in disk.children:

        result.extend(self._CheckDiskIDs(child, l_ids, p_ids))

    return result

  def _UnlockedVerifyConfig(self):

    """Verify function.

    @rtype: list

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

        configuration errors

    """

    result = []

    seen_macs = []

    ports = {}

    data = self._config_data

    seen_lids = []

    seen_pids = []

    # 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

    for instance_name in data.instances:

      instance = data.instances[instance_name]

      if instance.primary_node not in data.nodes:

        result.append("instance '%s' has invalid primary node '%s'" %

                      (instance_name, instance.primary_node))

      for snode in instance.secondary_nodes:

        if snode not in data.nodes:

          result.append("instance '%s' has invalid secondary node '%s'" %

                        (instance_name, snode))

      for idx, nic in enumerate(instance.nics):

        if nic.mac in seen_macs:

          result.append("instance '%s' has NIC %d mac %s duplicate" %

                        (instance_name, idx, nic.mac))

        else:

          seen_macs.append(nic.mac)

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

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

        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))

    # cluster-wide pool of free ports

    for free_port in data.cluster.tcpudp_port_pool:

      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:

      if keys[-1] > data.cluster.highest_used_port:

        result.append("Highest used port mismatch, saved %s, computed %s" %

                      (data.cluster.highest_used_port, keys[-1]))

    if not data.nodes[data.cluster.master_node].master_candidate:

      result.append("Master node is not a master candidate")

    # master candidate checks

    mc_now, mc_max = self._UnlockedGetMasterCandidateStats()

    if mc_now < mc_max:

      result.append("Not enough master candidates: actual %d, target %d" %

                    (mc_now, mc_max))

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

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

    return result

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

  def _UnlockedSetDiskID(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.

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

    """

    if disk.children:

      for child in disk.children:

        self._UnlockedSetDiskID(child, node_name)

    if disk.logical_id is None and disk.physical_id is not None:

      return

    if disk.dev_type == constants.LD_DRBD8:

      pnode, snode, port, pminor, sminor, secret = disk.logical_id

      if node_name not in (pnode, snode):

        raise errors.ConfigurationError("DRBD device not knowing node %s" %

                                        node_name)

      pnode_info = self._UnlockedGetNodeInfo(pnode)

      snode_info = self._UnlockedGetNodeInfo(snode)

      if pnode_info is None or snode_info is None:

        raise errors.ConfigurationError("Can't find primary or secondary node"

                                        " for %s" % str(disk))

      p_data = (pnode_info.secondary_ip, port)

      s_data = (snode_info.secondary_ip, port)

      if pnode == node_name:

        disk.physical_id = p_data + s_data + (pminor, secret)

      else: # it must be secondary, we tested above

        disk.physical_id = s_data + p_data + (sminor, secret)

    else:

      disk.physical_id = disk.logical_id

    return

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

  def AddTcpUdpPort(self, port):

    """Adds a new port to the available port pool.

    """

    if not isinstance(port, int):

      raise errors.ProgrammerError("Invalid type passed for port")

    self._config_data.cluster.tcpudp_port_pool.add(port)

    self._WriteConfig()

  @locking.ssynchronized(_config_lock, shared=1)

  def GetPortList(self):

    """Returns a copy of the current port list.

    """

    return self._config_data.cluster.tcpudp_port_pool.copy()

  @locking.ssynchronized(_config_lock)

  def AllocatePort(self):

    """Allocate a port.

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

    """

    # If there are TCP/IP ports configured, we use them first.

    if self._config_data.cluster.tcpudp_port_pool:

      port = self._config_data.cluster.tcpudp_port_pool.pop()

    else:

      port = self._config_data.cluster.highest_used_port + 1

      if port >= constants.LAST_DRBD_PORT:

        raise errors.ConfigurationError("The highest used port is greater"

                                        " than %s. Aborting." %

                                        constants.LAST_DRBD_PORT)

      self._config_data.cluster.highest_used_port = port

    self._WriteConfig()

    return port

  def _UnlockedComputeDRBDMap(self):

    """Compute the used DRBD minor/nodes.

    @rtype: (dict, list)

    @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), and a list of duplicates; if the duplicates

        list is not empty, the configuration is corrupted and its caller

        should raise an exception

    """

    def _AppendUsedPorts(instance_name, disk, used):

      duplicates = []

      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:

        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]

        for node, port in ((node_a, minor_a), (node_b, minor_b)):

          assert node in used, ("Node '%s' of instance '%s' not found"

                                " in node list" % (node, instance_name))

          if port in used[node]:

            duplicates.append((node, port, instance_name, used[node][port]))

          else:

            used[node][port] = instance_name

      if disk.children:

        for child in disk.children:

          duplicates.extend(_AppendUsedPorts(instance_name, child, used))

      return duplicates

    duplicates = []

    my_dict = dict((node, {}) for node in self._config_data.nodes)

    for instance in self._config_data.instances.itervalues():

      for disk in instance.disks:

        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))

    for (node, minor), instance in self._temporary_drbds.iteritems():

      if minor in my_dict[node] and my_dict[node][minor] != instance:

        duplicates.append((node, minor, instance, my_dict[node][minor]))

      else:

        my_dict[node][minor] = instance

    return my_dict, duplicates

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

    """

    d_map, duplicates = self._UnlockedComputeDRBDMap()

    if duplicates:

      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %

                                      str(duplicates))

    return d_map

  @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.

    @type instance: string

    @param instance: the instance for which we allocate minors

    """

    assert isinstance(instance, basestring), \

           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance

    d_map, duplicates = self._UnlockedComputeDRBDMap()

    if duplicates:

      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %

                                      str(duplicates))

    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

        self._temporary_drbds[(nname, 0)] = instance

        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

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

      ndata[minor] = instance

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

    logging.debug("Request to allocate drbd minors, input: %s, returning %s",

                  nodes, result)

    return result

  def _UnlockedReleaseDRBDMinors(self, instance):

    """Release temporary drbd minors allocated for a given instance.

    @type instance: string

    @param instance: the instance for which temporary minors should be

                     released

    """

    assert isinstance(instance, basestring), \

           "Invalid argument passed to ReleaseDRBDMinors"

    for key, name in self._temporary_drbds.items():

      if name == instance:

        del self._temporary_drbds[key]

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

  @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.

    """

    return self._config_data.cluster.enabled_hypervisors[0]

  @locking.ssynchronized(_config_lock, shared=1)

  def GetHostKey(self):

    """Return the rsa hostkey from the config.

    @rtype: string

    @return: the rsa hostkey

    """

    return self._config_data.cluster.rsahostkeypub

  @locking.ssynchronized(_config_lock)

  def AddInstance(self, instance):

    """Add an instance to the config.

    This should be used after creating a new instance.

    @type instance: L{objects.Instance}

    @param instance: the instance object

    """

    if not isinstance(instance, objects.Instance):

      raise errors.ProgrammerError("Invalid type passed to AddInstance")

    if instance.disk_template != constants.DT_DISKLESS:

      all_lvs = instance.MapLVsByNode()

      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)

    all_macs = self._AllMACs()

    for nic in instance.nics:

      if nic.mac in all_macs:

        raise errors.ConfigurationError("Cannot add instance %s:"

          " MAC address '%s' already in use." % (instance.name, nic.mac))

    instance.serial_no = 1

    instance.ctime = instance.mtime = time.time()

    self._config_data.instances[instance.name] = instance

    self._config_data.cluster.serial_no += 1

    self._UnlockedReleaseDRBDMinors(instance.name)

    for nic in instance.nics:

      self._temporary_macs.discard(nic.mac)

    self._WriteConfig()

  def _SetInstanceStatus(self, instance_name, status):

    """Set the instance's status to a given value.

    """

    assert isinstance(status, bool), \

           "Invalid status '%s' passed to SetInstanceStatus" % (status,)

    if instance_name not in self._config_data.instances:

      raise errors.ConfigurationError("Unknown instance '%s'" %

                                      instance_name)

    instance = self._config_data.instances[instance_name]

    if instance.admin_up != status:

      instance.admin_up = status

      instance.serial_no += 1

      instance.mtime = time.time()

      self._WriteConfig()

  @locking.ssynchronized(_config_lock)

  def MarkInstanceUp(self, instance_name):

    """Mark the instance status to up in the config.

    """

    self._SetInstanceStatus(instance_name, True)

  @locking.ssynchronized(_config_lock)

  def RemoveInstance(self, instance_name):

    """Remove the instance from the configuration.

    """

    if instance_name not in self._config_data.instances:

      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)

    del self._config_data.instances[instance_name]

    self._config_data.cluster.serial_no += 1

    self._WriteConfig()

  @locking.ssynchronized(_config_lock)

  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

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

    self._config_data.instances[inst.name] = inst

    self._WriteConfig()

  @locking.ssynchronized(_config_lock)

  def MarkInstanceDown(self, instance_name):

    """Mark the status of an instance to down in the configuration.

    """

    self._SetInstanceStatus(instance_name, False)

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

  @locking.ssynchronized(_config_lock, shared=1)

  def GetInstanceList(self):

    """Get the list of instances.

    @return: array of instances, ex. ['instance2.example.com',

        'instance1.example.com']

    """

    return self._UnlockedGetInstanceList()

  @locking.ssynchronized(_config_lock, shared=1)

  def ExpandInstanceName(self, short_name):

    """Attempt to expand an incomplete instance name.

    """

    return utils.MatchNameComponent(short_name,

                                    self._config_data.instances.keys())

  def _UnlockedGetInstanceInfo(self, instance_name):

    """Returns information about an instance.

    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]

  @locking.ssynchronized(_config_lock, shared=1)

  def GetInstanceInfo(self, instance_name):

    """Returns information about an instance.

    It takes the information from the configuration file. Other information of

    an instance are taken from the live systems.

    @param instance_name: name of the instance, e.g.

        I{instance1.example.com}

    @rtype: L{objects.Instance}

    @return: the instance object

    """

    return self._UnlockedGetInstanceInfo(instance_name)

  @locking.ssynchronized(_config_lock, shared=1)

  def GetAllInstancesInfo(self):

    """Get the configuration of all instances.

    @rtype: dict

    @return: dict of (instance, instance_info), where instance_info is what

              would GetInstanceInfo return for the node

    """

    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))

                    for instance in self._UnlockedGetInstanceList()])

    return my_dict

  @locking.ssynchronized(_config_lock)

  def AddNode(self, node):

    """Add a node to the configuration.

    @type node: L{objects.Node}

    @param node: a Node instance

    """

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

    node.serial_no = 1

    node.ctime = node.mtime = time.time()

    self._config_data.nodes[node.name] = node

    self._config_data.cluster.serial_no += 1

    self._WriteConfig()

  @locking.ssynchronized(_config_lock)

  def RemoveNode(self, node_name):

    """Remove a node from the configuration.

    """

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

    if node_name not in self._config_data.nodes:

      raise errors.ConfigurationError("Unknown node '%s'" % node_name)

    del self._config_data.nodes[node_name]

    self._config_data.cluster.serial_no += 1

    self._WriteConfig()

  @locking.ssynchronized(_config_lock, shared=1)

  def ExpandNodeName(self, short_name):

    """Attempt to expand an incomplete instance name.

    """

    return utils.MatchNameComponent(short_name,

                                    self._config_data.nodes.keys())

  def _UnlockedGetNodeInfo(self, node_name):

    """Get the configuration of a node, as stored in the config.

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

    held.

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

    @rtype: L{objects.Node}

    @return: the node object

    """

    if node_name not in self._config_data.nodes:

      return None

    return self._config_data.nodes[node_name]

  @locking.ssynchronized(_config_lock, shared=1)

  def GetNodeInfo(self, node_name):

    """Get the configuration of a node, as stored in the config.

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

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

    @rtype: L{objects.Node}

    @return: the node object

    """

    return self._UnlockedGetNodeInfo(node_name)

  def _UnlockedGetNodeList(self):

    """Return the list of nodes which are in the configuration.

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

    held.

    @rtype: list

    """

    return self._config_data.nodes.keys()

  @locking.ssynchronized(_config_lock, shared=1)

  def GetNodeList(self):

    """Return the list of nodes which are in the configuration.

    """

    return self._UnlockedGetNodeList()

  @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]

  @locking.ssynchronized(_config_lock, shared=1)

  def GetAllNodesInfo(self):

    """Get the configuration of all nodes.

    @rtype: dict

    @return: dict of (node, node_info), where node_info is what

              would GetNodeInfo return for the node

    """

    my_dict = dict([(node, self._UnlockedGetNodeInfo(node))

                    for node in self._UnlockedGetNodeList()])

    return my_dict

  def _UnlockedGetMasterCandidateStats(self, exceptions=None):

    """Get the number of current and maximum desired and possible candidates.

    @type exceptions: list

    @param exceptions: if passed, list of nodes that should be ignored

    @rtype: tuple

    @return: tuple of (current, desired and possible)

    """

    mc_now = mc_max = 0

    for node in self._config_data.nodes.values():

      if exceptions and node.name in exceptions:

        continue

      if not (node.offline or node.drained):

        mc_max += 1

      if node.master_candidate:

        mc_now += 1

    mc_max = min(mc_max, self._config_data.cluster.candidate_pool_size)

    return (mc_now, mc_max)

  @locking.ssynchronized(_config_lock, shared=1)

  def GetMasterCandidateStats(self, exceptions=None):

    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

    @type exceptions: list

    @param exceptions: if passed, list of nodes that should be ignored

    @rtype: tuple

    @return: tuple of (current, max)

    """

    return self._UnlockedGetMasterCandidateStats(exceptions)

  @locking.ssynchronized(_config_lock)

  def MaintainCandidatePool(self):

    """Try to grow the candidate pool to the desired size.

    @rtype: list

    @return: list with the adjusted nodes (L{objects.Node} instances)

    """

    mc_now, mc_max = self._UnlockedGetMasterCandidateStats()

    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]

        if node.master_candidate or node.offline or node.drained:

          continue

        mod_list.append(node)

        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