Statistics
| Branch: | Tag: | Revision:

root / lib / objects.py @ 2f31098c

History | View | Annotate | Download (17.5 kB)

1 2f31098c Iustin Pop
#
2 a8083063 Iustin Pop
#
3 a8083063 Iustin Pop
4 a8083063 Iustin Pop
# Copyright (C) 2006, 2007 Google Inc.
5 a8083063 Iustin Pop
#
6 a8083063 Iustin Pop
# This program is free software; you can redistribute it and/or modify
7 a8083063 Iustin Pop
# it under the terms of the GNU General Public License as published by
8 a8083063 Iustin Pop
# the Free Software Foundation; either version 2 of the License, or
9 a8083063 Iustin Pop
# (at your option) any later version.
10 a8083063 Iustin Pop
#
11 a8083063 Iustin Pop
# This program is distributed in the hope that it will be useful, but
12 a8083063 Iustin Pop
# WITHOUT ANY WARRANTY; without even the implied warranty of
13 a8083063 Iustin Pop
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 a8083063 Iustin Pop
# General Public License for more details.
15 a8083063 Iustin Pop
#
16 a8083063 Iustin Pop
# You should have received a copy of the GNU General Public License
17 a8083063 Iustin Pop
# along with this program; if not, write to the Free Software
18 a8083063 Iustin Pop
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 a8083063 Iustin Pop
# 02110-1301, USA.
20 a8083063 Iustin Pop
21 a8083063 Iustin Pop
22 a8083063 Iustin Pop
"""Transportable objects for Ganeti.
23 a8083063 Iustin Pop

24 a8083063 Iustin Pop
This module provides small, mostly data-only objects which are safe to
25 a8083063 Iustin Pop
pass to and from external parties.
26 a8083063 Iustin Pop

27 a8083063 Iustin Pop
"""
28 a8083063 Iustin Pop
29 a8083063 Iustin Pop
30 319856a9 Michael Hanselmann
import simplejson
31 a8083063 Iustin Pop
import ConfigParser
32 5c947f38 Iustin Pop
import re
33 d5835922 Michael Hanselmann
from cStringIO import StringIO
34 a8083063 Iustin Pop
35 a8083063 Iustin Pop
from ganeti import errors
36 5c947f38 Iustin Pop
from ganeti import constants
37 a8083063 Iustin Pop
38 a8083063 Iustin Pop
39 a8083063 Iustin Pop
__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
40 a8083063 Iustin Pop
           "OS", "Node", "Cluster"]
41 a8083063 Iustin Pop
42 a8083063 Iustin Pop
43 d5835922 Michael Hanselmann
# Check whether the simplejson module supports indentation
44 d5835922 Michael Hanselmann
_JSON_INDENT = 2
45 d5835922 Michael Hanselmann
try:
46 d5835922 Michael Hanselmann
  simplejson.dumps(1, indent=_JSON_INDENT)
47 d5835922 Michael Hanselmann
except TypeError:
48 d5835922 Michael Hanselmann
  _JSON_INDENT = None
49 d5835922 Michael Hanselmann
50 d5835922 Michael Hanselmann
51 a8083063 Iustin Pop
class ConfigObject(object):
52 a8083063 Iustin Pop
  """A generic config object.
53 a8083063 Iustin Pop

54 a8083063 Iustin Pop
  It has the following properties:
55 a8083063 Iustin Pop

56 a8083063 Iustin Pop
    - provides somewhat safe recursive unpickling and pickling for its classes
57 a8083063 Iustin Pop
    - unset attributes which are defined in slots are always returned
58 a8083063 Iustin Pop
      as None instead of raising an error
59 a8083063 Iustin Pop

60 a8083063 Iustin Pop
  Classes derived from this must always declare __slots__ (we use many
61 a8083063 Iustin Pop
  config objects and the memory reduction is useful.
62 a8083063 Iustin Pop

63 a8083063 Iustin Pop
  """
64 a8083063 Iustin Pop
  __slots__ = []
65 a8083063 Iustin Pop
66 a8083063 Iustin Pop
  def __init__(self, **kwargs):
67 319856a9 Michael Hanselmann
    for k, v in kwargs.iteritems():
68 319856a9 Michael Hanselmann
      setattr(self, k, v)
69 a8083063 Iustin Pop
70 a8083063 Iustin Pop
  def __getattr__(self, name):
71 a8083063 Iustin Pop
    if name not in self.__slots__:
72 3ecf6786 Iustin Pop
      raise AttributeError("Invalid object attribute %s.%s" %
73 3ecf6786 Iustin Pop
                           (type(self).__name__, name))
74 a8083063 Iustin Pop
    return None
75 a8083063 Iustin Pop
76 47c28c5b Michael Hanselmann
  def __setitem__(self, key, value):
77 47c28c5b Michael Hanselmann
    if key not in self.__slots__:
78 3ecf6786 Iustin Pop
      raise KeyError(key)
79 47c28c5b Michael Hanselmann
    setattr(self, key, value)
80 47c28c5b Michael Hanselmann
81 a8083063 Iustin Pop
  def __getstate__(self):
82 a8083063 Iustin Pop
    state = {}
83 a8083063 Iustin Pop
    for name in self.__slots__:
84 a8083063 Iustin Pop
      if hasattr(self, name):
85 a8083063 Iustin Pop
        state[name] = getattr(self, name)
86 a8083063 Iustin Pop
    return state
87 a8083063 Iustin Pop
88 a8083063 Iustin Pop
  def __setstate__(self, state):
89 a8083063 Iustin Pop
    for name in state:
90 a8083063 Iustin Pop
      if name in self.__slots__:
91 a8083063 Iustin Pop
        setattr(self, name, state[name])
92 a8083063 Iustin Pop
93 a8083063 Iustin Pop
  def Dump(self, fobj):
94 319856a9 Michael Hanselmann
    """Dump to a file object.
95 a8083063 Iustin Pop

96 a8083063 Iustin Pop
    """
97 d5835922 Michael Hanselmann
    data = self.ToDict()
98 d5835922 Michael Hanselmann
    if _JSON_INDENT is None:
99 d5835922 Michael Hanselmann
      simplejson.dump(data, fobj)
100 d5835922 Michael Hanselmann
    else:
101 d5835922 Michael Hanselmann
      simplejson.dump(data, fobj, indent=_JSON_INDENT)
102 a8083063 Iustin Pop
103 319856a9 Michael Hanselmann
  @classmethod
104 319856a9 Michael Hanselmann
  def Load(cls, fobj):
105 319856a9 Michael Hanselmann
    """Load data from the given stream.
106 a8083063 Iustin Pop

107 a8083063 Iustin Pop
    """
108 319856a9 Michael Hanselmann
    return cls.FromDict(simplejson.load(fobj))
109 a8083063 Iustin Pop
110 a8083063 Iustin Pop
  def Dumps(self):
111 319856a9 Michael Hanselmann
    """Dump and return the string representation."""
112 a8083063 Iustin Pop
    buf = StringIO()
113 a8083063 Iustin Pop
    self.Dump(buf)
114 a8083063 Iustin Pop
    return buf.getvalue()
115 a8083063 Iustin Pop
116 319856a9 Michael Hanselmann
  @classmethod
117 319856a9 Michael Hanselmann
  def Loads(cls, data):
118 a8083063 Iustin Pop
    """Load data from a string."""
119 319856a9 Michael Hanselmann
    return cls.Load(StringIO(data))
120 a8083063 Iustin Pop
121 ff9c047c Iustin Pop
  def ToDict(self):
122 ff9c047c Iustin Pop
    """Convert to a dict holding only standard python types.
123 ff9c047c Iustin Pop

124 ff9c047c Iustin Pop
    The generic routine just dumps all of this object's attributes in
125 ff9c047c Iustin Pop
    a dict. It does not work if the class has children who are
126 ff9c047c Iustin Pop
    ConfigObjects themselves (e.g. the nics list in an Instance), in
127 ff9c047c Iustin Pop
    which case the object should subclass the function in order to
128 ff9c047c Iustin Pop
    make sure all objects returned are only standard python types.
129 ff9c047c Iustin Pop

130 ff9c047c Iustin Pop
    """
131 ff9c047c Iustin Pop
    return dict([(k, getattr(self, k, None)) for k in self.__slots__])
132 ff9c047c Iustin Pop
133 ff9c047c Iustin Pop
  @classmethod
134 ff9c047c Iustin Pop
  def FromDict(cls, val):
135 ff9c047c Iustin Pop
    """Create an object from a dictionary.
136 ff9c047c Iustin Pop

137 ff9c047c Iustin Pop
    This generic routine takes a dict, instantiates a new instance of
138 ff9c047c Iustin Pop
    the given class, and sets attributes based on the dict content.
139 ff9c047c Iustin Pop

140 ff9c047c Iustin Pop
    As for `ToDict`, this does not work if the class has children
141 ff9c047c Iustin Pop
    who are ConfigObjects themselves (e.g. the nics list in an
142 ff9c047c Iustin Pop
    Instance), in which case the object should subclass the function
143 ff9c047c Iustin Pop
    and alter the objects.
144 ff9c047c Iustin Pop

145 ff9c047c Iustin Pop
    """
146 ff9c047c Iustin Pop
    if not isinstance(val, dict):
147 ff9c047c Iustin Pop
      raise errors.ConfigurationError("Invalid object passed to FromDict:"
148 ff9c047c Iustin Pop
                                      " expected dict, got %s" % type(val))
149 319856a9 Michael Hanselmann
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
150 319856a9 Michael Hanselmann
    obj = cls(**val_str)
151 ff9c047c Iustin Pop
    return obj
152 ff9c047c Iustin Pop
153 ff9c047c Iustin Pop
  @staticmethod
154 ff9c047c Iustin Pop
  def _ContainerToDicts(container):
155 ff9c047c Iustin Pop
    """Convert the elements of a container to standard python types.
156 ff9c047c Iustin Pop

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

161 ff9c047c Iustin Pop
    """
162 ff9c047c Iustin Pop
    if isinstance(container, dict):
163 ff9c047c Iustin Pop
      ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])
164 ff9c047c Iustin Pop
    elif isinstance(container, (list, tuple, set, frozenset)):
165 ff9c047c Iustin Pop
      ret = [elem.ToDict() for elem in container]
166 ff9c047c Iustin Pop
    else:
167 ff9c047c Iustin Pop
      raise TypeError("Invalid type %s passed to _ContainerToDicts" %
168 ff9c047c Iustin Pop
                      type(container))
169 ff9c047c Iustin Pop
    return ret
170 ff9c047c Iustin Pop
171 ff9c047c Iustin Pop
  @staticmethod
172 ff9c047c Iustin Pop
  def _ContainerFromDicts(source, c_type, e_type):
173 ff9c047c Iustin Pop
    """Convert a container from standard python types.
174 ff9c047c Iustin Pop

175 ff9c047c Iustin Pop
    This method converts a container with standard python types to
176 ff9c047c Iustin Pop
    ConfigData objects. If the container is a dict, we don't touch the
177 ff9c047c Iustin Pop
    keys, only the values.
178 ff9c047c Iustin Pop

179 ff9c047c Iustin Pop
    """
180 ff9c047c Iustin Pop
    if not isinstance(c_type, type):
181 ff9c047c Iustin Pop
      raise TypeError("Container type %s passed to _ContainerFromDicts is"
182 ff9c047c Iustin Pop
                      " not a type" % type(c_type))
183 ff9c047c Iustin Pop
    if c_type is dict:
184 ff9c047c Iustin Pop
      ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])
185 ff9c047c Iustin Pop
    elif c_type in (list, tuple, set, frozenset):
186 ff9c047c Iustin Pop
      ret = c_type([e_type.FromDict(elem) for elem in source])
187 ff9c047c Iustin Pop
    else:
188 ff9c047c Iustin Pop
      raise TypeError("Invalid container type %s passed to"
189 ff9c047c Iustin Pop
                      " _ContainerFromDicts" % c_type)
190 ff9c047c Iustin Pop
    return ret
191 ff9c047c Iustin Pop
192 ff9c047c Iustin Pop
  def __repr__(self):
193 ff9c047c Iustin Pop
    """Implement __repr__ for ConfigObjects."""
194 ff9c047c Iustin Pop
    return repr(self.ToDict())
195 ff9c047c Iustin Pop
196 a8083063 Iustin Pop
197 ec29fe40 Iustin Pop
class TaggableObject(ConfigObject):
198 5c947f38 Iustin Pop
  """An generic class supporting tags.
199 5c947f38 Iustin Pop

200 5c947f38 Iustin Pop
  """
201 ec29fe40 Iustin Pop
  __slots__ = ConfigObject.__slots__ + ["tags"]
202 2057f6c7 Iustin Pop
203 5c947f38 Iustin Pop
  @staticmethod
204 5c947f38 Iustin Pop
  def ValidateTag(tag):
205 5c947f38 Iustin Pop
    """Check if a tag is valid.
206 5c947f38 Iustin Pop

207 5c947f38 Iustin Pop
    If the tag is invalid, an errors.TagError will be raised. The
208 5c947f38 Iustin Pop
    function has no return value.
209 5c947f38 Iustin Pop

210 5c947f38 Iustin Pop
    """
211 5c947f38 Iustin Pop
    if not isinstance(tag, basestring):
212 3ecf6786 Iustin Pop
      raise errors.TagError("Invalid tag type (not a string)")
213 5c947f38 Iustin Pop
    if len(tag) > constants.MAX_TAG_LEN:
214 319856a9 Michael Hanselmann
      raise errors.TagError("Tag too long (>%d characters)" %
215 319856a9 Michael Hanselmann
                            constants.MAX_TAG_LEN)
216 5c947f38 Iustin Pop
    if not tag:
217 3ecf6786 Iustin Pop
      raise errors.TagError("Tags cannot be empty")
218 5c947f38 Iustin Pop
    if not re.match("^[ \w.+*/:-]+$", tag):
219 3ecf6786 Iustin Pop
      raise errors.TagError("Tag contains invalid characters")
220 5c947f38 Iustin Pop
221 5c947f38 Iustin Pop
  def GetTags(self):
222 5c947f38 Iustin Pop
    """Return the tags list.
223 5c947f38 Iustin Pop

224 5c947f38 Iustin Pop
    """
225 5c947f38 Iustin Pop
    tags = getattr(self, "tags", None)
226 5c947f38 Iustin Pop
    if tags is None:
227 5c947f38 Iustin Pop
      tags = self.tags = set()
228 5c947f38 Iustin Pop
    return tags
229 5c947f38 Iustin Pop
230 5c947f38 Iustin Pop
  def AddTag(self, tag):
231 5c947f38 Iustin Pop
    """Add a new tag.
232 5c947f38 Iustin Pop

233 5c947f38 Iustin Pop
    """
234 5c947f38 Iustin Pop
    self.ValidateTag(tag)
235 5c947f38 Iustin Pop
    tags = self.GetTags()
236 5c947f38 Iustin Pop
    if len(tags) >= constants.MAX_TAGS_PER_OBJ:
237 3ecf6786 Iustin Pop
      raise errors.TagError("Too many tags")
238 5c947f38 Iustin Pop
    self.GetTags().add(tag)
239 5c947f38 Iustin Pop
240 5c947f38 Iustin Pop
  def RemoveTag(self, tag):
241 5c947f38 Iustin Pop
    """Remove a tag.
242 5c947f38 Iustin Pop

243 5c947f38 Iustin Pop
    """
244 5c947f38 Iustin Pop
    self.ValidateTag(tag)
245 5c947f38 Iustin Pop
    tags = self.GetTags()
246 5c947f38 Iustin Pop
    try:
247 5c947f38 Iustin Pop
      tags.remove(tag)
248 5c947f38 Iustin Pop
    except KeyError:
249 3ecf6786 Iustin Pop
      raise errors.TagError("Tag not found")
250 5c947f38 Iustin Pop
251 ff9c047c Iustin Pop
  def ToDict(self):
252 ff9c047c Iustin Pop
    """Taggable-object-specific conversion to standard python types.
253 ff9c047c Iustin Pop

254 ff9c047c Iustin Pop
    This replaces the tags set with a list.
255 ff9c047c Iustin Pop

256 ff9c047c Iustin Pop
    """
257 ff9c047c Iustin Pop
    bo = super(TaggableObject, self).ToDict()
258 ff9c047c Iustin Pop
259 ff9c047c Iustin Pop
    tags = bo.get("tags", None)
260 ff9c047c Iustin Pop
    if isinstance(tags, set):
261 ff9c047c Iustin Pop
      bo["tags"] = list(tags)
262 ff9c047c Iustin Pop
    return bo
263 ff9c047c Iustin Pop
264 ff9c047c Iustin Pop
  @classmethod
265 ff9c047c Iustin Pop
  def FromDict(cls, val):
266 ff9c047c Iustin Pop
    """Custom function for instances.
267 ff9c047c Iustin Pop

268 ff9c047c Iustin Pop
    """
269 ff9c047c Iustin Pop
    obj = super(TaggableObject, cls).FromDict(val)
270 ff9c047c Iustin Pop
    if hasattr(obj, "tags") and isinstance(obj.tags, list):
271 ff9c047c Iustin Pop
      obj.tags = set(obj.tags)
272 ff9c047c Iustin Pop
    return obj
273 ff9c047c Iustin Pop
274 5c947f38 Iustin Pop
275 a8083063 Iustin Pop
class ConfigData(ConfigObject):
276 a8083063 Iustin Pop
  """Top-level config object."""
277 b2fddf63 Iustin Pop
  __slots__ = ["cluster", "nodes", "instances"]
278 a8083063 Iustin Pop
279 ff9c047c Iustin Pop
  def ToDict(self):
280 ff9c047c Iustin Pop
    """Custom function for top-level config data.
281 ff9c047c Iustin Pop

282 ff9c047c Iustin Pop
    This just replaces the list of instances, nodes and the cluster
283 ff9c047c Iustin Pop
    with standard python types.
284 ff9c047c Iustin Pop

285 ff9c047c Iustin Pop
    """
286 ff9c047c Iustin Pop
    mydict = super(ConfigData, self).ToDict()
287 ff9c047c Iustin Pop
    mydict["cluster"] = mydict["cluster"].ToDict()
288 ff9c047c Iustin Pop
    for key in "nodes", "instances":
289 ff9c047c Iustin Pop
      mydict[key] = self._ContainerToDicts(mydict[key])
290 ff9c047c Iustin Pop
291 ff9c047c Iustin Pop
    return mydict
292 ff9c047c Iustin Pop
293 ff9c047c Iustin Pop
  @classmethod
294 ff9c047c Iustin Pop
  def FromDict(cls, val):
295 ff9c047c Iustin Pop
    """Custom function for top-level config data
296 ff9c047c Iustin Pop

297 ff9c047c Iustin Pop
    """
298 ff9c047c Iustin Pop
    obj = super(ConfigData, cls).FromDict(val)
299 ff9c047c Iustin Pop
    obj.cluster = Cluster.FromDict(obj.cluster)
300 ff9c047c Iustin Pop
    obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)
301 ff9c047c Iustin Pop
    obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)
302 ff9c047c Iustin Pop
    return obj
303 ff9c047c Iustin Pop
304 a8083063 Iustin Pop
305 a8083063 Iustin Pop
class NIC(ConfigObject):
306 a8083063 Iustin Pop
  """Config object representing a network card."""
307 a8083063 Iustin Pop
  __slots__ = ["mac", "ip", "bridge"]
308 a8083063 Iustin Pop
309 a8083063 Iustin Pop
310 a8083063 Iustin Pop
class Disk(ConfigObject):
311 a8083063 Iustin Pop
  """Config object representing a block device."""
312 a8083063 Iustin Pop
  __slots__ = ["dev_type", "logical_id", "physical_id",
313 a8083063 Iustin Pop
               "children", "iv_name", "size"]
314 a8083063 Iustin Pop
315 a8083063 Iustin Pop
  def CreateOnSecondary(self):
316 a8083063 Iustin Pop
    """Test if this device needs to be created on a secondary node."""
317 a8083063 Iustin Pop
    return self.dev_type in ("drbd", "lvm")
318 a8083063 Iustin Pop
319 a8083063 Iustin Pop
  def AssembleOnSecondary(self):
320 a8083063 Iustin Pop
    """Test if this device needs to be assembled on a secondary node."""
321 a8083063 Iustin Pop
    return self.dev_type in ("drbd", "lvm")
322 a8083063 Iustin Pop
323 a8083063 Iustin Pop
  def OpenOnSecondary(self):
324 a8083063 Iustin Pop
    """Test if this device needs to be opened on a secondary node."""
325 a8083063 Iustin Pop
    return self.dev_type in ("lvm",)
326 a8083063 Iustin Pop
327 a8083063 Iustin Pop
  def GetNodes(self, node):
328 a8083063 Iustin Pop
    """This function returns the nodes this device lives on.
329 a8083063 Iustin Pop

330 a8083063 Iustin Pop
    Given the node on which the parent of the device lives on (or, in
331 a8083063 Iustin Pop
    case of a top-level device, the primary node of the devices'
332 a8083063 Iustin Pop
    instance), this function will return a list of nodes on which this
333 a8083063 Iustin Pop
    devices needs to (or can) be assembled.
334 a8083063 Iustin Pop

335 a8083063 Iustin Pop
    """
336 a8083063 Iustin Pop
    if self.dev_type == "lvm" or self.dev_type == "md_raid1":
337 a8083063 Iustin Pop
      result = [node]
338 a8083063 Iustin Pop
    elif self.dev_type == "drbd":
339 a8083063 Iustin Pop
      result = [self.logical_id[0], self.logical_id[1]]
340 a8083063 Iustin Pop
      if node not in result:
341 3ecf6786 Iustin Pop
        raise errors.ConfigurationError("DRBD device passed unknown node")
342 a8083063 Iustin Pop
    else:
343 3ecf6786 Iustin Pop
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
344 a8083063 Iustin Pop
    return result
345 a8083063 Iustin Pop
346 a8083063 Iustin Pop
  def ComputeNodeTree(self, parent_node):
347 a8083063 Iustin Pop
    """Compute the node/disk tree for this disk and its children.
348 a8083063 Iustin Pop

349 a8083063 Iustin Pop
    This method, given the node on which the parent disk lives, will
350 a8083063 Iustin Pop
    return the list of all (node, disk) pairs which describe the disk
351 a8083063 Iustin Pop
    tree in the most compact way. For example, a md/drbd/lvm stack
352 a8083063 Iustin Pop
    will be returned as (primary_node, md) and (secondary_node, drbd)
353 a8083063 Iustin Pop
    which represents all the top-level devices on the nodes. This
354 a8083063 Iustin Pop
    means that on the primary node we need to activate the the md (and
355 a8083063 Iustin Pop
    recursively all its children) and on the secondary node we need to
356 a8083063 Iustin Pop
    activate the drbd device (and its children, the two lvm volumes).
357 a8083063 Iustin Pop

358 a8083063 Iustin Pop
    """
359 a8083063 Iustin Pop
    my_nodes = self.GetNodes(parent_node)
360 a8083063 Iustin Pop
    result = [(node, self) for node in my_nodes]
361 a8083063 Iustin Pop
    if not self.children:
362 a8083063 Iustin Pop
      # leaf device
363 a8083063 Iustin Pop
      return result
364 a8083063 Iustin Pop
    for node in my_nodes:
365 a8083063 Iustin Pop
      for child in self.children:
366 a8083063 Iustin Pop
        child_result = child.ComputeNodeTree(node)
367 a8083063 Iustin Pop
        if len(child_result) == 1:
368 a8083063 Iustin Pop
          # child (and all its descendants) is simple, doesn't split
369 a8083063 Iustin Pop
          # over multiple hosts, so we don't need to describe it, our
370 a8083063 Iustin Pop
          # own entry for this node describes it completely
371 a8083063 Iustin Pop
          continue
372 a8083063 Iustin Pop
        else:
373 a8083063 Iustin Pop
          # check if child nodes differ from my nodes; note that
374 a8083063 Iustin Pop
          # subdisk can differ from the child itself, and be instead
375 a8083063 Iustin Pop
          # one of its descendants
376 a8083063 Iustin Pop
          for subnode, subdisk in child_result:
377 a8083063 Iustin Pop
            if subnode not in my_nodes:
378 a8083063 Iustin Pop
              result.append((subnode, subdisk))
379 a8083063 Iustin Pop
            # otherwise child is under our own node, so we ignore this
380 a8083063 Iustin Pop
            # entry (but probably the other results in the list will
381 a8083063 Iustin Pop
            # be different)
382 a8083063 Iustin Pop
    return result
383 a8083063 Iustin Pop
384 ff9c047c Iustin Pop
  def ToDict(self):
385 ff9c047c Iustin Pop
    """Disk-specific conversion to standard python types.
386 ff9c047c Iustin Pop

387 ff9c047c Iustin Pop
    This replaces the children lists of objects with lists of
388 ff9c047c Iustin Pop
    standard python types.
389 ff9c047c Iustin Pop

390 ff9c047c Iustin Pop
    """
391 ff9c047c Iustin Pop
    bo = super(Disk, self).ToDict()
392 ff9c047c Iustin Pop
393 ff9c047c Iustin Pop
    for attr in ("children",):
394 ff9c047c Iustin Pop
      alist = bo.get(attr, None)
395 ff9c047c Iustin Pop
      if alist:
396 ff9c047c Iustin Pop
        bo[attr] = self._ContainerToDicts(alist)
397 ff9c047c Iustin Pop
    return bo
398 ff9c047c Iustin Pop
399 ff9c047c Iustin Pop
  @classmethod
400 ff9c047c Iustin Pop
  def FromDict(cls, val):
401 ff9c047c Iustin Pop
    """Custom function for Disks
402 ff9c047c Iustin Pop

403 ff9c047c Iustin Pop
    """
404 ff9c047c Iustin Pop
    obj = super(Disk, cls).FromDict(val)
405 ff9c047c Iustin Pop
    if obj.children:
406 ff9c047c Iustin Pop
      obj.children = cls._ContainerFromDicts(obj.children, list, Disk)
407 ff9c047c Iustin Pop
    if obj.logical_id and isinstance(obj.logical_id, list):
408 ff9c047c Iustin Pop
      obj.logical_id = tuple(obj.logical_id)
409 ff9c047c Iustin Pop
    if obj.physical_id and isinstance(obj.physical_id, list):
410 ff9c047c Iustin Pop
      obj.physical_id = tuple(obj.physical_id)
411 ff9c047c Iustin Pop
    return obj
412 ff9c047c Iustin Pop
413 a8083063 Iustin Pop
414 ec29fe40 Iustin Pop
class Instance(TaggableObject):
415 a8083063 Iustin Pop
  """Config object representing an instance."""
416 ec29fe40 Iustin Pop
  __slots__ = TaggableObject.__slots__ + [
417 a8083063 Iustin Pop
    "name",
418 a8083063 Iustin Pop
    "primary_node",
419 a8083063 Iustin Pop
    "os",
420 a8083063 Iustin Pop
    "status",
421 a8083063 Iustin Pop
    "memory",
422 a8083063 Iustin Pop
    "vcpus",
423 a8083063 Iustin Pop
    "nics",
424 a8083063 Iustin Pop
    "disks",
425 a8083063 Iustin Pop
    "disk_template",
426 a8083063 Iustin Pop
    ]
427 a8083063 Iustin Pop
428 a8083063 Iustin Pop
  def _ComputeSecondaryNodes(self):
429 a8083063 Iustin Pop
    """Compute the list of secondary nodes.
430 a8083063 Iustin Pop

431 a8083063 Iustin Pop
    Since the data is already there (in the drbd disks), keeping it as
432 a8083063 Iustin Pop
    a separate normal attribute is redundant and if not properly
433 a8083063 Iustin Pop
    synchronised can cause problems. Thus it's better to compute it
434 a8083063 Iustin Pop
    dynamically.
435 a8083063 Iustin Pop

436 a8083063 Iustin Pop
    """
437 a8083063 Iustin Pop
    def _Helper(primary, sec_nodes, device):
438 a8083063 Iustin Pop
      """Recursively computes secondary nodes given a top device."""
439 a8083063 Iustin Pop
      if device.dev_type == 'drbd':
440 a8083063 Iustin Pop
        nodea, nodeb, dummy = device.logical_id
441 a8083063 Iustin Pop
        if nodea == primary:
442 a8083063 Iustin Pop
          candidate = nodeb
443 a8083063 Iustin Pop
        else:
444 a8083063 Iustin Pop
          candidate = nodea
445 a8083063 Iustin Pop
        if candidate not in sec_nodes:
446 a8083063 Iustin Pop
          sec_nodes.append(candidate)
447 a8083063 Iustin Pop
      if device.children:
448 a8083063 Iustin Pop
        for child in device.children:
449 a8083063 Iustin Pop
          _Helper(primary, sec_nodes, child)
450 a8083063 Iustin Pop
451 a8083063 Iustin Pop
    secondary_nodes = []
452 a8083063 Iustin Pop
    for device in self.disks:
453 a8083063 Iustin Pop
      _Helper(self.primary_node, secondary_nodes, device)
454 a8083063 Iustin Pop
    return tuple(secondary_nodes)
455 a8083063 Iustin Pop
456 a8083063 Iustin Pop
  secondary_nodes = property(_ComputeSecondaryNodes, None, None,
457 a8083063 Iustin Pop
                             "List of secondary nodes")
458 a8083063 Iustin Pop
459 a8083063 Iustin Pop
  def MapLVsByNode(self, lvmap=None, devs=None, node=None):
460 a8083063 Iustin Pop
    """Provide a mapping of nodes to LVs this instance owns.
461 a8083063 Iustin Pop

462 a8083063 Iustin Pop
    This function figures out what logical volumes should belong on which
463 a8083063 Iustin Pop
    nodes, recursing through a device tree.
464 a8083063 Iustin Pop

465 a8083063 Iustin Pop
    Args:
466 a8083063 Iustin Pop
      lvmap: (optional) a dictionary to receive the 'node' : ['lv', ...] data.
467 a8083063 Iustin Pop

468 a8083063 Iustin Pop
    Returns:
469 a8083063 Iustin Pop
      None if lvmap arg is given.
470 a8083063 Iustin Pop
      Otherwise, { 'nodename' : ['volume1', 'volume2', ...], ... }
471 a8083063 Iustin Pop

472 a8083063 Iustin Pop
    """
473 a8083063 Iustin Pop
    if node == None:
474 a8083063 Iustin Pop
      node = self.primary_node
475 a8083063 Iustin Pop
476 a8083063 Iustin Pop
    if lvmap is None:
477 a8083063 Iustin Pop
      lvmap = { node : [] }
478 a8083063 Iustin Pop
      ret = lvmap
479 a8083063 Iustin Pop
    else:
480 a8083063 Iustin Pop
      if not node in lvmap:
481 a8083063 Iustin Pop
        lvmap[node] = []
482 a8083063 Iustin Pop
      ret = None
483 a8083063 Iustin Pop
484 a8083063 Iustin Pop
    if not devs:
485 a8083063 Iustin Pop
      devs = self.disks
486 a8083063 Iustin Pop
487 a8083063 Iustin Pop
    for dev in devs:
488 a8083063 Iustin Pop
      if dev.dev_type == "lvm":
489 a8083063 Iustin Pop
        lvmap[node].append(dev.logical_id[1])
490 a8083063 Iustin Pop
491 a8083063 Iustin Pop
      elif dev.dev_type == "drbd":
492 a8083063 Iustin Pop
        if dev.logical_id[0] not in lvmap:
493 a8083063 Iustin Pop
          lvmap[dev.logical_id[0]] = []
494 a8083063 Iustin Pop
495 a8083063 Iustin Pop
        if dev.logical_id[1] not in lvmap:
496 a8083063 Iustin Pop
          lvmap[dev.logical_id[1]] = []
497 a8083063 Iustin Pop
498 a8083063 Iustin Pop
        if dev.children:
499 a8083063 Iustin Pop
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
500 a8083063 Iustin Pop
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])
501 a8083063 Iustin Pop
502 a8083063 Iustin Pop
      elif dev.children:
503 a8083063 Iustin Pop
        self.MapLVsByNode(lvmap, dev.children, node)
504 a8083063 Iustin Pop
505 a8083063 Iustin Pop
    return ret
506 a8083063 Iustin Pop
507 644eeef9 Iustin Pop
  def FindDisk(self, name):
508 644eeef9 Iustin Pop
    """Find a disk given having a specified name.
509 644eeef9 Iustin Pop

510 644eeef9 Iustin Pop
    This will return the disk which has the given iv_name.
511 644eeef9 Iustin Pop

512 644eeef9 Iustin Pop
    """
513 644eeef9 Iustin Pop
    for disk in self.disks:
514 644eeef9 Iustin Pop
      if disk.iv_name == name:
515 644eeef9 Iustin Pop
        return disk
516 644eeef9 Iustin Pop
517 644eeef9 Iustin Pop
    return None
518 644eeef9 Iustin Pop
519 ff9c047c Iustin Pop
  def ToDict(self):
520 ff9c047c Iustin Pop
    """Instance-specific conversion to standard python types.
521 ff9c047c Iustin Pop

522 ff9c047c Iustin Pop
    This replaces the children lists of objects with lists of standard
523 ff9c047c Iustin Pop
    python types.
524 ff9c047c Iustin Pop

525 ff9c047c Iustin Pop
    """
526 ff9c047c Iustin Pop
    bo = super(Instance, self).ToDict()
527 ff9c047c Iustin Pop
528 ff9c047c Iustin Pop
    for attr in "nics", "disks":
529 ff9c047c Iustin Pop
      alist = bo.get(attr, None)
530 ff9c047c Iustin Pop
      if alist:
531 ff9c047c Iustin Pop
        nlist = self._ContainerToDicts(alist)
532 ff9c047c Iustin Pop
      else:
533 ff9c047c Iustin Pop
        nlist = []
534 ff9c047c Iustin Pop
      bo[attr] = nlist
535 ff9c047c Iustin Pop
    return bo
536 ff9c047c Iustin Pop
537 ff9c047c Iustin Pop
  @classmethod
538 ff9c047c Iustin Pop
  def FromDict(cls, val):
539 ff9c047c Iustin Pop
    """Custom function for instances.
540 ff9c047c Iustin Pop

541 ff9c047c Iustin Pop
    """
542 ff9c047c Iustin Pop
    obj = super(Instance, cls).FromDict(val)
543 ff9c047c Iustin Pop
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
544 ff9c047c Iustin Pop
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
545 ff9c047c Iustin Pop
    return obj
546 ff9c047c Iustin Pop
547 a8083063 Iustin Pop
548 a8083063 Iustin Pop
class OS(ConfigObject):
549 a8083063 Iustin Pop
  """Config object representing an operating system."""
550 a8083063 Iustin Pop
  __slots__ = [
551 a8083063 Iustin Pop
    "name",
552 a8083063 Iustin Pop
    "path",
553 a8083063 Iustin Pop
    "api_version",
554 a8083063 Iustin Pop
    "create_script",
555 a8083063 Iustin Pop
    "export_script",
556 386b57af Iustin Pop
    "import_script",
557 386b57af Iustin Pop
    "rename_script",
558 a8083063 Iustin Pop
    ]
559 a8083063 Iustin Pop
560 a8083063 Iustin Pop
561 ec29fe40 Iustin Pop
class Node(TaggableObject):
562 a8083063 Iustin Pop
  """Config object representing a node."""
563 ec29fe40 Iustin Pop
  __slots__ = TaggableObject.__slots__ + [
564 ec29fe40 Iustin Pop
    "name",
565 ec29fe40 Iustin Pop
    "primary_ip",
566 ec29fe40 Iustin Pop
    "secondary_ip",
567 ec29fe40 Iustin Pop
    ]
568 a8083063 Iustin Pop
569 a8083063 Iustin Pop
570 ec29fe40 Iustin Pop
class Cluster(TaggableObject):
571 a8083063 Iustin Pop
  """Config object representing the cluster."""
572 ec29fe40 Iustin Pop
  __slots__ = TaggableObject.__slots__ + [
573 a8083063 Iustin Pop
    "config_version",
574 a8083063 Iustin Pop
    "serial_no",
575 a8083063 Iustin Pop
    "rsahostkeypub",
576 a8083063 Iustin Pop
    "highest_used_port",
577 b2fddf63 Iustin Pop
    "tcpudp_port_pool",
578 a8083063 Iustin Pop
    "mac_prefix",
579 a8083063 Iustin Pop
    "volume_group_name",
580 a8083063 Iustin Pop
    "default_bridge",
581 a8083063 Iustin Pop
    ]
582 a8083063 Iustin Pop
583 319856a9 Michael Hanselmann
  def ToDict(self):
584 319856a9 Michael Hanselmann
    """Custom function for cluster.
585 319856a9 Michael Hanselmann

586 319856a9 Michael Hanselmann
    """
587 b60ae2ca Iustin Pop
    mydict = super(Cluster, self).ToDict()
588 319856a9 Michael Hanselmann
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
589 319856a9 Michael Hanselmann
    return mydict
590 319856a9 Michael Hanselmann
591 319856a9 Michael Hanselmann
  @classmethod
592 319856a9 Michael Hanselmann
  def FromDict(cls, val):
593 319856a9 Michael Hanselmann
    """Custom function for cluster.
594 319856a9 Michael Hanselmann

595 319856a9 Michael Hanselmann
    """
596 b60ae2ca Iustin Pop
    obj = super(Cluster, cls).FromDict(val)
597 319856a9 Michael Hanselmann
    if not isinstance(obj.tcpudp_port_pool, set):
598 319856a9 Michael Hanselmann
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
599 319856a9 Michael Hanselmann
    return obj
600 319856a9 Michael Hanselmann
601 5c947f38 Iustin Pop
602 a8083063 Iustin Pop
class SerializableConfigParser(ConfigParser.SafeConfigParser):
603 a8083063 Iustin Pop
  """Simple wrapper over ConfigParse that allows serialization.
604 a8083063 Iustin Pop

605 a8083063 Iustin Pop
  This class is basically ConfigParser.SafeConfigParser with two
606 a8083063 Iustin Pop
  additional methods that allow it to serialize/unserialize to/from a
607 a8083063 Iustin Pop
  buffer.
608 a8083063 Iustin Pop

609 a8083063 Iustin Pop
  """
610 a8083063 Iustin Pop
  def Dumps(self):
611 a8083063 Iustin Pop
    """Dump this instance and return the string representation."""
612 a8083063 Iustin Pop
    buf = StringIO()
613 a8083063 Iustin Pop
    self.write(buf)
614 a8083063 Iustin Pop
    return buf.getvalue()
615 a8083063 Iustin Pop
616 a8083063 Iustin Pop
  @staticmethod
617 a8083063 Iustin Pop
  def Loads(data):
618 a8083063 Iustin Pop
    """Load data from a string."""
619 a8083063 Iustin Pop
    buf = StringIO(data)
620 a8083063 Iustin Pop
    cfp = SerializableConfigParser()
621 a8083063 Iustin Pop
    cfp.readfp(buf)
622 a8083063 Iustin Pop
    return cfp