objects.py 29.5 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
#

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

"""

Iustin Pop's avatar
Iustin Pop committed
29
# pylint: disable-msg=E0203,W0201
Iustin Pop's avatar
Iustin Pop committed
30
31
32
33

# E0203: Access to member %r before its definition, since we use
# objects.py which doesn't explicitely initialise its members

Iustin Pop's avatar
Iustin Pop committed
34
# W0201: Attribute '%s' defined outside __init__
Iustin Pop's avatar
Iustin Pop committed
35
36

import ConfigParser
37
import re
38
import copy
39
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
40
41

from ganeti import errors
42
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
43
44
45


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

48
_TIMESTAMPS = ["ctime", "mtime"]
49
_UUID = ["uuid"]
50

51
def FillDict(defaults_dict, custom_dict, skip_keys=[]):
Iustin Pop's avatar
Iustin Pop committed
52
  """Basic function to apply settings on top a default dict.
Guido Trotter's avatar
Guido Trotter committed
53

Iustin Pop's avatar
Iustin Pop committed
54
55
56
57
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
58
59
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
60
61
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
62

Iustin Pop's avatar
Iustin Pop committed
63
64
65
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
66
67
68
69
70
  for k in skip_keys:
    try:
      del ret_dict[k]
    except KeyError:
      pass
Iustin Pop's avatar
Iustin Pop committed
71
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
72

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

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
91
92
93
94
95
96
97
98
99
100
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
101
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
102
103
104
105
106

  """
  __slots__ = []

  def __init__(self, **kwargs):
107
108
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
109
110
111

  def __getattr__(self, name):
    if name not in self.__slots__:
112
113
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
114
115
116
117
118
119
120
    return None

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

121
122
123
124
125
126
127
128
129
130
  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.

    """
131
132
133
134
135
136
137
138
    result = {}
    for name in self.__slots__:
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

  @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))
156
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
Iustin Pop's avatar
Iustin Pop committed
157
    obj = cls(**val_str) # pylint: disable-msg=W0142
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
194
195
196
197
198
    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

199
200
201
202
203
204
205
206
  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

207
208
209
210
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

211
212
213
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

214
215
    This method will be called at configuration load time, and its
    implementation will be object dependent.
216
217
218
219

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
220

221
class TaggableObject(ConfigObject):
222
223
224
  """An generic class supporting tags.

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

Iustin Pop's avatar
Iustin Pop committed
228
229
  @classmethod
  def ValidateTag(cls, tag):
230
231
232
233
234
235
236
    """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):
237
      raise errors.TagError("Invalid tag type (not a string)")
238
    if len(tag) > constants.MAX_TAG_LEN:
239
240
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
241
    if not tag:
242
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
243
    if not cls.VALID_TAG_RE.match(tag):
244
      raise errors.TagError("Tag contains invalid characters")
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

  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:
262
      raise errors.TagError("Too many tags")
263
264
265
266
267
268
269
270
271
272
273
    self.GetTags().add(tag)

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

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

276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
  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

299

Iustin Pop's avatar
Iustin Pop committed
300
301
class ConfigData(ConfigObject):
  """Top-level config object."""
Michael Hanselmann's avatar
Michael Hanselmann committed
302
303
  __slots__ = (["version", "cluster", "nodes", "instances", "serial_no"] +
               _TIMESTAMPS)
Iustin Pop's avatar
Iustin Pop committed
304

305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
  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

330
331
332
333
334
335
336
337
338
339
  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
340
341
342

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

Guido Trotter's avatar
Guido Trotter committed
345
346
347
348
349
350
351
352
353
354
355
356
357
  @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)

358
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
359
360
361
362
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

363
364
365
366
367
368
369
370
371
  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
372
373
374
375
    # 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
376

Iustin Pop's avatar
Iustin Pop committed
377
378
379
380

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

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

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

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

395
396
397
398
399
400
401
402
403
404
405
406
  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

407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
  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
423
424
425
426
427
428
429
430
431
  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.

    """
432
    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
433
      result = [node]
434
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
435
436
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
437
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
438
    else:
439
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
440
441
442
443
444
445
446
    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
447
448
449
    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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476

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

477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
  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)

495
496
497
498
499
500
501
502
503
  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

504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  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:
529
      pnode, snode, port, pminor, sminor, secret = self.logical_id
530
531
532
533
534
535
536
537
      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))
538
539
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
540
      if pnode == target_node:
541
        self.physical_id = p_data + s_data + (pminor, secret)
542
      else: # it must be secondary, we tested above
543
        self.physical_id = s_data + p_data + (sminor, secret)
544
545
546
547
    else:
      self.physical_id = self.logical_id
    return

548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
  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)
575
576
577
578
    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))
579
580
    return obj

581
582
583
584
585
586
587
  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:
588
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
589
      val = "<DRBD8("
590
591
592
593
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
594
595
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
596

597
598
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
599
600
601
602
603
604
605
606
607
608
609
      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
610
611
612
613
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
614
615
    return val

616
617
618
619
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
620
    all_errors = []
621
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
622
623
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
624

625
626
627
628
629
630
631
632
633
  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
634

635
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
636
  """Config object representing an instance."""
637
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
638
639
640
    "name",
    "primary_node",
    "os",
641
    "hypervisor",
642
643
    "hvparams",
    "beparams",
644
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
645
646
647
    "nics",
    "disks",
    "disk_template",
648
    "network_port",
649
    "serial_no",
650
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
651
652
653
654

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

655
656
657
658
659
660
661
662
663
664
665
666
667
    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
668
669
670
671
672
673
    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.

    """
674
675
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
676
      if device.dev_type in constants.LDS_DRBD:
677
678
679
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
680
681
      if device.children:
        for child in device.children:
682
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
683

684
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
685
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
686
    for device in self.disks:
687
688
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
689

690
691
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
692
693
694
695

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

Iustin Pop's avatar
Iustin Pop committed
699
700
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
701

Iustin Pop's avatar
Iustin Pop committed
702
703
    @return: None if lvmap arg is given, otherwise, a dictionary
        of the form { 'nodename' : ['volume1', 'volume2', ...], ... }
Iustin Pop's avatar
Iustin Pop committed
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720

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

724
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
725
726
727
728
729
730
731
732
733
        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

734
735
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
736

737
    This is just a wrapper that does validation of the index.
738

739
740
741
742
743
    @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
744

745
746
747
748
749
    """
    try:
      idx = int(idx)
      return self.disks[idx]
    except ValueError, err:
750
751
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
752
753
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
754
755
                                 " 0 to %d" % (idx, len(self.disks)),
                                 errors.ECODE_INVAL)
756

757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
  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

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

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
793
794
795
796
797
798
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
799

Iustin Pop's avatar
Iustin Pop committed
800
801
802
803
804
805

class OS(ConfigObject):
  """Config object representing an operating system."""
  __slots__ = [
    "name",
    "path",
806
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
807
808
    "create_script",
    "export_script",
809
810
    "import_script",
    "rename_script",
811
    "supported_variants",
Iustin Pop's avatar
Iustin Pop committed
812
813
    ]

814

815
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
816
  """Config object representing a node."""
817
818
819
820
  __slots__ = TaggableObject.__slots__ + [
    "name",
    "primary_ip",
    "secondary_ip",
821
    "serial_no",
822
    "master_candidate",
823
    "offline",
824
    "drained",
825
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
826
827


828
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
829
  """Config object representing the cluster."""
830
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
831
832
833
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
834
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
835
836
837
    "mac_prefix",
    "volume_group_name",
    "default_bridge",
838
    "default_hypervisor",
839
840
841
842
843
    "master_node",
    "master_ip",
    "master_netdev",
    "cluster_name",
    "file_storage_dir",
844
    "enabled_hypervisors",
845
846
    "hvparams",
    "beparams",
847
    "nicparams",
848
    "candidate_pool_size",
849
    "modify_etc_hosts",
850
    "modify_ssh_setup",
851
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
852

853
854
855
856
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
Iustin Pop's avatar
Iustin Pop committed
857
858
    # pylint: disable-msg=E0203
    # because these are "defined" via slots, not manually
859
860
861
862
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
863
        self.hvparams[hypervisor] = FillDict(
864
865
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

866
867
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
868
869
870
871
872
873
    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
874

875
876
877
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

878
879
880
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

881
882
883
884
885
    # 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

886
887
    # 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
888
      self.enabled_hypervisors = ([self.default_hypervisor] +
889
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
890
         if hvname != self.default_hypervisor])
891
892
      self.default_hypervisor = None

893
894
895
896
  def ToDict(self):
    """Custom function for cluster.

    """
897
    mydict = super(Cluster, self).ToDict()
898
899
900
901
902
903
904
905
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
906
    obj = super(Cluster, cls).FromDict(val)
907
908
909
910
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

911
  def FillHV(self, instance, skip_globals=False):
912
913
    """Fill an instance's hvparams dict.

914
    @type instance: L{objects.Instance}
915
    @param instance: the instance parameter to fill
916
917
918
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
919
920
921
922
923
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
924
925
926
927
    if skip_globals:
      skip_keys = constants.HVC_GLOBALS
    else:
      skip_keys = []
Guido Trotter's avatar
Guido Trotter committed
928
    return FillDict(self.hvparams.get(instance.hypervisor, {}),
929
                    instance.hvparams, skip_keys=skip_keys)
930
931
932
933

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

934
    @type instance: L{objects.Instance}
935
936
937
938
939
940
    @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

    """
941
    return FillDict(self.beparams.get(constants.PP_DEFAULT, {}),
942
                    instance.beparams)
943

944

945
946
947
948
949
950
951
952
953
class BlockDevStatus(ConfigObject):
  """Config object representing the status of a block device."""
  __slots__ = [
    "dev_path",
    "major",
    "minor",
    "sync_percent",
    "estimated_time",
    "is_degraded",
954
    "ldisk_status",
955
956
957
    ]


Guido Trotter's avatar
Guido Trotter committed
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
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
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
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