Synnefo » snf-ganeti

#

#

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

"""Transportable objects for Ganeti.

This module provides small, mostly data-only objects which are safe to

pass to and from external parties.

"""

# pylint: disable-msg=E0203,W0201

# E0203: Access to member %r before its definition, since we use

# objects.py which doesn't explicitely initialise its members

# W0201: Attribute '%s' defined outside __init__

import ConfigParser

import re

import copy

from cStringIO import StringIO

from ganeti import errors

from ganeti import constants

from socket import AF_INET

__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",

           "OS", "Node", "NodeGroup", "Cluster", "FillDict"]

_TIMESTAMPS = ["ctime", "mtime"]

_UUID = ["uuid"]

def FillDict(defaults_dict, custom_dict, skip_keys=None):

  """Basic function to apply settings on top a default dict.

  @type defaults_dict: dict

  @param defaults_dict: dictionary holding the default values

  @type custom_dict: dict

  @param custom_dict: dictionary holding customized value

  @type skip_keys: list

  @param skip_keys: which keys not to fill

  @rtype: dict

  @return: dict with the 'full' values

  """

  ret_dict = copy.deepcopy(defaults_dict)

  ret_dict.update(custom_dict)

  if skip_keys:

    for k in skip_keys:

      try:

        del ret_dict[k]

      except KeyError:

        pass

  return ret_dict

def UpgradeGroupedParams(target, defaults):

  """Update all groups for the target parameter.

  @type target: dict of dicts

  @param target: {group: {parameter: value}}

  @type defaults: dict

  @param defaults: default parameter values

  """

  if target is None:

    target = {constants.PP_DEFAULT: defaults}

  else:

    for group in target:

      target[group] = FillDict(defaults, target[group])

  return target

class ConfigObject(object):

  """A generic config object.

  It has the following properties:

    - provides somewhat safe recursive unpickling and pickling for its classes

    - unset attributes which are defined in slots are always returned

      as None instead of raising an error

  Classes derived from this must always declare __slots__ (we use many

  config objects and the memory reduction is useful)

  """

  __slots__ = []

  def __init__(self, **kwargs):

    for k, v in kwargs.iteritems():

      setattr(self, k, v)

  def __getattr__(self, name):

    if name not in self._all_slots():

      raise AttributeError("Invalid object attribute %s.%s" %

                           (type(self).__name__, name))

    return None

  def __setstate__(self, state):

    slots = self._all_slots()

    for name in state:

      if name in slots:

        setattr(self, name, state[name])

  @classmethod

  def _all_slots(cls):

    """Compute the list of all declared slots for a class.

    """

    slots = []

    for parent in cls.__mro__:

      slots.extend(getattr(parent, "__slots__", []))

    return slots

  def ToDict(self):

    """Convert to a dict holding only standard python types.

    The generic routine just dumps all of this object's attributes in

    a dict. It does not work if the class has children who are

    ConfigObjects themselves (e.g. the nics list in an Instance), in

    which case the object should subclass the function in order to

    make sure all objects returned are only standard python types.

    """

    result = {}

    for name in self._all_slots():

      value = getattr(self, name, None)

      if value is not None:

        result[name] = value

    return result

  __getstate__ = ToDict

  @classmethod

  def FromDict(cls, val):

    """Create an object from a dictionary.

    This generic routine takes a dict, instantiates a new instance of

    the given class, and sets attributes based on the dict content.

    As for `ToDict`, this does not work if the class has children

    who are ConfigObjects themselves (e.g. the nics list in an

    Instance), in which case the object should subclass the function

    and alter the objects.

    """

    if not isinstance(val, dict):

      raise errors.ConfigurationError("Invalid object passed to FromDict:"

                                      " expected dict, got %s" % type(val))

    val_str = dict([(str(k), v) for k, v in val.iteritems()])

    obj = cls(**val_str) # pylint: disable-msg=W0142

    return obj

  @staticmethod

  def _ContainerToDicts(container):

    """Convert the elements of a container to standard python types.

    This method converts a container with elements derived from

    ConfigData to standard python types. If the container is a dict,

    we don't touch the keys, only the values.

    """

    if isinstance(container, dict):

      ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])

    elif isinstance(container, (list, tuple, set, frozenset)):

      ret = [elem.ToDict() for elem in container]

    else:

      raise TypeError("Invalid type %s passed to _ContainerToDicts" %

                      type(container))

    return ret

  @staticmethod

  def _ContainerFromDicts(source, c_type, e_type):

    """Convert a container from standard python types.

    This method converts a container with standard python types to

    ConfigData objects. If the container is a dict, we don't touch the

    keys, only the values.

    """

    if not isinstance(c_type, type):

      raise TypeError("Container type %s passed to _ContainerFromDicts is"

                      " not a type" % type(c_type))

    if source is None:

      source = c_type()

    if c_type is dict:

      ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])

    elif c_type in (list, tuple, set, frozenset):

      ret = c_type([e_type.FromDict(elem) for elem in source])

    else:

      raise TypeError("Invalid container type %s passed to"

                      " _ContainerFromDicts" % c_type)

    return ret

  def Copy(self):

    """Makes a deep copy of the current object and its children.

    """

    dict_form = self.ToDict()

    clone_obj = self.__class__.FromDict(dict_form)

    return clone_obj

  def __repr__(self):

    """Implement __repr__ for ConfigObjects."""

    return repr(self.ToDict())

  def UpgradeConfig(self):

    """Fill defaults for missing configuration values.

    This method will be called at configuration load time, and its

    implementation will be object dependent.

    """

    pass

class TaggableObject(ConfigObject):

  """An generic class supporting tags.

  """

  __slots__ = ["tags"]

  VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")

  @classmethod

  def ValidateTag(cls, tag):

    """Check if a tag is valid.

    If the tag is invalid, an errors.TagError will be raised. The

    function has no return value.

    """

    if not isinstance(tag, basestring):

      raise errors.TagError("Invalid tag type (not a string)")

    if len(tag) > constants.MAX_TAG_LEN:

      raise errors.TagError("Tag too long (>%d characters)" %

                            constants.MAX_TAG_LEN)

    if not tag:

      raise errors.TagError("Tags cannot be empty")

    if not cls.VALID_TAG_RE.match(tag):

      raise errors.TagError("Tag contains invalid characters")

  def GetTags(self):

    """Return the tags list.

    """

    tags = getattr(self, "tags", None)

    if tags is None:

      tags = self.tags = set()

    return tags

  def AddTag(self, tag):

    """Add a new tag.

    """

    self.ValidateTag(tag)

    tags = self.GetTags()

    if len(tags) >= constants.MAX_TAGS_PER_OBJ:

      raise errors.TagError("Too many tags")

    self.GetTags().add(tag)

  def RemoveTag(self, tag):

    """Remove a tag.

    """

    self.ValidateTag(tag)

    tags = self.GetTags()

    try:

      tags.remove(tag)

    except KeyError:

      raise errors.TagError("Tag not found")

  def ToDict(self):

    """Taggable-object-specific conversion to standard python types.

    This replaces the tags set with a list.

    """

    bo = super(TaggableObject, self).ToDict()

    tags = bo.get("tags", None)

    if isinstance(tags, set):

      bo["tags"] = list(tags)

    return bo

  @classmethod

  def FromDict(cls, val):

    """Custom function for instances.

    """

    obj = super(TaggableObject, cls).FromDict(val)

    if hasattr(obj, "tags") and isinstance(obj.tags, list):

      obj.tags = set(obj.tags)

    return obj

class ConfigData(ConfigObject):

  """Top-level config object."""

  __slots__ = [

    "version",

    "cluster",

    "nodes",

    "nodegroups",

    "instances",

    "serial_no",

    ] + _TIMESTAMPS

  def ToDict(self):

    """Custom function for top-level config data.

    This just replaces the list of instances, nodes and the cluster

    with standard python types.

    """

    mydict = super(ConfigData, self).ToDict()

    mydict["cluster"] = mydict["cluster"].ToDict()

    for key in "nodes", "instances", "nodegroups":

      mydict[key] = self._ContainerToDicts(mydict[key])

    return mydict

  @classmethod

  def FromDict(cls, val):

    """Custom function for top-level config data

    """

    obj = super(ConfigData, cls).FromDict(val)

    obj.cluster = Cluster.FromDict(obj.cluster)

    obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)

    obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)

    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)

    return obj

  def HasAnyDiskOfType(self, dev_type):

    """Check if in there is at disk of the given type in the configuration.

    @type dev_type: L{constants.LDS_BLOCK}

    @param dev_type: the type to look for

    @rtype: boolean

    @return: boolean indicating if a disk of the given type was found or not

    """

    for instance in self.instances.values():

      for disk in instance.disks:

        if disk.IsBasedOnDiskType(dev_type):

          return True

    return False

  def UpgradeConfig(self):

    """Fill defaults for missing configuration values.

    """

    self.cluster.UpgradeConfig()

    for node in self.nodes.values():

      node.UpgradeConfig()

    for instance in self.instances.values():

      instance.UpgradeConfig()

    if self.nodegroups is None:

      self.nodegroups = {}

    for nodegroup in self.nodegroups.values():

      nodegroup.UpgradeConfig()

    if self.cluster.drbd_usermode_helper is None:

      # To decide if we set an helper let's check if at least one instance has

      # a DRBD disk. This does not cover all the possible scenarios but it

      # gives a good approximation.

      if self.HasAnyDiskOfType(constants.LD_DRBD8):

        self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER

class NIC(ConfigObject):

  """Config object representing a network card."""

  __slots__ = ["mac", "ip", "bridge", "nicparams"]

  @classmethod

  def CheckParameterSyntax(cls, nicparams):

    """Check the given parameters for validity.

    @type nicparams:  dict

    @param nicparams: dictionary with parameter names/value

    @raise errors.ConfigurationError: when a parameter is not valid

    """

    if nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES:

      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]

      raise errors.ConfigurationError(err)

    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and

        not nicparams[constants.NIC_LINK]):

      err = "Missing bridged nic link"

      raise errors.ConfigurationError(err)

  def UpgradeConfig(self):

    """Fill defaults for missing configuration values.

    """

    if self.nicparams is None:

      self.nicparams = {}

      if self.bridge is not None:

        self.nicparams[constants.NIC_MODE] = constants.NIC_MODE_BRIDGED

        self.nicparams[constants.NIC_LINK] = self.bridge

    # bridge is no longer used it 2.1. The slot is left there to support

    # upgrading, but can be removed once upgrades to the current version

    # straight from 2.0 are deprecated.

    if self.bridge is not None:

      self.bridge = None

class Disk(ConfigObject):

  """Config object representing a block device."""

  __slots__ = ["dev_type", "logical_id", "physical_id",

               "children", "iv_name", "size", "mode"]

  def CreateOnSecondary(self):

    """Test if this device needs to be created on a secondary node."""

    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)

  def AssembleOnSecondary(self):

    """Test if this device needs to be assembled on a secondary node."""

    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)

  def OpenOnSecondary(self):

    """Test if this device needs to be opened on a secondary node."""

    return self.dev_type in (constants.LD_LV,)

  def StaticDevPath(self):

    """Return the device path if this device type has a static one.

    Some devices (LVM for example) live always at the same /dev/ path,

    irrespective of their status. For such devices, we return this

    path, for others we return None.

    @warning: The path returned is not a normalized pathname; callers

        should check that it is a valid path.

    """

    if self.dev_type == constants.LD_LV:

      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])

    return None

  def ChildrenNeeded(self):

    """Compute the needed number of children for activation.

    This method will return either -1 (all children) or a positive

    number denoting the minimum number of children needed for

    activation (only mirrored devices will usually return >=0).

    Currently, only DRBD8 supports diskless activation (therefore we

    return 0), for all other we keep the previous semantics and return

    -1.

    """

    if self.dev_type == constants.LD_DRBD8:

      return 0

    return -1

  def IsBasedOnDiskType(self, dev_type):

    """Check if the disk or its children are based on the given type.

    @type dev_type: L{constants.LDS_BLOCK}

    @param dev_type: the type to look for

    @rtype: boolean

    @return: boolean indicating if a device of the given type was found or not

    """

    if self.children:

      for child in self.children:

        if child.IsBasedOnDiskType(dev_type):

          return True

    return self.dev_type == dev_type

  def GetNodes(self, node):

    """This function returns the nodes this device lives on.

    Given the node on which the parent of the device lives on (or, in

    case of a top-level device, the primary node of the devices'

    instance), this function will return a list of nodes on which this

    devices needs to (or can) be assembled.

    """

    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:

      result = [node]

    elif self.dev_type in constants.LDS_DRBD:

      result = [self.logical_id[0], self.logical_id[1]]

      if node not in result:

        raise errors.ConfigurationError("DRBD device passed unknown node")

    else:

      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)

    return result

  def ComputeNodeTree(self, parent_node):

    """Compute the node/disk tree for this disk and its children.

    This method, given the node on which the parent disk lives, will

    return the list of all (node, disk) pairs which describe the disk

    tree in the most compact way. For example, a drbd/lvm stack

    will be returned as (primary_node, drbd) and (secondary_node, drbd)

    which represents all the top-level devices on the nodes.

    """

    my_nodes = self.GetNodes(parent_node)

    result = [(node, self) for node in my_nodes]

    if not self.children:

      # leaf device

      return result

    for node in my_nodes:

      for child in self.children:

        child_result = child.ComputeNodeTree(node)

        if len(child_result) == 1:

          # child (and all its descendants) is simple, doesn't split

          # over multiple hosts, so we don't need to describe it, our

          # own entry for this node describes it completely

          continue

        else:

          # check if child nodes differ from my nodes; note that

          # subdisk can differ from the child itself, and be instead

          # one of its descendants

          for subnode, subdisk in child_result:

            if subnode not in my_nodes:

              result.append((subnode, subdisk))

            # otherwise child is under our own node, so we ignore this

            # entry (but probably the other results in the list will

            # be different)

    return result

  def RecordGrow(self, amount):

    """Update the size of this disk after growth.

    This method recurses over the disks's children and updates their

    size correspondigly. The method needs to be kept in sync with the

    actual algorithms from bdev.

    """

    if self.dev_type == constants.LD_LV or self.dev_type == constants.LD_FILE:

      self.size += amount

    elif self.dev_type == constants.LD_DRBD8:

      if self.children:

        self.children[0].RecordGrow(amount)

      self.size += amount

    else:

      raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"

                                   " disk type %s" % self.dev_type)

  def UnsetSize(self):

    """Sets recursively the size to zero for the disk and its children.

    """

    if self.children:

      for child in self.children:

        child.UnsetSize()

    self.size = 0

  def SetPhysicalID(self, target_node, nodes_ip):

    """Convert the logical ID to the physical ID.

    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.

    Arguments:

      - target_node: the node we wish to configure for

      - nodes_ip: a mapping of node name to ip

    The target_node must exist in in nodes_ip, and must be one of the

    nodes in the logical ID for each of the DRBD devices encountered

    in the disk tree.

    """

    if self.children:

      for child in self.children:

        child.SetPhysicalID(target_node, nodes_ip)

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

      return

    if self.dev_type in constants.LDS_DRBD:

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

      if target_node not in (pnode, snode):

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

                                        target_node)

      pnode_ip = nodes_ip.get(pnode, None)

      snode_ip = nodes_ip.get(snode, None)

      if pnode_ip is None or snode_ip is None:

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

                                        " for %s" % str(self))

      p_data = (pnode_ip, port)

      s_data = (snode_ip, port)

      if pnode == target_node:

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

      else: # it must be secondary, we tested above

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

    else:

      self.physical_id = self.logical_id

    return

  def ToDict(self):

    """Disk-specific conversion to standard python types.

    This replaces the children lists of objects with lists of

    standard python types.

    """

    bo = super(Disk, self).ToDict()

    for attr in ("children",):

      alist = bo.get(attr, None)

      if alist:

        bo[attr] = self._ContainerToDicts(alist)

    return bo

  @classmethod

  def FromDict(cls, val):

    """Custom function for Disks

    """

    obj = super(Disk, cls).FromDict(val)

    if obj.children:

      obj.children = cls._ContainerFromDicts(obj.children, list, Disk)

    if obj.logical_id and isinstance(obj.logical_id, list):

      obj.logical_id = tuple(obj.logical_id)

    if obj.physical_id and isinstance(obj.physical_id, list):

      obj.physical_id = tuple(obj.physical_id)

    if obj.dev_type in constants.LDS_DRBD:

      # we need a tuple of length six here

      if len(obj.logical_id) < 6:

        obj.logical_id += (None,) * (6 - len(obj.logical_id))

    return obj

  def __str__(self):

    """Custom str() formatter for disks.

    """

    if self.dev_type == constants.LD_LV:

      val =  "<LogicalVolume(/dev/%s/%s" % self.logical_id

    elif self.dev_type in constants.LDS_DRBD:

      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]

      val = "<DRBD8("

      if self.physical_id is None:

        phy = "unconfigured"

      else:

        phy = ("configured as %s:%s %s:%s" %

               (self.physical_id[0], self.physical_id[1],

                self.physical_id[2], self.physical_id[3]))

      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %

              (node_a, minor_a, node_b, minor_b, port, phy))

      if self.children and self.children.count(None) == 0:

        val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])

      else:

        val += "no local storage"

    else:

      val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %

             (self.dev_type, self.logical_id, self.physical_id, self.children))

    if self.iv_name is None:

      val += ", not visible"

    else:

      val += ", visible as /dev/%s" % self.iv_name

    if isinstance(self.size, int):

      val += ", size=%dm)>" % self.size

    else:

      val += ", size='%s')>" % (self.size,)

    return val

  def Verify(self):

    """Checks that this disk is correctly configured.

    """

    all_errors = []

    if self.mode not in constants.DISK_ACCESS_SET:

      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))

    return all_errors

  def UpgradeConfig(self):

    """Fill defaults for missing configuration values.

    """

    if self.children:

      for child in self.children:

        child.UpgradeConfig()

    # add here config upgrade for this disk

class Instance(TaggableObject):

  """Config object representing an instance."""

  __slots__ = [

    "name",

    "primary_node",

    "os",

    "hypervisor",

    "hvparams",

    "beparams",

    "osparams",

    "admin_up",

    "nics",

    "disks",

    "disk_template",

    "network_port",

    "serial_no",

    ] + _TIMESTAMPS + _UUID

  def _ComputeSecondaryNodes(self):