objects.py 19.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Transportable objects for Ganeti.

This module provides small, mostly data-only objects which are safe to
pass to and from external parties.

"""


import ConfigParser
31
import re
32
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
33
34

from ganeti import errors
35
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57


__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
           "OS", "Node", "Cluster"]


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
  config objects and the memory reduction is useful.

  """
  __slots__ = []

  def __init__(self, **kwargs):
58
59
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
60
61
62

  def __getattr__(self, name):
    if name not in self.__slots__:
63
64
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
65
66
    return None

67
68
  def __setitem__(self, key, value):
    if key not in self.__slots__:
69
      raise KeyError(key)
70
71
    setattr(self, key, value)

Iustin Pop's avatar
Iustin Pop committed
72
73
74
75
76
77
78
79
80
81
82
83
  def __getstate__(self):
    state = {}
    for name in self.__slots__:
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

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

84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  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.

    """
    return dict([(k, getattr(self, k, None)) for k in self.__slots__])

  @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))
112
113
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
    obj = cls(**val_str)
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
    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

  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

Iustin Pop's avatar
Iustin Pop committed
159

160
class TaggableObject(ConfigObject):
161
162
163
  """An generic class supporting tags.

  """
164
  __slots__ = ConfigObject.__slots__ + ["tags"]
Iustin Pop's avatar
Iustin Pop committed
165

166
167
168
169
170
171
172
173
174
  @staticmethod
  def ValidateTag(tag):
    """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):
175
      raise errors.TagError("Invalid tag type (not a string)")
176
    if len(tag) > constants.MAX_TAG_LEN:
177
178
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
179
    if not tag:
180
      raise errors.TagError("Tags cannot be empty")
181
    if not re.match("^[ \w.+*/:-]+$", tag):
182
      raise errors.TagError("Tag contains invalid characters")
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

  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:
200
      raise errors.TagError("Too many tags")
201
202
203
204
205
206
207
208
209
210
211
    self.GetTags().add(tag)

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

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

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
  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

237

Iustin Pop's avatar
Iustin Pop committed
238
239
class ConfigData(ConfigObject):
  """Top-level config object."""
240
  __slots__ = ["cluster", "nodes", "instances"]
Iustin Pop's avatar
Iustin Pop committed
241

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
  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

Iustin Pop's avatar
Iustin Pop committed
267
268
269
270
271
272
273
274
275
276
277
278
279

class NIC(ConfigObject):
  """Config object representing a network card."""
  __slots__ = ["mac", "ip", "bridge"]


class Disk(ConfigObject):
  """Config object representing a block device."""
  __slots__ = ["dev_type", "logical_id", "physical_id",
               "children", "iv_name", "size"]

  def CreateOnSecondary(self):
    """Test if this device needs to be created on a secondary node."""
280
281
    return self.dev_type in (constants.LD_DRBD7, constants.LD_DRBD8,
                             constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
282
283
284

  def AssembleOnSecondary(self):
    """Test if this device needs to be assembled on a secondary node."""
285
286
    return self.dev_type in (constants.LD_DRBD7, constants.LD_DRBD8,
                             constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
287
288
289

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

292
293
294
295
296
297
298
299
300
301
302
303
  def StaticDevPath(self):
    """Return the device path if this device type has a static one.

    Some devices (LVM for example) live always at the same /dev/ path,
    irrespective of their status. For such devices, we return this
    path, for others we return None.

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

304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
  def ChildrenNeeded(self):
    """Compute the needed number of children for activation.

    This method will return either -1 (all children) or a positive
    number denoting the minimum number of children needed for
    activation (only mirrored devices will usually return >=0).

    Currently, only DRBD8 supports diskless activation (therefore we
    return 0), for all other we keep the previous semantics and return
    -1.

    """
    if self.dev_type == constants.LD_DRBD8:
      return 0
    return -1

Iustin Pop's avatar
Iustin Pop committed
320
321
322
323
324
325
326
327
328
  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.

    """
329
330
    if self.dev_type in [constants.LD_LV, constants.LD_MD_R1,
                         constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
331
      result = [node]
332
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
333
334
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
335
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
336
    else:
337
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
338
339
340
341
342
343
344
    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
345
346
347
    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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374

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

375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  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)
    return obj

404
405
406
407
408
409
410
411
412
413
414
  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:
      if self.dev_type == constants.LD_DRBD7:
        val = "<DRBD7("
      else:
        val = "<DRBD8("
415
416
417
418
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
419
420
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
421
422
423
424

      val += ("hosts=%s-%s, port=%s, %s, " %
              (self.logical_id[0], self.logical_id[1], self.logical_id[2],
               phy))
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
      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"
    elif self.dev_type == constants.LD_MD_R1:
      val = "<MD_R1(uuid=%s, children=%s" % (self.physical_id, self.children)
    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
    val += ", size=%dm)>" % self.size
    return val

Iustin Pop's avatar
Iustin Pop committed
441

442
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
443
  """Config object representing an instance."""
444
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
445
446
447
448
449
450
451
452
453
    "name",
    "primary_node",
    "os",
    "status",
    "memory",
    "vcpus",
    "nics",
    "disks",
    "disk_template",
454
    "network_port",
455
456
    "kernel_path",
    "initrd_path",
457
    "hvm_boot_order",
458
459
460
461
    "hvm_acpi",
    "hvm_pae",
    "hvm_cdrom_image_path",
    "vnc_bind_address",
Iustin Pop's avatar
Iustin Pop committed
462
463
464
465
466
467
468
469
470
471
472
473
474
    ]

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

    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.

    """
    def _Helper(primary, sec_nodes, device):
      """Recursively computes secondary nodes given a top device."""
475
      if device.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
        nodea, nodeb, dummy = device.logical_id
        if nodea == primary:
          candidate = nodeb
        else:
          candidate = nodea
        if candidate not in sec_nodes:
          sec_nodes.append(candidate)
      if device.children:
        for child in device.children:
          _Helper(primary, sec_nodes, child)

    secondary_nodes = []
    for device in self.disks:
      _Helper(self.primary_node, secondary_nodes, device)
    return tuple(secondary_nodes)

  secondary_nodes = property(_ComputeSecondaryNodes, None, None,
                             "List of secondary nodes")

  def MapLVsByNode(self, lvmap=None, devs=None, node=None):
    """Provide a mapping of nodes to LVs this instance owns.

    This function figures out what logical volumes should belong on which
    nodes, recursing through a device tree.

    Args:
      lvmap: (optional) a dictionary to receive the 'node' : ['lv', ...] data.

    Returns:
      None if lvmap arg is given.
      Otherwise, { 'nodename' : ['volume1', 'volume2', ...], ... }

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

527
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
        if dev.logical_id[0] not in lvmap:
          lvmap[dev.logical_id[0]] = []

        if dev.logical_id[1] not in lvmap:
          lvmap[dev.logical_id[1]] = []

        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

543
544
545
546
547
548
549
550
551
552
553
554
  def FindDisk(self, name):
    """Find a disk given having a specified name.

    This will return the disk which has the given iv_name.

    """
    for disk in self.disks:
      if disk.iv_name == name:
        return disk

    return None

555
556
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
582
  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

Iustin Pop's avatar
Iustin Pop committed
583
584
585
586
587
588

class OS(ConfigObject):
  """Config object representing an operating system."""
  __slots__ = [
    "name",
    "path",
589
    "status",
Iustin Pop's avatar
Iustin Pop committed
590
591
592
    "api_version",
    "create_script",
    "export_script",
593
594
    "import_script",
    "rename_script",
Iustin Pop's avatar
Iustin Pop committed
595
596
    ]

597
598
599
600
601
602
603
604
605
606
607
608
609
610
  @classmethod
  def FromInvalidOS(cls, err):
    """Create an OS from an InvalidOS error.

    This routine knows how to convert an InvalidOS error to an OS
    object representing the broken OS with a meaningful error message.

    """
    if not isinstance(err, errors.InvalidOS):
      raise errors.ProgrammerError("Trying to initialize an OS from an"
                                   " invalid object of type %s" % type(err))

    return cls(name=err.args[0], path=err.args[1], status=err.args[2])

611
612
613
614
  def __nonzero__(self):
    return self.status == constants.OS_VALID_STATUS

  __bool__ = __nonzero__
Iustin Pop's avatar
Iustin Pop committed
615

616

617
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
618
  """Config object representing a node."""
619
620
621
622
623
  __slots__ = TaggableObject.__slots__ + [
    "name",
    "primary_ip",
    "secondary_ip",
    ]
Iustin Pop's avatar
Iustin Pop committed
624
625


626
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
627
  """Config object representing the cluster."""
628
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
629
630
631
632
    "config_version",
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
633
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
634
635
636
637
638
    "mac_prefix",
    "volume_group_name",
    "default_bridge",
    ]

639
640
641
642
  def ToDict(self):
    """Custom function for cluster.

    """
643
    mydict = super(Cluster, self).ToDict()
644
645
646
647
648
649
650
651
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
652
    obj = super(Cluster, cls).FromDict(val)
653
654
655
656
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

657

Iustin Pop's avatar
Iustin Pop committed
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
class SerializableConfigParser(ConfigParser.SafeConfigParser):
  """Simple wrapper over ConfigParse that allows serialization.

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

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

  @staticmethod
  def Loads(data):
    """Load data from a string."""
    buf = StringIO(data)
    cfp = SerializableConfigParser()
    cfp.readfp(buf)
    return cfp