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

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 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.

"""

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

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

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

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

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


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

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

51

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

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

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

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

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

  """
  __slots__ = []

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

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

  def __setstate__(self, state):
119
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
120
    for name in state:
121
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
122
123
        setattr(self, name, state[name])

124
125
126
127
128
129
130
131
132
133
  @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

134
135
136
137
138
139
140
141
142
143
  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.

    """
144
    result = {}
145
    for name in self._all_slots():
146
147
148
149
150
151
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

  @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))
169
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
Iustin Pop's avatar
Iustin Pop committed
170
    obj = cls(**val_str) # pylint: disable-msg=W0142
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
    return obj

  @staticmethod
  def _ContainerToDicts(container):
    """Convert the elements of a container to standard python types.

    This method converts a container with elements derived from
    ConfigData to standard python types. If the container is a dict,
    we don't touch the keys, only the values.

    """
    if isinstance(container, dict):
      ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])
    elif isinstance(container, (list, tuple, set, frozenset)):
      ret = [elem.ToDict() for elem in container]
    else:
      raise TypeError("Invalid type %s passed to _ContainerToDicts" %
                      type(container))
    return ret

  @staticmethod
  def _ContainerFromDicts(source, c_type, e_type):
    """Convert a container from standard python types.

    This method converts a container with standard python types to
    ConfigData objects. If the container is a dict, we don't touch the
    keys, only the values.

    """
    if not isinstance(c_type, type):
      raise TypeError("Container type %s passed to _ContainerFromDicts is"
                      " not a type" % type(c_type))
    if c_type is dict:
      ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])
    elif c_type in (list, tuple, set, frozenset):
      ret = c_type([e_type.FromDict(elem) for elem in source])
    else:
      raise TypeError("Invalid container type %s passed to"
                      " _ContainerFromDicts" % c_type)
    return ret

212
213
214
215
216
217
218
219
  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

220
221
222
223
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

224
225
226
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

227
228
    This method will be called at configuration load time, and its
    implementation will be object dependent.
229
230
231
232

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
233

234
class TaggableObject(ConfigObject):
235
236
237
  """An generic class supporting tags.

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

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

  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:
275
      raise errors.TagError("Too many tags")
276
277
278
279
280
281
282
283
284
285
286
    self.GetTags().add(tag)

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

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

289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
  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

312

Iustin Pop's avatar
Iustin Pop committed
313
314
class ConfigData(ConfigObject):
  """Top-level config object."""
Michael Hanselmann's avatar
Michael Hanselmann committed
315
316
  __slots__ = (["version", "cluster", "nodes", "instances", "serial_no"] +
               _TIMESTAMPS)
Iustin Pop's avatar
Iustin Pop committed
317

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  def ToDict(self):
    """Custom function for top-level config data.

    This just replaces the list of instances, nodes and the cluster
    with standard python types.

    """
    mydict = super(ConfigData, self).ToDict()
    mydict["cluster"] = mydict["cluster"].ToDict()
    for key in "nodes", "instances":
      mydict[key] = self._ContainerToDicts(mydict[key])

    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for top-level config data

    """
    obj = super(ConfigData, cls).FromDict(val)
    obj.cluster = Cluster.FromDict(obj.cluster)
    obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)
    obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)
    return obj

343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
  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

358
359
360
361
362
363
364
365
366
  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()
367
368
369
370
371
372
    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
373

Iustin Pop's avatar
Iustin Pop committed
374
375
376

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

Guido Trotter's avatar
Guido Trotter committed
379
380
381
382
383
384
385
386
387
388
389
390
391
  @classmethod
  def CheckParameterSyntax(cls, nicparams):
    """Check the given parameters for validity.

    @type nicparams:  dict
    @param nicparams: dictionary with parameter names/value
    @raise errors.ConfigurationError: when a parameter is not valid

    """
    if nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES:
      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
      raise errors.ConfigurationError(err)

392
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
393
394
395
396
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

397
398
399
400
401
402
403
404
405
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.nicparams is None:
      self.nicparams = {}
      if self.bridge is not None:
        self.nicparams[constants.NIC_MODE] = constants.NIC_MODE_BRIDGED
        self.nicparams[constants.NIC_LINK] = self.bridge
406
    # bridge is no longer used it 2.1. The slot is left there to support
407
408
    # upgrading, but can be removed once upgrades to the current version
    # straight from 2.0 are deprecated.
409
410
    if self.bridge is not None:
      self.bridge = None
411

Iustin Pop's avatar
Iustin Pop committed
412
413
414
415

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

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

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

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

430
431
432
433
434
435
436
  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.

437
438
439
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

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

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
  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

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
  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
476
477
478
479
480
481
482
483
484
  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.

    """
485
    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
486
      result = [node]
487
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
488
489
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
490
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
491
    else:
492
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
493
494
495
496
497
498
499
    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
500
501
502
    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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529

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

530
531
532
533
534
535
536
537
  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.

    """
Guido Trotter's avatar
Guido Trotter committed
538
    if self.dev_type == constants.LD_LV or self.dev_type == constants.LD_FILE:
539
540
541
542
543
544
545
546
547
      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)

548
549
550
551
552
553
554
555
556
  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

557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
  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:
582
      pnode, snode, port, pminor, sminor, secret = self.logical_id
583
584
585
586
587
588
589
590
      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))
591
592
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
593
      if pnode == target_node:
594
        self.physical_id = p_data + s_data + (pminor, secret)
595
      else: # it must be secondary, we tested above
596
        self.physical_id = s_data + p_data + (sminor, secret)
597
598
599
600
    else:
      self.physical_id = self.logical_id
    return

601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
  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)
628
629
630
631
    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))
632
633
    return obj

634
635
636
637
638
639
640
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
      val =  "<LogicalVolume(/dev/%s/%s" % self.logical_id
    elif self.dev_type in constants.LDS_DRBD:
641
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
642
      val = "<DRBD8("
643
644
645
646
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
647
648
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
649

650
651
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
652
653
654
655
656
657
658
659
660
661
662
      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
663
664
665
666
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
667
668
    return val

669
670
671
672
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
673
    all_errors = []
674
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
675
676
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
677

678
679
680
681
682
683
684
685
686
  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
687

688
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
689
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
690
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
691
692
693
    "name",
    "primary_node",
    "os",
694
    "hypervisor",
695
696
    "hvparams",
    "beparams",
697
    "osparams",
698
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
699
700
701
    "nics",
    "disks",
    "disk_template",
702
    "network_port",
703
    "serial_no",
704
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
705
706
707
708

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

709
710
711
712
713
714
715
716
717
718
719
720
721
    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
722
723
724
725
726
727
    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.

    """
728
729
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
730
      if device.dev_type in constants.LDS_DRBD:
731
732
733
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
734
735
      if device.children:
        for child in device.children:
736
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
737

738
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
739
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
740
    for device in self.disks:
741
742
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
743

744
745
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
746
747
748
749

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

Iustin Pop's avatar
Iustin Pop committed
753
754
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
755

Iustin Pop's avatar
Iustin Pop committed
756
757
    @return: None if lvmap arg is given, otherwise, a dictionary
        of the form { 'nodename' : ['volume1', 'volume2', ...], ... }
Iustin Pop's avatar
Iustin Pop committed
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774

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

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

    if not devs:
      devs = self.disks

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

778
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
779
780
781
782
783
784
785
786
787
        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

788
789
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
790

791
    This is just a wrapper that does validation of the index.
792

793
794
795
796
797
    @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
798

799
800
801
802
    """
    try:
      idx = int(idx)
      return self.disks[idx]
803
    except (TypeError, ValueError), err:
804
805
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
806
807
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
808
809
                                 " 0 to %d" % (idx, len(self.disks)),
                                 errors.ECODE_INVAL)
810

811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
  def ToDict(self):
    """Instance-specific conversion to standard python types.

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

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

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

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

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

839
840
841
842
843
844
845
846
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
847
848
849
850
851
852
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
853
854
    if self.osparams is None:
      self.osparams = {}
855

Iustin Pop's avatar
Iustin Pop committed
856
857

class OS(ConfigObject):
858
859
860
861
862
863
  """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

864
865
866
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

867
  """
Iustin Pop's avatar
Iustin Pop committed
868
869
870
  __slots__ = [
    "name",
    "path",
871
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
872
873
    "create_script",
    "export_script",
874
875
    "import_script",
    "rename_script",
876
    "verify_script",
877
    "supported_variants",
878
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
879
880
    ]

881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
  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]

916

917
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
918
  """Config object representing a node."""
Balazs Lecz's avatar
Balazs Lecz committed
919
  __slots__ = [
920
921
922
    "name",
    "primary_ip",
    "secondary_ip",
923
    "serial_no",
924
    "master_candidate",
925
    "offline",
926
    "drained",
927
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
928
929


930
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
931
  """Config object representing the cluster."""
Balazs Lecz's avatar
Balazs Lecz committed
932
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
933
934
935
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
936
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
937
938
    "mac_prefix",
    "volume_group_name",
939
    "reserved_lvs",
940
    "drbd_usermode_helper",
Iustin Pop's avatar
Iustin Pop committed
941
    "default_bridge",
942
    "default_hypervisor",
943
944
945
946
947
    "master_node",
    "master_ip",
    "master_netdev",
    "cluster_name",
    "file_storage_dir",
948
    "enabled_hypervisors",
949
    "hvparams",
950
    "os_hvp",
951
    "beparams",
952
    "osparams",
953
    "nicparams",
954
    "candidate_pool_size",
955
    "modify_etc_hosts",
956
    "modify_ssh_setup",
957
    "maintain_node_health",
Balazs Lecz's avatar
Balazs Lecz committed
958
    "uid_pool",
959
    "default_iallocator",
Iustin Pop's avatar
Iustin Pop committed
960
961
    "hidden_oss",
    "blacklisted_oss",
962
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
963

964
965
966
967
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
Iustin Pop's avatar
Iustin Pop committed
968
969
    # pylint: disable-msg=E0203
    # because these are "defined" via slots, not manually
970
971
972
973
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
974
        self.hvparams[hypervisor] = FillDict(
975
976
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

977
978
979
    if self.os_hvp is None:
      self.os_hvp = {}

980
981
982
983
    # osparams added before 2.2
    if self.osparams is None:
      self.osparams = {}

984
985
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
986
987
988
989
990
991
    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
992

993
994
995
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

996
997
998
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

999
    # default_bridge is no longer used it 2.1. The slot is left there to
1000
1001
    # support auto-upgrading. It can be removed once we decide to deprecate
    # upgrading straight from 2.0.
1002
1003
1004
    if self.default_bridge is not None:
      self.default_bridge = None

1005
1006
    # 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.
1007
    if self.default_hypervisor is not None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1008
      self.enabled_hypervisors = ([self.default_hypervisor] +
1009
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
1010
         if hvname != self.default_hypervisor])
1011
1012
      self.default_hypervisor = None

1013
1014
1015
1016
    # 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
1017
1018
1019
    if self.uid_pool is None:
      self.uid_pool = []

1020
1021
1022
    if self.default_iallocator is None:
      self.default_iallocator = ""

1023
1024
1025
1026
    # reserved_lvs added before 2.2
    if self.reserved_lvs is None:
      self.reserved_lvs = []

Iustin Pop's avatar
Iustin Pop committed
1027
1028
1029
1030
1031
1032
1033
    # hidden and blacklisted operating systems added before 2.2.1
    if self.hidden_oss is None:
      self.hidden_oss = []

    if self.blacklisted_oss is None:
      self.blacklisted_oss = []

1034
1035
1036
1037
  def ToDict(self):
    """Custom function for cluster.

    """
1038
    mydict = super(Cluster, self).ToDict()
1039
1040
1041
1042
1043
1044
1045
1046
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
1047
    obj = super(Cluster, cls).FromDict(val)
1048
1049
1050
1051
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
  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

1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
  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)
1097

1098
  def FillHV(self, instance, skip_globals=False):
1099
    """Fill an instance's hvparams dict with cluster defaults.
1100

1101
    @type instance: L{objects.Instance}
1102
    @param instance: the instance parameter to fill
1103
1104
1105
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
1106
1107
1108
1109
1110
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
1111
1112
    return self.SimpleFillHV(instance.hypervisor, instance.os,
                             instance.hvparams, skip_globals)
1113

1114
1115
1116
  def SimpleFillBE(self, beparams):
    """Fill a given beparams dict with cluster defaults.

1117
1118
    @type beparams: dict
    @param beparams: the dict to fill
1119
1120
1121
1122
1123
1124
    @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)
1125
1126

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

1129
    @type instance: L{objects.Instance}
1130
1131
1132
1133
1134
1135
    @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

    """
1136
1137
1138
1139
1140
    return self.SimpleFillBE(instance.beparams)

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

1141
1142
    @type nicparams: dict
    @param nicparams: the dict to fill
1143
1144
1145
1146
1147
1148
    @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)
1149

1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
  def SimpleFillOS(self, os_name, os_params):
    """Fill an instance's osparams dict with cluster defaults.

    @type os_name: string
    @param os_name: the OS name to use
    @type os_params: dict
    @param os_params: the dict to fill with default values
    @rtype: dict
    @return: a copy of the instance's osparams with missing keys filled from
        the cluster defaults

    """
    name_only = os_name.split("+", 1)[0]
    # base OS
    result = self.osparams.get(name_only, {})
    # OS with variant
    result = FillDict(result, self.osparams.get(os_name, {}))
    # specified params
    return FillDict(result, os_params)

1170

1171
1172
1173
1174
1175
1176
1177
1178
1179
class BlockDevStatus(ConfigObject):
  """Config object representing the status of a block device."""
  __slots__ = [
    "dev_path",
    "major",
    "minor",
    "sync_percent",
    "estimated_time",
    "is_degraded",
1180
    "ldisk_status",
1181
1182
1183
    ]


1184
1185
1186
1187
1188
1189
class ImportExportStatus(ConfigObject):
  """Config object representing the status of an import or export."""
  __slots__ = [
    "recent_output",
    "listen_port",
    "connected",
1190
1191
1192
1193
    "progress_mbytes",
    "progress_throughput",
    "progress_eta",
    "progress_percent",
1194
1195
1196
1197
1198
    "exit_status",
    "error_message",
    ] + _TIMESTAMPS


1199
1200
1201
1202
1203
class ImportExportOptions(ConfigObject):
  """Options for import/export daemon

  @ivar key_name: X509 key name (None for cluster certificate)
  @ivar ca_pem: Remote peer CA in PEM format (None for cluster certificate)
1204
  @ivar compress: Compression method (one of L{constants.IEC_ALL})
1205
  @ivar magic: Used to ensure the connection goes to the right disk
1206
1207
1208
1209
1210

  """
  __slots__ = [
    "key_name",
    "ca_pem",
1211
    "compress",
1212
    "magic",
1213
1214
1215
    ]


Guido Trotter's avatar
Guido Trotter committed
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
class ConfdRequest(ConfigObject):
  """Object holding a confd request.

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

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


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

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

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


Iustin Pop's avatar
Iustin Pop committed
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
class SerializableConfigParser(ConfigParser.SafeConfigParser):
  """Simple wrapper over ConfigParse that allows serialization.

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

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

1264
1265
  @classmethod
  def Loads(cls, data):
Iustin Pop's avatar
Iustin Pop committed
1266
1267
    """Load data from a string."""
    buf = StringIO(data)
1268
    cfp = cls()
Iustin Pop's avatar
Iustin Pop committed
1269
1270
    cfp.readfp(buf)
    return cfp