objects.py 28.6 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
_TIMESTAMPS = ["ctime", "mtime"]
43
_UUID = ["uuid"]
44

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

Iustin Pop's avatar
Iustin Pop committed
48
49
50
51
52
53
  @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
54

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

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

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

  """
  __slots__ = []

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

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

  def __setstate__(self, state):
    for name in state:
      if name in self.__slots__:
        setattr(self, name, state[name])

108
109
110
111
112
113
114
115
116
117
  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.

    """
118
119
120
121
122
123
124
125
    result = {}
    for name in self.__slots__:
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

  @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))
143
144
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
    obj = cls(**val_str)
145
146
147
148
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
    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

186
187
188
189
190
191
192
193
  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

194
195
196
197
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

198
199
200
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

201
202
    This method will be called at configuration load time, and its
    implementation will be object dependent.
203
204
205
206

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
207

208
class TaggableObject(ConfigObject):
209
210
211
  """An generic class supporting tags.

  """
212
  __slots__ = ConfigObject.__slots__ + ["tags"]
Iustin Pop's avatar
Iustin Pop committed
213
  VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")
Iustin Pop's avatar
Iustin Pop committed
214

Iustin Pop's avatar
Iustin Pop committed
215
216
  @classmethod
  def ValidateTag(cls, tag):
217
218
219
220
221
222
223
    """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):
224
      raise errors.TagError("Invalid tag type (not a string)")
225
    if len(tag) > constants.MAX_TAG_LEN:
226
227
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
228
    if not tag:
229
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
230
    if not cls.VALID_TAG_RE.match(tag):
231
      raise errors.TagError("Tag contains invalid characters")
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

  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:
249
      raise errors.TagError("Too many tags")
250
251
252
253
254
255
256
257
258
259
260
    self.GetTags().add(tag)

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

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

263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
  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

286

Iustin Pop's avatar
Iustin Pop committed
287
288
class ConfigData(ConfigObject):
  """Top-level config object."""
Michael Hanselmann's avatar
Michael Hanselmann committed
289
290
  __slots__ = (["version", "cluster", "nodes", "instances", "serial_no"] +
               _TIMESTAMPS)
Iustin Pop's avatar
Iustin Pop committed
291

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
  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

317
318
319
320
321
322
323
324
325
326
  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()

Iustin Pop's avatar
Iustin Pop committed
327
328
329

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

Guido Trotter's avatar
Guido Trotter committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
  @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)

350
351
352
353
354
355
356
357
358
  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
359
360
361
362
    # 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
363

Iustin Pop's avatar
Iustin Pop committed
364
365
366
367

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

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

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

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

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

394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
  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
410
411
412
413
414
415
416
417
418
  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.

    """
419
    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
420
      result = [node]
421
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
422
423
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
424
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
425
    else:
426
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
427
428
429
430
431
432
433
    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
434
435
436
    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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463

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

464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
  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)

482
483
484
485
486
487
488
489
490
  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

491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
  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:
516
      pnode, snode, port, pminor, sminor, secret = self.logical_id
517
518
519
520
521
522
523
524
      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))
525
526
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
527
      if pnode == target_node:
528
        self.physical_id = p_data + s_data + (pminor, secret)
529
      else: # it must be secondary, we tested above
530
        self.physical_id = s_data + p_data + (sminor, secret)
531
532
533
534
    else:
      self.physical_id = self.logical_id
    return

535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
  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)
562
563
564
565
    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))
566
567
    return obj

568
569
570
571
572
573
574
  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:
575
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
576
      val = "<DRBD8("
577
578
579
580
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
581
582
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
583

584
585
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
586
587
588
589
590
591
592
593
594
595
596
      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
597
598
599
600
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
601
602
    return val

603
604
605
606
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
607
    all_errors = []
608
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
609
610
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
611

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

Iustin Pop's avatar
Iustin Pop committed
621

622
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
623
  """Config object representing an instance."""
624
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
625
626
627
    "name",
    "primary_node",
    "os",
628
    "hypervisor",
629
630
    "hvparams",
    "beparams",
631
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
632
633
634
    "nics",
    "disks",
    "disk_template",
635
    "network_port",
636
    "serial_no",
637
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
638
639
640
641

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

642
643
644
645
646
647
648
649
650
651
652
653
654
    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
655
656
657
658
659
660
    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.

    """
661
662
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
663
      if device.dev_type in constants.LDS_DRBD:
664
665
666
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
667
668
      if device.children:
        for child in device.children:
669
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
670

671
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
672
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
673
    for device in self.disks:
674
675
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
676

677
678
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
679
680
681
682

  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
683
684
    This function figures out what logical volumes should belong on
    which nodes, recursing through a device tree.
Iustin Pop's avatar
Iustin Pop committed
685

Iustin Pop's avatar
Iustin Pop committed
686
687
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
688

Iustin Pop's avatar
Iustin Pop committed
689
690
    @return: None if lvmap arg is given, otherwise, a dictionary
        of the form { 'nodename' : ['volume1', 'volume2', ...], ... }
Iustin Pop's avatar
Iustin Pop committed
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707

    """
    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:
708
      if dev.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
709
710
        lvmap[node].append(dev.logical_id[1])

711
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
712
713
714
715
716
717
718
719
720
        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

721
722
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
723

724
    This is just a wrapper that does validation of the index.
725

726
727
728
729
730
    @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
731

732
733
734
735
736
737
738
739
740
    """
    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)))
741

742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
  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

770
771
772
773
774
775
776
777
778
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
779
780
781
782
783
784

class OS(ConfigObject):
  """Config object representing an operating system."""
  __slots__ = [
    "name",
    "path",
785
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
786
787
    "create_script",
    "export_script",
788
789
    "import_script",
    "rename_script",
790
    "supported_variants",
Iustin Pop's avatar
Iustin Pop committed
791
792
    ]

793

794
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
795
  """Config object representing a node."""
796
797
798
799
  __slots__ = TaggableObject.__slots__ + [
    "name",
    "primary_ip",
    "secondary_ip",
800
    "serial_no",
801
    "master_candidate",
802
    "offline",
803
    "drained",
804
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
805
806


807
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
808
  """Config object representing the cluster."""
809
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
810
811
812
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
813
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
814
815
816
    "mac_prefix",
    "volume_group_name",
    "default_bridge",
817
    "default_hypervisor",
818
819
820
821
822
    "master_node",
    "master_ip",
    "master_netdev",
    "cluster_name",
    "file_storage_dir",
823
    "enabled_hypervisors",
824
825
    "hvparams",
    "beparams",
826
    "nicparams",
827
    "candidate_pool_size",
828
    "modify_etc_hosts",
829
    "modify_ssh_setup",
830
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
831

832
833
834
835
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
836
837
838
839
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
840
        self.hvparams[hypervisor] = FillDict(
841
842
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

843
844
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
845
846
847
848
849
850
    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
851

852
853
854
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

855
856
857
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

858
859
860
861
862
    # 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

863
864
    # default_hypervisor is just the first enabled one in 2.1
    if self.default_hypervisor is not None:
Michael Hanselmann's avatar
Michael Hanselmann committed
865
      self.enabled_hypervisors = ([self.default_hypervisor] +
866
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
867
         if hvname != self.default_hypervisor])
868
869
      self.default_hypervisor = None

870
871
872
873
  def ToDict(self):
    """Custom function for cluster.

    """
874
    mydict = super(Cluster, self).ToDict()
875
876
877
878
879
880
881
882
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
883
    obj = super(Cluster, cls).FromDict(val)
884
885
886
887
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

888
889
890
  def FillHV(self, instance):
    """Fill an instance's hvparams dict.

891
    @type instance: L{objects.Instance}
892
893
894
895
896
897
    @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
898
    return FillDict(self.hvparams.get(instance.hypervisor, {}),
899
900
901
902
903
                         instance.hvparams)

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

904
    @type instance: L{objects.Instance}
905
906
907
908
909
910
    @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

    """
911
912
    return FillDict(self.beparams.get(constants.PP_DEFAULT, {}),
                          instance.beparams)
913

914

915
916
917
918
919
920
921
922
923
class BlockDevStatus(ConfigObject):
  """Config object representing the status of a block device."""
  __slots__ = [
    "dev_path",
    "major",
    "minor",
    "sync_percent",
    "estimated_time",
    "is_degraded",
924
    "ldisk_status",
925
926
927
    ]


Guido Trotter's avatar
Guido Trotter committed
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
class ConfdRequest(ConfigObject):
  """Object holding a confd request.

  @ivar protocol: confd protocol version
  @ivar type: confd query type
  @ivar query: query request
  @ivar rsalt: requested reply salt

  """
  __slots__ = [
    "protocol",
    "type",
    "query",
    "rsalt",
    ]


class ConfdReply(ConfigObject):
  """Object holding a confd reply.

  @ivar protocol: confd protocol version
  @ivar status: reply status code (ok, error)
  @ivar answer: confd query reply
  @ivar serial: configuration serial number

  """
  __slots__ = [
    "protocol",
    "status",
    "answer",
    "serial",
    ]


Iustin Pop's avatar
Iustin Pop committed
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
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