objects.py 45.6 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


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def UpgradeBeParams(target):
  """Update the be parameters dict to the new format.

  @type target: dict
  @param target: "be" parameters dict

  """
  if constants.BE_MEMORY in target:
    memory = target[constants.BE_MEMORY]
    target[constants.BE_MAXMEM] = memory
    target[constants.BE_MINMEM] = memory
    #FIXME(dynmem): delete old value
    #del target[constants.BE_MEMORY]


Iustin Pop's avatar
Iustin Pop committed
114
115
116
117
118
119
120
121
122
123
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
124
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
125
126
127
128
129

  """
  __slots__ = []

  def __init__(self, **kwargs):
130
131
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
132
133

  def __getattr__(self, name):
134
    if name not in self._all_slots():
135
136
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
137
138
139
    return None

  def __setstate__(self, state):
140
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
141
    for name in state:
142
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
143
144
        setattr(self, name, state[name])

145
146
147
148
149
150
151
152
153
154
  @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

155
156
157
158
159
160
161
162
163
164
  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.

    """
165
    result = {}
166
    for name in self._all_slots():
167
168
169
170
171
172
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

  @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))
190
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
191
    obj = cls(**val_str) # pylint: disable=W0142
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    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))
224
225
    if source is None:
      source = c_type()
226
227
228
229
230
231
232
233
234
    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

235
236
237
238
239
240
241
242
  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

243
244
245
246
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

247
248
249
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

250
251
    This method will be called at configuration load time, and its
    implementation will be object dependent.
252
253
254
255

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
256

257
class TaggableObject(ConfigObject):
258
259
260
  """An generic class supporting tags.

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

Iustin Pop's avatar
Iustin Pop committed
264
265
  @classmethod
  def ValidateTag(cls, tag):
266
267
268
269
270
271
272
    """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):
273
      raise errors.TagError("Invalid tag type (not a string)")
274
    if len(tag) > constants.MAX_TAG_LEN:
275
276
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
277
    if not tag:
278
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
279
    if not cls.VALID_TAG_RE.match(tag):
280
      raise errors.TagError("Tag contains invalid characters")
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

  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:
298
      raise errors.TagError("Too many tags")
299
300
301
302
303
304
305
306
307
308
309
    self.GetTags().add(tag)

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

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

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
  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

335

336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
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
355
356
class ConfigData(ConfigObject):
  """Top-level config object."""
357
358
359
360
361
362
363
364
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
365

366
367
368
369
370
371
372
373
374
  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()
375
    for key in "nodes", "instances", "nodegroups":
376
377
378
379
380
381
382
383
384
385
386
387
388
      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)
389
    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
390
391
    return obj

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

407
408
409
410
411
412
413
414
415
  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()
416
417
418
419
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
420
421
422
423
424
425
    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
426

Iustin Pop's avatar
Iustin Pop committed
427
428
429

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

Guido Trotter's avatar
Guido Trotter committed
432
433
434
435
436
437
438
439
440
  @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

    """
441
442
    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
443
444
445
      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
      raise errors.ConfigurationError(err)

446
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
447
448
449
450
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

Iustin Pop's avatar
Iustin Pop committed
451
452
453
454

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

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

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

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

469
470
471
472
473
474
475
  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.

476
477
478
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

479
480
481
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
482
483
    elif self.dev_type == constants.LD_BLOCKDEV:
      return self.logical_id[1]
484
485
    return None

486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  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

502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
  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
517
518
519
520
521
522
523
524
525
  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.

    """
526
527
    if self.dev_type in [constants.LD_LV, constants.LD_FILE,
                         constants.LD_BLOCKDEV]:
Iustin Pop's avatar
Iustin Pop committed
528
      result = [node]
529
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
530
531
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
532
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
533
    else:
534
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
535
536
537
538
539
540
541
    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
542
543
544
    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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571

    """
    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
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
  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 {}

594
595
596
597
598
599
600
601
  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.

    """
602
    if self.dev_type in (constants.LD_LV, constants.LD_FILE):
603
604
605
606
607
608
609
610
611
      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)

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

621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
  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:
646
      pnode, snode, port, pminor, sminor, secret = self.logical_id
647
648
649
650
651
652
653
654
      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))
655
656
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
657
      if pnode == target_node:
658
        self.physical_id = p_data + s_data + (pminor, secret)
659
      else: # it must be secondary, we tested above
660
        self.physical_id = s_data + p_data + (sminor, secret)
661
662
663
664
    else:
      self.physical_id = self.logical_id
    return

665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
  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)
692
693
694
695
    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))
696
697
    return obj

698
699
700
701
702
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
703
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
704
    elif self.dev_type in constants.LDS_DRBD:
705
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
706
      val = "<DRBD8("
707
708
709
710
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
711
712
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
713

714
715
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
716
717
718
719
720
721
722
723
724
725
726
      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
727
728
729
730
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
731
732
    return val

733
734
735
736
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
737
    all_errors = []
738
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
739
740
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
741

742
743
744
745
746
747
748
749
750
  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
751

752
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
753
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
754
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
755
756
757
    "name",
    "primary_node",
    "os",
758
    "hypervisor",
759
760
    "hvparams",
    "beparams",
761
    "osparams",
762
    "admin_state",
Iustin Pop's avatar
Iustin Pop committed
763
764
765
    "nics",
    "disks",
    "disk_template",
766
    "network_port",
767
    "serial_no",
768
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
769
770
771
772

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

773
774
775
776
777
778
779
780
781
782
783
784
785
    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
786
787
788
789
790
791
    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.

    """
792
793
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
794
      if device.dev_type in constants.LDS_DRBD:
795
796
797
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
798
799
      if device.children:
        for child in device.children:
800
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
801

802
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
803
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
804
    for device in self.disks:
805
806
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
807

808
809
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
810
811
812
813

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

Iustin Pop's avatar
Iustin Pop committed
817
818
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
819

820
821
822
823
    @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
824
825
826
827
828
829

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

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
830
831
832
      lvmap = {
        node: [],
        }
Iustin Pop's avatar
Iustin Pop committed
833
834
835
836
837
838
839
840
841
842
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

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

846
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
847
848
849
850
851
852
853
854
855
        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

856
857
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
858

859
    This is just a wrapper that does validation of the index.
860

861
862
863
864
865
    @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
866

867
868
869
870
    """
    try:
      idx = int(idx)
      return self.disks[idx]
871
    except (TypeError, ValueError), err:
872
873
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
874
875
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
876
                                 " 0 to %d" % (idx, len(self.disks) - 1),
877
                                 errors.ECODE_INVAL)
878

879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
  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.

    """
902
903
904
905
906
907
908
    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"]
909
910
911
912
913
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

914
915
916
917
918
919
920
921
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
922
923
924
925
926
927
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
928
929
    if self.osparams is None:
      self.osparams = {}
930
    UpgradeBeParams(self.beparams)
931

Iustin Pop's avatar
Iustin Pop committed
932
933

class OS(ConfigObject):
934
935
936
937
938
939
  """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

940
941
942
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

943
  """
Iustin Pop's avatar
Iustin Pop committed
944
945
946
  __slots__ = [
    "name",
    "path",
947
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
948
949
    "create_script",
    "export_script",
950
951
    "import_script",
    "rename_script",
952
    "verify_script",
953
    "supported_variants",
954
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
955
956
    ]

957
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
  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]

992

993
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
994
  """Config object representing a node."""
Balazs Lecz's avatar
Balazs Lecz committed
995
  __slots__ = [
996
997
998
    "name",
    "primary_ip",
    "secondary_ip",
999
    "serial_no",
1000
    "master_candidate",
1001
    "offline",
1002
    "drained",
1003
    "group",
1004
1005
    "master_capable",
    "vm_capable",
1006
    "ndparams",
1007
    "powered",
1008
1009
    "hv_state",
    "disk_state",
1010
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1011

1012
1013
1014
1015
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
1016
    # pylint: disable=E0203
1017
1018
1019
1020
1021
1022
1023
    # 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

1024
1025
1026
    if self.ndparams is None:
      self.ndparams = {}

1027
1028
1029
    if self.powered is None:
      self.powered = True

Iustin Pop's avatar
Iustin Pop committed
1030

1031
class NodeGroup(TaggableObject):
1032
1033
1034
1035
  """Config object representing a node group."""
  __slots__ = [
    "name",
    "members",
1036
    "ndparams",
1037
    "serial_no",
1038
    "alloc_policy",
1039
1040
1041
1042
1043
    ] + _TIMESTAMPS + _UUID

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

1044
1045
    This discards the members object, which gets recalculated and is only kept
    in memory.
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062

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

1063
1064
1065
1066
1067
1068
1069
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

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

1070
1071
1072
    if self.serial_no is None:
      self.serial_no = 1

1073
1074
1075
    if self.alloc_policy is None:
      self.alloc_policy = constants.ALLOC_POLICY_PREFERRED

1076
1077
1078
1079
1080
    # 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()

1081
  def FillND(self, node):
1082
    """Return filled out ndparams for L{objects.Node}
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097

    @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
1098
        from the node group defaults
1099
1100
1101
1102

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

1103

1104
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1105
  """Config object representing the cluster."""
Balazs Lecz's avatar
Balazs Lecz committed
1106
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1107
1108
1109
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
1110
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
1111
1112
    "mac_prefix",
    "volume_group_name",
1113
    "reserved_lvs",
1114
    "drbd_usermode_helper",
Iustin Pop's avatar
Iustin Pop committed
1115
    "default_bridge",
1116
    "default_hypervisor",
1117
1118
1119
    "master_node",
    "master_ip",
    "master_netdev",
1120
    "master_netmask",
1121
    "use_external_mip_script",
1122
1123
    "cluster_name",
    "file_storage_dir",
1124
    "shared_file_storage_dir",
1125
    "enabled_hypervisors",
1126
    "hvparams",
1127
    "os_hvp",
1128
    "beparams",
1129
    "osparams",
1130
    "nicparams",
1131
    "ndparams",
1132
    "candidate_pool_size",
1133
    "modify_etc_hosts",
1134
    "modify_ssh_setup",
1135
    "maintain_node_health",
Balazs Lecz's avatar
Balazs Lecz committed
1136
    "uid_pool",
1137
    "default_iallocator",
1138
1139
    "hidden_os",
    "blacklisted_os",
1140
    "primary_ip_family",
1141
    "prealloc_wipe_disks",
1142
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1143

1144
1145
1146
1147
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
1148
    # pylint: disable=E0203
Iustin Pop's avatar
Iustin Pop committed
1149
    # because these are "defined" via slots, not manually
1150
1151
1152
1153
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
1154
        self.hvparams[hypervisor] = FillDict(
1155
1156
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

1157
1158
1159
    if self.os_hvp is None:
      self.os_hvp = {}

1160
1161
1162
1163
    # osparams added before 2.2
    if self.osparams is None:
      self.osparams = {}

1164
1165
1166
    if self.ndparams is None:
      self.ndparams = constants.NDC_DEFAULTS

1167
1168
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
1169
1170
1171
    for beparams_group in self.beparams:
      UpgradeBeParams(self.beparams[beparams_group])

1172
1173
1174
1175
1176
1177
    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
1178

1179
1180
1181
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

1182
1183
1184
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

Stephen Shirley's avatar
Stephen Shirley committed
1185
    # default_bridge is no longer used in 2.1. The slot is left there to
1186
1187
    # support auto-upgrading. It can be removed once we decide to deprecate
    # upgrading straight from 2.0.
1188
1189
1190
    if self.default_bridge is not None:
      self.default_bridge = None

1191
1192
    # 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.
1193
    if self.default_hypervisor is not None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1194
      self.enabled_hypervisors = ([self.default_hypervisor] +
1195
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
1196
         if hvname != self.default_hypervisor])
1197
1198
      self.default_hypervisor = None

1199
1200
1201
1202
    # 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
1203
1204
1205
    if self.uid_pool is None:
      self.uid_pool = []

1206
1207
1208
    if self.default_iallocator is None:
      self.default_iallocator = ""

1209
1210
1211
1212
    # reserved_lvs added before 2.2
    if self.reserved_lvs is None:
      self.reserved_lvs = []

Iustin Pop's avatar
Iustin Pop committed
1213
    # hidden and blacklisted operating systems added before 2.2.1
1214
1215
    if self.hidden_os is None:
      self.hidden_os = []
Iustin Pop's avatar
Iustin Pop committed
1216

1217
1218
    if self.blacklisted_os is None:
      self.blacklisted_os = []
Iustin Pop's avatar
Iustin Pop committed
1219

1220
1221
1222
1223
    # primary_ip_family added before 2.3
    if self.primary_ip_family is None:
      self.primary_ip_family = AF_INET

1224
1225
1226
1227
    if self.master_netmask is None:
      ipcls = netutils.IPAddress.GetClassFromIpFamily(self.primary_ip_family)
      self.master_netmask = ipcls.iplen

1228
1229
1230
    if self.prealloc_wipe_disks is None:
      self.prealloc_wipe_disks = False

1231
1232
1233
1234
    # shared_file_storage_dir added before 2.5
    if self.shared_file_storage_dir is None:
      self.shared_file_storage_dir = ""

1235
1236
1237
    if self.use_external_mip_script is None:
      self.use_external_mip_script = False

1238
1239
1240
1241
  def ToDict(self):
    """Custom function for cluster.

    """
1242
    mydict = super(Cluster, self).ToDict()
1243
1244
1245
1246
1247
1248
1249
1250
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
1251
    obj = super(Cluster, cls).FromDict(val)
1252
1253
1254
1255
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
  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

1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
  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)
1301

1302
  def FillHV(self, instance, skip_globals=False):
1303
    """Fill an instance's hvparams dict with cluster defaults.
1304

1305
    @type instance: L{objects.Instance}
1306
    @param instance: the instance parameter to fill
1307
1308
1309
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
1310
1311
1312
1313
1314
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
1315
1316
    return self.SimpleFillHV(instance.hypervisor, instance.os,
                             instance.hvparams, skip_globals)
1317

1318
1319
1320
  def SimpleFillBE(self, beparams):
    """Fill a given beparams dict with cluster defaults.

1321
1322
    @type beparams: dict
    @param beparams: the dict to fill
1323
1324
1325
1326
1327
1328
    @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)
1329
1330

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

1333
    @type instance: L{objects.Instance}
1334
1335
1336
1337
1338
1339
    @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

    """
1340
1341
1342
1343
1344
    return self.SimpleFillBE(instance.beparams)

  def SimpleFillNIC(self, nicparams):
    """Fill a given nicparams dict with cluster defaults.

1345
1346
    @type nicparams: dict
    @param nicparams: the dict to fill
1347
1348
1349
1350
1351
1352
    @rtype: dict
    @return: a copy of the passed in nicparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1353