objects.py 26.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
#

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


"""Transportable objects for Ganeti.

This module provides small, mostly data-only objects which are safe to
pass to and from external parties.

"""


import ConfigParser
31
import re
32
import copy
33
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
34 35

from ganeti import errors
36
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
37 38 39


__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
Guido Trotter's avatar
Guido Trotter committed
40
           "OS", "Node", "Cluster", "FillDict"]
Iustin Pop's avatar
Iustin Pop committed
41

42

Guido Trotter's avatar
Guido Trotter committed
43
def FillDict(defaults_dict, custom_dict):
Iustin Pop's avatar
Iustin Pop committed
44
  """Basic function to apply settings on top a default dict.
Guido Trotter's avatar
Guido Trotter committed
45

Iustin Pop's avatar
Iustin Pop committed
46 47 48 49 50 51
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
52

Iustin Pop's avatar
Iustin Pop committed
53 54 55 56
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
57

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

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


Iustin Pop's avatar
Iustin Pop committed
76 77 78 79 80 81 82 83 84 85
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
86
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
87 88 89 90 91

  """
  __slots__ = []

  def __init__(self, **kwargs):
92 93
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
94
    self.UpgradeConfig()
Iustin Pop's avatar
Iustin Pop committed
95 96 97

  def __getattr__(self, name):
    if name not in self.__slots__:
98 99
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
100 101
    return None

102 103
  def __setitem__(self, key, value):
    if key not in self.__slots__:
104
      raise KeyError(key)
105 106
    setattr(self, key, value)

Iustin Pop's avatar
Iustin Pop committed
107 108 109 110 111
  def __setstate__(self, state):
    for name in state:
      if name in self.__slots__:
        setattr(self, name, state[name])

112 113 114 115 116 117 118 119 120 121
  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.

    """
122 123 124 125 126 127 128 129
    result = {}
    for name in self.__slots__:
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

  @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))
147 148
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
    obj = cls(**val_str)
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    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 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 __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

194 195 196 197 198 199 200 201 202
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    This method will be called at object init time, and its implementation will
    be object dependent.

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
203

204
class TaggableObject(ConfigObject):
205 206 207
  """An generic class supporting tags.

  """
208
  __slots__ = ConfigObject.__slots__ + ["tags"]
Iustin Pop's avatar
Iustin Pop committed
209

210 211 212 213 214 215 216 217 218
  @staticmethod
  def ValidateTag(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):
219
      raise errors.TagError("Invalid tag type (not a string)")
220
    if len(tag) > constants.MAX_TAG_LEN:
221 222
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
223
    if not tag:
224
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
225
    if not re.match("^[\w.+*/:-]+$", tag):
226
      raise errors.TagError("Tag contains invalid characters")
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

  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:
244
      raise errors.TagError("Too many tags")
245 246 247 248 249 250 251 252 253 254 255
    self.GetTags().add(tag)

  def RemoveTag(self, tag):
    """Remove a tag.

    """
    self.ValidateTag(tag)
    tags = self.GetTags()
    try:
      tags.remove(tag)
    except KeyError:
256
      raise errors.TagError("Tag not found")
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
  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

281

Iustin Pop's avatar
Iustin Pop committed
282 283
class ConfigData(ConfigObject):
  """Top-level config object."""
284
  __slots__ = ["version", "cluster", "nodes", "instances", "serial_no"]
Iustin Pop's avatar
Iustin Pop committed
285

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  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":
      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)
    return obj

Iustin Pop's avatar
Iustin Pop committed
311 312 313

class NIC(ConfigObject):
  """Config object representing a network card."""
314
  __slots__ = ["mac", "ip", "bridge", "nicparams"]
Iustin Pop's avatar
Iustin Pop committed
315

Guido Trotter's avatar
Guido Trotter committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
  @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] is constants.NIC_MODE_BRIDGED and
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

334 335 336 337 338 339 340 341 342
  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
343 344 345 346
    # bridge is no longer used it 2.1. The slot is left there to support
    # upgrading, but will be removed in 2.2
    if self.bridge is not None:
      self.bridge = None
347

Iustin Pop's avatar
Iustin Pop committed
348 349 350 351

class Disk(ConfigObject):
  """Config object representing a block device."""
  __slots__ = ["dev_type", "logical_id", "physical_id",
352
               "children", "iv_name", "size", "mode"]
Iustin Pop's avatar
Iustin Pop committed
353 354 355

  def CreateOnSecondary(self):
    """Test if this device needs to be created on a secondary node."""
356
    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
357 358 359

  def AssembleOnSecondary(self):
    """Test if this device needs to be assembled on a secondary node."""
360
    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
361 362 363

  def OpenOnSecondary(self):
    """Test if this device needs to be opened on a secondary node."""
364
    return self.dev_type in (constants.LD_LV,)
Iustin Pop's avatar
Iustin Pop committed
365

366 367 368 369 370 371 372 373 374 375 376 377
  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.

    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
    return None

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
  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

Iustin Pop's avatar
Iustin Pop committed
394 395 396 397 398 399 400 401 402
  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.

    """
403
    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
404
      result = [node]
405
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
406 407
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
408
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
409
    else:
410
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
411 412 413 414 415 416 417
    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
418 419 420
    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.
Iustin Pop's avatar
Iustin Pop committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447

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

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
  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:
      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)

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
  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:
491
      pnode, snode, port, pminor, sminor, secret = self.logical_id
492 493 494 495 496 497 498 499
      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))
500 501
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
502
      if pnode == target_node:
503
        self.physical_id = p_data + s_data + (pminor, secret)
504
      else: # it must be secondary, we tested above
505
        self.physical_id = s_data + p_data + (sminor, secret)
506 507 508 509
    else:
      self.physical_id = self.logical_id
    return

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
  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)
537 538 539 540
    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))
541 542
    return obj

543 544 545 546 547 548 549
  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:
550
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
551
      val = "<DRBD8("
552 553 554 555
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
556 557
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
558

559 560
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
561 562 563 564 565 566 567 568 569 570 571
      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
Iustin Pop's avatar
Iustin Pop committed
572 573 574 575
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
576 577
    return val

578 579 580 581
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
582
    all_errors = []
583
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
584 585
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
586

Iustin Pop's avatar
Iustin Pop committed
587

588
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
589
  """Config object representing an instance."""
590
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
591 592 593
    "name",
    "primary_node",
    "os",
594
    "hypervisor",
595 596
    "hvparams",
    "beparams",
597
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
598 599 600
    "nics",
    "disks",
    "disk_template",
601
    "network_port",
602
    "serial_no",
Iustin Pop's avatar
Iustin Pop committed
603 604 605 606 607
    ]

  def _ComputeSecondaryNodes(self):
    """Compute the list of secondary nodes.

608 609 610 611 612 613 614 615 616 617 618 619 620
    This is a simple wrapper over _ComputeAllNodes.

    """
    all_nodes = set(self._ComputeAllNodes())
    all_nodes.discard(self.primary_node)
    return tuple(all_nodes)

  secondary_nodes = property(_ComputeSecondaryNodes, None, None,
                             "List of secondary nodes")

  def _ComputeAllNodes(self):
    """Compute the list of all nodes.

Iustin Pop's avatar
Iustin Pop committed
621 622 623 624 625 626
    Since the data is already there (in the drbd disks), keeping it as
    a separate normal attribute is redundant and if not properly
    synchronised can cause problems. Thus it's better to compute it
    dynamically.

    """
627 628
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
629
      if device.dev_type in constants.LDS_DRBD:
630 631 632
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
633 634
      if device.children:
        for child in device.children:
635
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
636

637
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
638
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
639
    for device in self.disks:
640 641
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
642

643 644
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
645 646 647 648

  def MapLVsByNode(self, lvmap=None, devs=None, node=None):
    """Provide a mapping of nodes to LVs this instance owns.

Iustin Pop's avatar
Iustin Pop committed
649 650
    This function figures out what logical volumes should belong on
    which nodes, recursing through a device tree.
Iustin Pop's avatar
Iustin Pop committed
651

Iustin Pop's avatar
Iustin Pop committed
652 653
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
654

Iustin Pop's avatar
Iustin Pop committed
655 656
    @return: None if lvmap arg is given, otherwise, a dictionary
        of the form { 'nodename' : ['volume1', 'volume2', ...], ... }
Iustin Pop's avatar
Iustin Pop committed
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673

    """
    if node == None:
      node = self.primary_node

    if lvmap is None:
      lvmap = { node : [] }
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

    for dev in devs:
674
      if dev.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
675 676
        lvmap[node].append(dev.logical_id[1])

677
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
678 679 680 681 682 683 684 685 686
        if dev.children:
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])

      elif dev.children:
        self.MapLVsByNode(lvmap, dev.children, node)

    return ret

687 688
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
689

690
    This is just a wrapper that does validation of the index.
691

692 693 694 695 696
    @type idx: int
    @param idx: the disk index
    @rtype: L{Disk}
    @return: the corresponding disk
    @raise errors.OpPrereqError: when the given index is not valid
697

698 699 700 701 702 703 704 705 706
    """
    try:
      idx = int(idx)
      return self.disks[idx]
    except ValueError, err:
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err))
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
                                 " 0 to %d" % (idx, len(self.disks)))
707

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
  def ToDict(self):
    """Instance-specific conversion to standard python types.

    This replaces the children lists of objects with lists of standard
    python types.

    """
    bo = super(Instance, self).ToDict()

    for attr in "nics", "disks":
      alist = bo.get(attr, None)
      if alist:
        nlist = self._ContainerToDicts(alist)
      else:
        nlist = []
      bo[attr] = nlist
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for instances.

    """
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

Iustin Pop's avatar
Iustin Pop committed
736 737 738 739 740 741

class OS(ConfigObject):
  """Config object representing an operating system."""
  __slots__ = [
    "name",
    "path",
742
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
743 744
    "create_script",
    "export_script",
745 746
    "import_script",
    "rename_script",
Iustin Pop's avatar
Iustin Pop committed
747 748
    ]

749

750
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
751
  """Config object representing a node."""
752 753 754 755
  __slots__ = TaggableObject.__slots__ + [
    "name",
    "primary_ip",
    "secondary_ip",
756
    "serial_no",
757
    "master_candidate",
758
    "offline",
759
    "drained",
760
    ]
Iustin Pop's avatar
Iustin Pop committed
761 762


763
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
764
  """Config object representing the cluster."""
765
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
766 767 768
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
769
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
770 771 772
    "mac_prefix",
    "volume_group_name",
    "default_bridge",
773
    "default_hypervisor",
774 775 776 777 778
    "master_node",
    "master_ip",
    "master_netdev",
    "cluster_name",
    "file_storage_dir",
779
    "enabled_hypervisors",
780 781
    "hvparams",
    "beparams",
782
    "nicparams",
783
    "candidate_pool_size",
784
    "modify_etc_hosts",
Iustin Pop's avatar
Iustin Pop committed
785 786
    ]

787 788 789 790
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
791 792 793 794
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
795
        self.hvparams[hypervisor] = FillDict(
796 797
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

798 799
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
800 801 802 803 804 805
    migrate_default_bridge = not self.nicparams
    self.nicparams = UpgradeGroupedParams(self.nicparams,
                                          constants.NICC_DEFAULTS)
    if migrate_default_bridge:
      self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
        self.default_bridge
806

807 808 809
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

810 811 812 813 814
    # default_bridge is no longer used it 2.1. The slot is left there to
    # support auto-upgrading, but will be removed in 2.2
    if self.default_bridge is not None:
      self.default_bridge = None

815 816 817 818 819 820 821 822
    # default_hypervisor is just the first enabled one in 2.1
    if self.default_hypervisor is not None:
      self.enabled_hypervisors = [self.default_hypervisor] + \
        [hvname for hvname in self.enabled_hypervisors
         if hvname != self.default_hypervisor]
      self.default_hypervisor = None


823 824 825 826
  def ToDict(self):
    """Custom function for cluster.

    """
827
    mydict = super(Cluster, self).ToDict()
828 829 830 831 832 833 834 835
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for cluster.

    """
836
    obj = super(Cluster, cls).FromDict(val)
837 838 839 840
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

841 842 843
  def FillHV(self, instance):
    """Fill an instance's hvparams dict.

844
    @type instance: L{objects.Instance}
845 846 847 848 849 850
    @param instance: the instance parameter to fill
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
Guido Trotter's avatar
Guido Trotter committed
851
    return FillDict(self.hvparams.get(instance.hypervisor, {}),
852 853 854 855 856
                         instance.hvparams)

  def FillBE(self, instance):
    """Fill an instance's beparams dict.

857
    @type instance: L{objects.Instance}
858 859 860 861 862 863
    @param instance: the instance parameter to fill
    @rtype: dict
    @return: a copy of the instance's beparams with missing keys filled from
        the cluster defaults

    """
864 865
    return FillDict(self.beparams.get(constants.PP_DEFAULT, {}),
                          instance.beparams)
866

867

868 869 870 871 872 873 874 875 876
class BlockDevStatus(ConfigObject):
  """Config object representing the status of a block device."""
  __slots__ = [
    "dev_path",
    "major",
    "minor",
    "sync_percent",
    "estimated_time",
    "is_degraded",
877
    "ldisk_status",
878 879 880
    ]


Iustin Pop's avatar
Iustin Pop committed
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
class SerializableConfigParser(ConfigParser.SafeConfigParser):
  """Simple wrapper over ConfigParse that allows serialization.

  This class is basically ConfigParser.SafeConfigParser with two
  additional methods that allow it to serialize/unserialize to/from a
  buffer.

  """
  def Dumps(self):
    """Dump this instance and return the string representation."""
    buf = StringIO()
    self.write(buf)
    return buf.getvalue()

  @staticmethod
  def Loads(data):
    """Load data from a string."""
    buf = StringIO(data)
    cfp = SerializableConfigParser()
    cfp.readfp(buf)
    return cfp