objects.py 12.4 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
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
31
32
#!/usr/bin/python
#

# 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 cPickle
from cStringIO import StringIO
import ConfigParser
33
import re
Iustin Pop's avatar
Iustin Pop committed
34
35

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


__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):
    for i in kwargs:
      setattr(self, i, kwargs[i])

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

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

Iustin Pop's avatar
Iustin Pop committed
73
74
75
76
77
78
79
80
81
82
83
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
  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])

  @staticmethod
  def FindGlobal(module, name):
    """Function filtering the allowed classes to be un-pickled.

    Currently, we only allow the classes from this module which are
    derived from ConfigObject.

    """
    # Also support the old module name (ganeti.config)
    cls = None
    if module == "ganeti.config" or module == "ganeti.objects":
      if name == "ConfigData":
        cls = ConfigData
      elif name == "NIC":
        cls = NIC
      elif name == "Disk" or name == "BlockDev":
        cls = Disk
      elif name == "Instance":
        cls = Instance
      elif name == "OS":
        cls = OS
      elif name == "Node":
        cls = Node
      elif name == "Cluster":
        cls = Cluster
110
111
112
    elif module == "__builtin__":
      if name == "set":
        cls = set
Iustin Pop's avatar
Iustin Pop committed
113
    if cls is None:
114
115
      raise cPickle.UnpicklingError("Class %s.%s not allowed due to"
                                    " security concerns" % (module, name))
Iustin Pop's avatar
Iustin Pop committed
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
    return cls

  def Dump(self, fobj):
    """Dump this instance to a file object.

    Note that we use the HIGHEST_PROTOCOL, as it brings benefits for
    the new classes.

    """
    dumper = cPickle.Pickler(fobj, cPickle.HIGHEST_PROTOCOL)
    dumper.dump(self)

  @staticmethod
  def Load(fobj):
    """Unpickle data from the given stream.

    This uses the `FindGlobal` function to filter the allowed classes.

    """
    loader = cPickle.Unpickler(fobj)
    loader.find_global = ConfigObject.FindGlobal
    return loader.load()

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

  @staticmethod
  def Loads(data):
    """Load data from a string."""
    return ConfigObject.Load(StringIO(data))


151
152
153
154
class TaggableObject(object):
  """An generic class supporting tags.

  """
Iustin Pop's avatar
Iustin Pop committed
155
156
  __slots__ = []

157
158
159
160
161
162
163
164
165
  @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):
166
      raise errors.TagError("Invalid tag type (not a string)")
167
    if len(tag) > constants.MAX_TAG_LEN:
168
      raise errors.TagError("Tag too long (>%d)" % constants.MAX_TAG_LEN)
169
    if not tag:
170
      raise errors.TagError("Tags cannot be empty")
171
    if not re.match("^[ \w.+*/:-]+$", tag):
172
      raise errors.TagError("Tag contains invalid characters")
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

  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:
190
      raise errors.TagError("Too many tags")
191
192
193
194
195
196
197
198
199
200
201
    self.GetTags().add(tag)

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

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


Iustin Pop's avatar
Iustin Pop committed
205
206
class ConfigData(ConfigObject):
  """Top-level config object."""
207
  __slots__ = ["cluster", "nodes", "instances"]
Iustin Pop's avatar
Iustin Pop committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245


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."""
    return self.dev_type in ("drbd", "lvm")

  def AssembleOnSecondary(self):
    """Test if this device needs to be assembled on a secondary node."""
    return self.dev_type in ("drbd", "lvm")

  def OpenOnSecondary(self):
    """Test if this device needs to be opened on a secondary node."""
    return self.dev_type in ("lvm",)

  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.

    """
    if self.dev_type == "lvm" or self.dev_type == "md_raid1":
      result = [node]
    elif self.dev_type == "drbd":
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
246
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
247
    else:
248
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
    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
    tree in the most compact way. For example, a md/drbd/lvm stack
    will be returned as (primary_node, md) and (secondary_node, drbd)
    which represents all the top-level devices on the nodes. This
    means that on the primary node we need to activate the the md (and
    recursively all its children) and on the secondary node we need to
    activate the drbd device (and its children, the two lvm volumes).

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


290
class Instance(ConfigObject, TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
291
292
293
294
295
296
297
298
299
300
301
  """Config object representing an instance."""
  __slots__ = [
    "name",
    "primary_node",
    "os",
    "status",
    "memory",
    "vcpus",
    "nics",
    "disks",
    "disk_template",
302
    "tags",
Iustin Pop's avatar
Iustin Pop committed
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
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
375
376
377
378
379
380
381
382
383
    ]

  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."""
      if device.dev_type == 'drbd':
        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:
      if dev.dev_type == "lvm":
        lvmap[node].append(dev.logical_id[1])

      elif dev.dev_type == "drbd":
        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

384
385
386
387
388
389
390
391
392
393
394
395
  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

Iustin Pop's avatar
Iustin Pop committed
396
397
398
399
400
401
402
403
404

class OS(ConfigObject):
  """Config object representing an operating system."""
  __slots__ = [
    "name",
    "path",
    "api_version",
    "create_script",
    "export_script",
405
406
    "import_script",
    "rename_script",
Iustin Pop's avatar
Iustin Pop committed
407
408
409
    ]


410
class Node(ConfigObject, TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
411
  """Config object representing a node."""
412
  __slots__ = ["name", "primary_ip", "secondary_ip", "tags"]
Iustin Pop's avatar
Iustin Pop committed
413
414


415
class Cluster(ConfigObject, TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
416
417
418
419
420
421
  """Config object representing the cluster."""
  __slots__ = [
    "config_version",
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
422
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
423
424
425
    "mac_prefix",
    "volume_group_name",
    "default_bridge",
426
    "tags",
Iustin Pop's avatar
Iustin Pop committed
427
428
    ]

429

Iustin Pop's avatar
Iustin Pop committed
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
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