objects.py 45.1 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

Iustin Pop's avatar
Iustin Pop committed
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
# 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.

"""

29
# pylint: disable=E0203,W0201,R0902
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
37
# R0902: Allow instances of these objects to have more than 20 attributes

Iustin Pop's avatar
Iustin Pop committed
38
import ConfigParser
39
import re
40
import copy
41
import time
42
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
43
44

from ganeti import errors
45
from ganeti import constants
46
from ganeti import netutils
Iustin Pop's avatar
Iustin Pop committed
47

48
49
from socket import AF_INET

Iustin Pop's avatar
Iustin Pop committed
50
51

__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
52
           "OS", "Node", "NodeGroup", "Cluster", "FillDict"]
Iustin Pop's avatar
Iustin Pop committed
53

54
_TIMESTAMPS = ["ctime", "mtime"]
55
_UUID = ["uuid"]
56

57

58
def FillDict(defaults_dict, custom_dict, skip_keys=None):
Iustin Pop's avatar
Iustin Pop committed
59
  """Basic function to apply settings on top a default dict.
Guido Trotter's avatar
Guido Trotter committed
60

Iustin Pop's avatar
Iustin Pop committed
61
62
63
64
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
65
66
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
67
68
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
69

Iustin Pop's avatar
Iustin Pop committed
70
71
72
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
73
74
75
76
77
78
  if skip_keys:
    for k in skip_keys:
      try:
        del ret_dict[k]
      except KeyError:
        pass
Iustin Pop's avatar
Iustin Pop committed
79
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
80

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

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
99
100
101
102
103
104
105
106
107
108
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
109
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
110
111
112
113
114

  """
  __slots__ = []

  def __init__(self, **kwargs):
115
116
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
117
118

  def __getattr__(self, name):
119
    if name not in self._all_slots():
120
121
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
122
123
124
    return None

  def __setstate__(self, state):
125
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
126
    for name in state:
127
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
128
129
        setattr(self, name, state[name])

130
131
132
133
134
135
136
137
138
139
  @classmethod
  def _all_slots(cls):
    """Compute the list of all declared slots for a class.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "__slots__", []))
    return slots

140
141
142
143
144
145
146
147
148
149
  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.

    """
150
    result = {}
151
    for name in self._all_slots():
152
153
154
155
156
157
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

  @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))
175
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
176
    obj = cls(**val_str) # pylint: disable=W0142
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
    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))
209
210
    if source is None:
      source = c_type()
211
212
213
214
215
216
217
218
219
    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

220
221
222
223
224
225
226
227
  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

228
229
230
231
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

232
233
234
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

235
236
    This method will be called at configuration load time, and its
    implementation will be object dependent.
237
238
239
240

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
241

242
class TaggableObject(ConfigObject):
243
244
245
  """An generic class supporting tags.

  """
Balazs Lecz's avatar
Balazs Lecz committed
246
  __slots__ = ["tags"]
Iustin Pop's avatar
Iustin Pop committed
247
  VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")
Iustin Pop's avatar
Iustin Pop committed
248

Iustin Pop's avatar
Iustin Pop committed
249
250
  @classmethod
  def ValidateTag(cls, tag):
251
252
253
254
255
256
257
    """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):
258
      raise errors.TagError("Invalid tag type (not a string)")
259
    if len(tag) > constants.MAX_TAG_LEN:
260
261
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
262
    if not tag:
263
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
264
    if not cls.VALID_TAG_RE.match(tag):
265
      raise errors.TagError("Tag contains invalid characters")
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

  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:
283
      raise errors.TagError("Too many tags")
284
285
286
287
288
289
290
291
292
293
294
    self.GetTags().add(tag)

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

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

297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
  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

320

321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
class MasterNetworkParameters(ConfigObject):
  """Network configuration parameters for the master

  @ivar name: master name
  @ivar ip: master IP
  @ivar netmask: master netmask
  @ivar netdev: master network device
  @ivar ip_family: master IP family

  """
  __slots__ = [
    "name",
    "ip",
    "netmask",
    "netdev",
    "ip_family"
    ]


Iustin Pop's avatar
Iustin Pop committed
340
341
class ConfigData(ConfigObject):
  """Top-level config object."""
342
343
344
345
346
347
348
349
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
350

351
352
353
354
355
356
357
358
359
  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()
360
    for key in "nodes", "instances", "nodegroups":
361
362
363
364
365
366
367
368
369
370
371
372
373
      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)
374
    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
375
376
    return obj

377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
  def HasAnyDiskOfType(self, dev_type):
    """Check if in there is at disk of the given type in the configuration.

    @type dev_type: L{constants.LDS_BLOCK}
    @param dev_type: the type to look for
    @rtype: boolean
    @return: boolean indicating if a disk of the given type was found or not

    """
    for instance in self.instances.values():
      for disk in instance.disks:
        if disk.IsBasedOnDiskType(dev_type):
          return True
    return False

392
393
394
395
396
397
398
399
400
  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()
401
402
403
404
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
405
406
407
408
409
410
    if self.cluster.drbd_usermode_helper is None:
      # To decide if we set an helper let's check if at least one instance has
      # a DRBD disk. This does not cover all the possible scenarios but it
      # gives a good approximation.
      if self.HasAnyDiskOfType(constants.LD_DRBD8):
        self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER
411

Iustin Pop's avatar
Iustin Pop committed
412
413
414

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

Guido Trotter's avatar
Guido Trotter committed
417
418
419
420
421
422
423
424
425
  @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

    """
426
427
    if (nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES and
        nicparams[constants.NIC_MODE] != constants.VALUE_AUTO):
Guido Trotter's avatar
Guido Trotter committed
428
429
430
      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
      raise errors.ConfigurationError(err)

431
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
432
433
434
435
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

Iustin Pop's avatar
Iustin Pop committed
436
437
438
439

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

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

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

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

454
455
456
457
458
459
460
  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.

461
462
463
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

464
465
466
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
467
468
    elif self.dev_type == constants.LD_BLOCKDEV:
      return self.logical_id[1]
469
470
    return None

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
  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

487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  def IsBasedOnDiskType(self, dev_type):
    """Check if the disk or its children are based on the given type.

    @type dev_type: L{constants.LDS_BLOCK}
    @param dev_type: the type to look for
    @rtype: boolean
    @return: boolean indicating if a device of the given type was found or not

    """
    if self.children:
      for child in self.children:
        if child.IsBasedOnDiskType(dev_type):
          return True
    return self.dev_type == dev_type

Iustin Pop's avatar
Iustin Pop committed
502
503
504
505
506
507
508
509
510
  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.

    """
511
512
    if self.dev_type in [constants.LD_LV, constants.LD_FILE,
                         constants.LD_BLOCKDEV]:
Iustin Pop's avatar
Iustin Pop committed
513
      result = [node]
514
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
515
516
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
517
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
518
    else:
519
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
520
521
522
523
524
525
526
    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
527
528
529
    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
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556

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

Iustin Pop's avatar
Iustin Pop committed
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
  def ComputeGrowth(self, amount):
    """Compute the per-VG growth requirements.

    This only works for VG-based disks.

    @type amount: integer
    @param amount: the desired increase in (user-visible) disk space
    @rtype: dict
    @return: a dictionary of volume-groups and the required size

    """
    if self.dev_type == constants.LD_LV:
      return {self.logical_id[0]: amount}
    elif self.dev_type == constants.LD_DRBD8:
      if self.children:
        return self.children[0].ComputeGrowth(amount)
      else:
        return {}
    else:
      # Other disk types do not require VG space
      return {}

579
580
581
582
583
584
585
586
  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.

    """
587
    if self.dev_type in (constants.LD_LV, constants.LD_FILE):
588
589
590
591
592
593
594
595
596
      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)

597
598
599
600
601
602
603
604
605
  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

606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
  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:
631
      pnode, snode, port, pminor, sminor, secret = self.logical_id
632
633
634
635
636
637
638
639
      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))
640
641
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
642
      if pnode == target_node:
643
        self.physical_id = p_data + s_data + (pminor, secret)
644
      else: # it must be secondary, we tested above
645
        self.physical_id = s_data + p_data + (sminor, secret)
646
647
648
649
    else:
      self.physical_id = self.logical_id
    return

650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
  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)
677
678
679
680
    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))
681
682
    return obj

683
684
685
686
687
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
688
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
689
    elif self.dev_type in constants.LDS_DRBD:
690
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
691
      val = "<DRBD8("
692
693
694
695
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
696
697
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
698

699
700
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
701
702
703
704
705
706
707
708
709
710
711
      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
712
713
714
715
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
716
717
    return val

718
719
720
721
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
722
    all_errors = []
723
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
724
725
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
726

727
728
729
730
731
732
733
734
735
  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
736

737
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
738
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
739
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
740
741
742
    "name",
    "primary_node",
    "os",
743
    "hypervisor",
744
745
    "hvparams",
    "beparams",
746
    "osparams",
747
    "admin_state",
Iustin Pop's avatar
Iustin Pop committed
748
749
750
    "nics",
    "disks",
    "disk_template",
751
    "network_port",
752
    "serial_no",
753
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
754
755
756
757

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

758
759
760
761
762
763
764
765
766
767
768
769
770
    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
771
772
773
774
775
776
    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.

    """
777
778
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
779
      if device.dev_type in constants.LDS_DRBD:
780
781
782
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
783
784
      if device.children:
        for child in device.children:
785
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
786

787
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
788
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
789
    for device in self.disks:
790
791
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
792

793
794
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
795
796
797
798

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

Iustin Pop's avatar
Iustin Pop committed
802
803
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
804

805
806
807
808
    @return: None if lvmap arg is given, otherwise, a dictionary of
        the form { 'nodename' : ['volume1', 'volume2', ...], ... };
        volumeN is of the form "vg_name/lv_name", compatible with
        GetVolumeList()
Iustin Pop's avatar
Iustin Pop committed
809
810
811
812
813
814

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

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
815
816
817
      lvmap = {
        node: [],
        }
Iustin Pop's avatar
Iustin Pop committed
818
819
820
821
822
823
824
825
826
827
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

    for dev in devs:
828
      if dev.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
829
        lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1])
Iustin Pop's avatar
Iustin Pop committed
830

831
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
832
833
834
835
836
837
838
839
840
        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

841
842
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
843

844
    This is just a wrapper that does validation of the index.
845

846
847
848
849
850
    @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
851

852
853
854
855
    """
    try:
      idx = int(idx)
      return self.disks[idx]
856
    except (TypeError, ValueError), err:
857
858
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
859
860
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
861
                                 " 0 to %d" % (idx, len(self.disks) - 1),
862
                                 errors.ECODE_INVAL)
863

864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
  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.

    """
887
888
889
890
891
892
893
    if "admin_state" not in val:
      if val.get("admin_up", False):
        val["admin_state"] = constants.ADMINST_UP
      else:
        val["admin_state"] = constants.ADMINST_DOWN
    if "admin_up" in val:
      del val["admin_up"]
894
895
896
897
898
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

899
900
901
902
903
904
905
906
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
907
908
909
910
911
912
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
913
914
    if self.osparams is None:
      self.osparams = {}
915

Iustin Pop's avatar
Iustin Pop committed
916
917

class OS(ConfigObject):
918
919
920
921
922
923
  """Config object representing an operating system.

  @type supported_parameters: list
  @ivar supported_parameters: a list of tuples, name and description,
      containing the supported parameters by this OS

924
925
926
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

927
  """
Iustin Pop's avatar
Iustin Pop committed
928
929
930
  __slots__ = [
    "name",
    "path",
931
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
932
933
    "create_script",
    "export_script",
934
935
    "import_script",
    "rename_script",
936
    "verify_script",
937
    "supported_variants",
938
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
939
940
    ]

941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
  VARIANT_DELIM = "+"

  @classmethod
  def SplitNameVariant(cls, name):
    """Splits the name into the proper name and variant.

    @param name: the OS (unprocessed) name
    @rtype: list
    @return: a list of two elements; if the original name didn't
        contain a variant, it's returned as an empty string

    """
    nv = name.split(cls.VARIANT_DELIM, 1)
    if len(nv) == 1:
      nv.append("")
    return nv

  @classmethod
  def GetName(cls, name):
    """Returns the proper name of the os (without the variant).

    @param name: the OS (unprocessed) name

    """
    return cls.SplitNameVariant(name)[0]

  @classmethod
  def GetVariant(cls, name):
    """Returns the variant the os (without the base name).

    @param name: the OS (unprocessed) name

    """
    return cls.SplitNameVariant(name)[1]

976

977
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
978
  """Config object representing a node."""
Balazs Lecz's avatar
Balazs Lecz committed
979
  __slots__ = [
980
981
982
    "name",
    "primary_ip",
    "secondary_ip",
983
    "serial_no",
984
    "master_candidate",
985
    "offline",
986
    "drained",
987
    "group",
988
989
    "master_capable",
    "vm_capable",
990
    "ndparams",
991
    "powered",
992
993
    "hv_state",
    "disk_state",
994
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
995

996
997
998
999
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
1000
    # pylint: disable=E0203
1001
1002
1003
1004
1005
1006
1007
    # because these are "defined" via slots, not manually
    if self.master_capable is None:
      self.master_capable = True

    if self.vm_capable is None:
      self.vm_capable = True

1008
1009
1010
    if self.ndparams is None:
      self.ndparams = {}

1011
1012
1013
    if self.powered is None:
      self.powered = True

Iustin Pop's avatar
Iustin Pop committed
1014

1015
class NodeGroup(TaggableObject):
1016
1017
1018
1019
  """Config object representing a node group."""
  __slots__ = [
    "name",
    "members",
1020
    "ndparams",
1021
    "serial_no",
1022
    "alloc_policy",
1023
1024
1025
1026
1027
    ] + _TIMESTAMPS + _UUID

  def ToDict(self):
    """Custom function for nodegroup.

1028
1029
    This discards the members object, which gets recalculated and is only kept
    in memory.
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046

    """
    mydict = super(NodeGroup, self).ToDict()
    del mydict["members"]
    return mydict

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

    The members slot is initialized to an empty list, upon deserialization.

    """
    obj = super(NodeGroup, cls).FromDict(val)
    obj.members = []
    return obj

1047
1048
1049
1050
1051
1052
1053
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.ndparams is None:
      self.ndparams = {}

1054
1055
1056
    if self.serial_no is None:
      self.serial_no = 1

1057
1058
1059
    if self.alloc_policy is None:
      self.alloc_policy = constants.ALLOC_POLICY_PREFERRED

1060
1061
1062
1063
1064
    # We only update mtime, and not ctime, since we would not be able to provide
    # a correct value for creation time.
    if self.mtime is None:
      self.mtime = time.time()

1065
  def FillND(self, node):
1066
    """Return filled out ndparams for L{objects.Node}
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081

    @type node: L{objects.Node}
    @param node: A Node object to fill
    @return a copy of the node's ndparams with defaults filled

    """
    return self.SimpleFillND(node.ndparams)

  def SimpleFillND(self, ndparams):
    """Fill a given ndparams dict with defaults.

    @type ndparams: dict
    @param ndparams: the dict to fill
    @rtype: dict
    @return: a copy of the passed in ndparams with missing keys filled
1082
        from the node group defaults
1083
1084
1085
1086

    """
    return FillDict(self.ndparams, ndparams)

1087

1088
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1089
  """Config object representing the cluster."""
Balazs Lecz's avatar
Balazs Lecz committed
1090
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1091
1092
1093
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
1094
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
1095
1096
    "mac_prefix",
    "volume_group_name",
1097
    "reserved_lvs",
1098
    "drbd_usermode_helper",
Iustin Pop's avatar
Iustin Pop committed
1099
    "default_bridge",
1100
    "default_hypervisor",
1101
1102
1103
    "master_node",
    "master_ip",
    "master_netdev",
1104
    "master_netmask",
1105
    "use_external_mip_script",
1106
1107
    "cluster_name",
    "file_storage_dir",
1108
    "shared_file_storage_dir",
1109
    "enabled_hypervisors",
1110
    "hvparams",
1111
    "os_hvp",
1112
    "beparams",
1113
    "osparams",
1114
    "nicparams",
1115
    "ndparams",
1116
    "candidate_pool_size",
1117
    "modify_etc_hosts",
1118
    "modify_ssh_setup",
1119
    "maintain_node_health",
Balazs Lecz's avatar
Balazs Lecz committed
1120
    "uid_pool",
1121
    "default_iallocator",
1122
1123
    "hidden_os",
    "blacklisted_os",
1124
    "primary_ip_family",
1125
    "prealloc_wipe_disks",
1126
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1127

1128
1129
1130
1131
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
1132
    # pylint: disable=E0203
Iustin Pop's avatar
Iustin Pop committed
1133
    # because these are "defined" via slots, not manually
1134
1135
1136
1137
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
1138
        self.hvparams[hypervisor] = FillDict(
1139
1140
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

1141
1142
1143
    if self.os_hvp is None:
      self.os_hvp = {}

1144
1145
1146
1147
    # osparams added before 2.2
    if self.osparams is None:
      self.osparams = {}

1148
1149
1150
    if self.ndparams is None:
      self.ndparams = constants.NDC_DEFAULTS

1151
1152
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
1153
1154
1155
1156
1157
1158
    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
1159

1160
1161
1162
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

1163
1164
1165
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

Stephen Shirley's avatar
Stephen Shirley committed
1166
    # default_bridge is no longer used in 2.1. The slot is left there to
1167
1168
    # support auto-upgrading. It can be removed once we decide to deprecate
    # upgrading straight from 2.0.
1169
1170
1171
    if self.default_bridge is not None:
      self.default_bridge = None

1172
1173
    # default_hypervisor is just the first enabled one in 2.1. This slot and
    # code can be removed once upgrading straight from 2.0 is deprecated.
1174
    if self.default_hypervisor is not None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1175
      self.enabled_hypervisors = ([self.default_hypervisor] +
1176
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
1177
         if hvname != self.default_hypervisor])
1178
1179
      self.default_hypervisor = None

1180
1181
1182
1183
    # maintain_node_health added after 2.1.1
    if self.maintain_node_health is None:
      self.maintain_node_health = False

Balazs Lecz's avatar
Balazs Lecz committed
1184
1185
1186
    if self.uid_pool is None:
      self.uid_pool = []

1187
1188
1189
    if self.default_iallocator is None:
      self.default_iallocator = ""

1190
1191
1192
1193
    # reserved_lvs added before 2.2
    if self.reserved_lvs is None:
      self.reserved_lvs = []

Iustin Pop's avatar
Iustin Pop committed
1194
    # hidden and blacklisted operating systems added before 2.2.1
1195
1196
    if self.hidden_os is None:
      self.hidden_os = []
Iustin Pop's avatar
Iustin Pop committed
1197

1198
1199
    if self.blacklisted_os is None:
      self.blacklisted_os = []
Iustin Pop's avatar
Iustin Pop committed
1200

1201
1202
1203
1204
    # primary_ip_family added before 2.3
    if self.primary_ip_family is None:
      self.primary_ip_family = AF_INET

1205
1206
1207
1208
    if self.master_netmask is None:
      ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family)
      self.master_netmask = ipcls.iplen

1209
1210
1211
    if self.prealloc_wipe_disks is None:
      self.prealloc_wipe_disks = False

1212
1213
1214
1215
    # shared_file_storage_dir added before 2.5
    if self.shared_file_storage_dir is None:
      self.shared_file_storage_dir = ""

1216
1217
1218
    if self.use_external_mip_script is None:
      self.use_external_mip_script = False

1219
1220
1221
1222
  def ToDict(self):
    """Custom function for cluster.

    """
1223
    mydict = super(Cluster, self).ToDict()
1224
1225
1226
1227
1228
1229
1230
1231
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
1232
    obj = super(Cluster, cls).FromDict(val)
1233
1234
1235
1236
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
  def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
    """Get the default hypervisor parameters for the cluster.

    @param hypervisor: the hypervisor name
    @param os_name: if specified, we'll also update the defaults for this OS
    @param skip_keys: if passed, list of keys not to use
    @return: the defaults dict

    """
    if skip_keys is None:
      skip_keys = []

    fill_stack = [self.hvparams.get(hypervisor, {})]
    if os_name is not None:
      os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
      fill_stack.append(os_hvp)

    ret_dict = {}
    for o_dict in fill_stack:
      ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)

    return ret_dict

1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
  def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
    """Fill a given hvparams dict with cluster defaults.

    @type hv_name: string
    @param hv_name: the hypervisor to use
    @type os_name: string
    @param os_name: the OS to use for overriding the hypervisor defaults
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
    @rtype: dict
    @return: a copy of the given hvparams with missing keys filled from
        the cluster defaults

    """
    if skip_globals:
      skip_keys = constants.HVC_GLOBALS
    else:
      skip_keys = []

    def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
    return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1282

1283
  def FillHV(self, instance, skip_globals=False):
1284
    """Fill an instance's hvparams dict with cluster defaults.
1285

1286
    @type instance: L{objects.Instance}
1287
    @param instance: the instance parameter to fill
1288
1289
1290
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
1291
1292
1293
1294
1295
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
1296
1297
    return self.SimpleFillHV(instance.hypervisor, instance.os,
                             instance.hvparams, skip_globals)
1298

1299
1300
1301
  def SimpleFillBE(self, beparams):
    """Fill a given beparams dict with cluster defaults.

1302
1303
    @type beparams: dict
    @param beparams: the dict to fill
1304
1305
1306
1307
1308
1309
    @rtype: dict
    @return: a copy of the passed in beparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1310
1311

  def FillBE(self, instance):
1312
    """Fill an instance's beparams dict with cluster defaults.
1313