objects.py 70.3 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, 2011, 2012, 2013, 2014 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Transportable objects for Ganeti.

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

"""

29
# pylint: disable=E0203,W0201,R0902
Iustin Pop's avatar
Iustin Pop committed
30
31

# E0203: Access to member %r before its definition, since we use
Iustin Pop's avatar
Iustin Pop committed
32
# objects.py which doesn't explicitly initialise its members
Iustin Pop's avatar
Iustin Pop committed
33

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

36
37
# R0902: Allow instances of these objects to have more than 20 attributes

Iustin Pop's avatar
Iustin Pop committed
38
import ConfigParser
39
import re
40
import copy
41
import logging
42
import time
43
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
44
45

from ganeti import errors
46
from ganeti import constants
47
from ganeti import netutils
48
from ganeti import outils
49
from ganeti import utils
50
from ganeti import serializer
Iustin Pop's avatar
Iustin Pop committed
51

52
53
from socket import AF_INET

Iustin Pop's avatar
Iustin Pop committed
54
55

__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
56
           "OS", "Node", "NodeGroup", "Cluster", "FillDict", "Network"]
Iustin Pop's avatar
Iustin Pop committed
57

58
_TIMESTAMPS = ["ctime", "mtime"]
59
_UUID = ["uuid"]
60

61

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

Iustin Pop's avatar
Iustin Pop committed
65
66
67
68
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
69
70
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
71
72
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
73

Iustin Pop's avatar
Iustin Pop committed
74
75
76
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
77
78
  if skip_keys:
    for k in skip_keys:
79
      if k in ret_dict:
80
        del ret_dict[k]
Iustin Pop's avatar
Iustin Pop committed
81
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
82

83

84
def FillIPolicy(default_ipolicy, custom_ipolicy):
85
  """Fills an instance policy with defaults.
86
87

  """
88
  assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS
89
90
91
92
93
94
  ret_dict = copy.deepcopy(custom_ipolicy)
  for key in default_ipolicy:
    if key not in ret_dict:
      ret_dict[key] = copy.deepcopy(default_ipolicy[key])
    elif key == constants.ISPECS_STD:
      ret_dict[key] = FillDict(default_ipolicy[key], ret_dict[key])
95
96
97
  return ret_dict


98
99
100
def FillDiskParams(default_dparams, custom_dparams, skip_keys=None):
  """Fills the disk parameter defaults.

101
  @see: L{FillDict} for parameters and return value
102
103
104
105
106
107
108
109
110

  """
  assert frozenset(default_dparams.keys()) == constants.DISK_TEMPLATES

  return dict((dt, FillDict(default_dparams[dt], custom_dparams.get(dt, {}),
                             skip_keys=skip_keys))
              for dt in constants.DISK_TEMPLATES)


111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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


128
129
130
131
132
133
134
135
136
137
138
def UpgradeBeParams(target):
  """Update the be parameters dict to the new format.

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

  """
  if constants.BE_MEMORY in target:
    memory = target[constants.BE_MEMORY]
    target[constants.BE_MAXMEM] = memory
    target[constants.BE_MINMEM] = memory
139
    del target[constants.BE_MEMORY]
140
141


142
143
144
145
146
147
def UpgradeDiskParams(diskparams):
  """Upgrade the disk parameters.

  @type diskparams: dict
  @param diskparams: disk parameters to upgrade
  @rtype: dict
148
  @return: the upgraded disk parameters dict
149
150

  """
151
152
  if not diskparams:
    result = {}
153
  else:
154
    result = FillDiskParams(constants.DISK_DT_DEFAULTS, diskparams)
155
156
157
158

  return result


Iustin Pop's avatar
Iustin Pop committed
159
160
161
162
163
164
165
166
167
168
169
170
def UpgradeNDParams(ndparams):
  """Upgrade ndparams structure.

  @type ndparams: dict
  @param ndparams: disk parameters to upgrade
  @rtype: dict
  @return: the upgraded node parameters dict

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

171
172
173
174
  if (constants.ND_OOB_PROGRAM in ndparams and
      ndparams[constants.ND_OOB_PROGRAM] is None):
    # will be reset by the line below
    del ndparams[constants.ND_OOB_PROGRAM]
Iustin Pop's avatar
Iustin Pop committed
175
176
177
  return FillDict(constants.NDC_DEFAULTS, ndparams)


178
179
180
181
def MakeEmptyIPolicy():
  """Create empty IPolicy dictionary.

  """
182
  return {}
183
184


185
class ConfigObject(outils.ValidatedSlots):
Iustin Pop's avatar
Iustin Pop committed
186
187
188
189
190
191
192
193
194
  """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
195
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
196
197
198
199
200

  """
  __slots__ = []

  def __getattr__(self, name):
201
    if name not in self.GetAllSlots():
202
203
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
204
205
206
    return None

  def __setstate__(self, state):
207
    slots = self.GetAllSlots()
Iustin Pop's avatar
Iustin Pop committed
208
    for name in state:
209
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
210
211
        setattr(self, name, state[name])

212
213
  def Validate(self):
    """Validates the slots.
214
215

    """
216

217
  def ToDict(self, _with_private=False):
218
219
220
221
222
223
224
225
    """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.

226
227
228
229
230
231
232
233
234
    Private fields can be included or not with the _with_private switch.
    The actual implementation of this switch is left for those subclassses
    with private fields to implement.

    @type _with_private: bool
    @param _with_private: if True, the object will leak its private fields in
                          the dictionary representation. If False, the values
                          will be replaced with None.

235
    """
236
    result = {}
237
    for name in self.GetAllSlots():
238
239
240
241
242
243
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

  @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))
261
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
262
    obj = cls(**val_str) # pylint: disable=W0142
263
264
    return obj

265
266
267
268
269
270
271
272
  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

273
274
275
276
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

277
278
279
280
  def __eq__(self, other):
    """Implement __eq__ for ConfigObjects."""
    return isinstance(other, self.__class__) and self.ToDict() == other.ToDict()

281
282
283
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

284
285
    This method will be called at configuration load time, and its
    implementation will be object dependent.
286
287
288
289

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
290

291
class TaggableObject(ConfigObject):
292
293
294
  """An generic class supporting tags.

  """
Balazs Lecz's avatar
Balazs Lecz committed
295
  __slots__ = ["tags"]
Michele Tartara's avatar
Michele Tartara committed
296
  VALID_TAG_RE = re.compile(r"^[\w.+*/:@-]+$")
Iustin Pop's avatar
Iustin Pop committed
297

Iustin Pop's avatar
Iustin Pop committed
298
299
  @classmethod
  def ValidateTag(cls, tag):
300
301
302
303
304
305
306
    """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):
307
      raise errors.TagError("Invalid tag type (not a string)")
308
    if len(tag) > constants.MAX_TAG_LEN:
309
310
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
311
    if not tag:
312
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
313
    if not cls.VALID_TAG_RE.match(tag):
314
      raise errors.TagError("Tag contains invalid characters")
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331

  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:
332
      raise errors.TagError("Too many tags")
333
334
335
336
337
338
339
340
341
342
343
    self.GetTags().add(tag)

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

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

346
  def ToDict(self, _with_private=False):
347
348
349
350
351
    """Taggable-object-specific conversion to standard python types.

    This replaces the tags set with a list.

    """
352
    bo = super(TaggableObject, self).ToDict(_with_private=_with_private)
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368

    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

369

370
371
372
class MasterNetworkParameters(ConfigObject):
  """Network configuration parameters for the master

Thomas Thrainer's avatar
Thomas Thrainer committed
373
  @ivar uuid: master nodes UUID
374
375
376
377
378
379
380
  @ivar ip: master IP
  @ivar netmask: master netmask
  @ivar netdev: master network device
  @ivar ip_family: master IP family

  """
  __slots__ = [
Thomas Thrainer's avatar
Thomas Thrainer committed
381
    "uuid",
382
383
384
    "ip",
    "netmask",
    "netdev",
385
    "ip_family",
386
387
388
    ]


Iustin Pop's avatar
Iustin Pop committed
389
390
class ConfigData(ConfigObject):
  """Top-level config object."""
391
392
393
394
395
396
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
397
    "networks",
398
399
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
400

401
  def ToDict(self, _with_private=False):
402
403
404
405
406
407
    """Custom function for top-level config data.

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

    """
408
    mydict = super(ConfigData, self).ToDict(_with_private=_with_private)
409
    mydict["cluster"] = mydict["cluster"].ToDict()
410
    for key in "nodes", "instances", "nodegroups", "networks":
Iustin Pop's avatar
Iustin Pop committed
411
      mydict[key] = outils.ContainerToDicts(mydict[key])
412
413
414
415
416
417
418
419
420
421

    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)
Iustin Pop's avatar
Iustin Pop committed
422
    obj.nodes = outils.ContainerFromDicts(obj.nodes, dict, Node)
423
    obj.instances = \
Iustin Pop's avatar
Iustin Pop committed
424
      outils.ContainerFromDicts(obj.instances, dict, Instance)
425
    obj.nodegroups = \
Iustin Pop's avatar
Iustin Pop committed
426
427
      outils.ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
    obj.networks = outils.ContainerFromDicts(obj.networks, dict, Network)
428
429
    return obj

430
431
432
  def HasAnyDiskOfType(self, dev_type):
    """Check if in there is at disk of the given type in the configuration.

433
    @type dev_type: L{constants.DTS_BLOCK}
434
435
436
437
438
439
440
441
442
443
444
    @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

445
446
447
448
449
450
451
452
453
  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()
454
    self._UpgradeEnabledDiskTemplates()
455
456
457
458
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
459
460
      InstancePolicy.UpgradeDiskTemplates(
        nodegroup.ipolicy, self.cluster.enabled_disk_templates)
461
    if self.cluster.drbd_usermode_helper is None:
Helga Velroyen's avatar
Helga Velroyen committed
462
      if self.cluster.IsDiskTemplateEnabled(constants.DT_DRBD8):
463
        self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER
464
465
    if self.networks is None:
      self.networks = {}
466
467
    for network in self.networks.values():
      network.UpgradeConfig()
468

469
470
471
  def _UpgradeEnabledDiskTemplates(self):
    """Upgrade the cluster's enabled disk templates by inspecting the currently
       enabled and/or used disk templates.
472
473

    """
474
475
476
477
    if not self.cluster.enabled_disk_templates:
      template_set = \
        set([inst.disk_template for inst in self.instances.values()])
      # Add drbd and plain, if lvm is enabled (by specifying a volume group)
478
      if self.cluster.volume_group_name:
479
480
481
        template_set.add(constants.DT_DRBD8)
        template_set.add(constants.DT_PLAIN)
      # Set enabled_disk_templates to the inferred disk templates. Order them
482
      # according to a preference list that is based on Ganeti's history of
483
484
485
486
487
488
489
      # supported disk templates.
      self.cluster.enabled_disk_templates = []
      for preferred_template in constants.DISK_TEMPLATE_PREFERENCE:
        if preferred_template in template_set:
          self.cluster.enabled_disk_templates.append(preferred_template)
          template_set.remove(preferred_template)
      self.cluster.enabled_disk_templates.extend(list(template_set))
490
491
    InstancePolicy.UpgradeDiskTemplates(
      self.cluster.ipolicy, self.cluster.enabled_disk_templates)
492

Iustin Pop's avatar
Iustin Pop committed
493
494
495

class NIC(ConfigObject):
  """Config object representing a network card."""
496
497
  __slots__ = ["name", "mac", "ip", "network",
               "nicparams", "netinfo", "pci"] + _UUID
Iustin Pop's avatar
Iustin Pop committed
498

Guido Trotter's avatar
Guido Trotter committed
499
500
501
502
503
504
505
506
507
  @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

    """
508
509
510
511
    mode = nicparams[constants.NIC_MODE]
    if (mode not in constants.NIC_VALID_MODES and
        mode != constants.VALUE_AUTO):
      raise errors.ConfigurationError("Invalid NIC mode '%s'" % mode)
Guido Trotter's avatar
Guido Trotter committed
512

513
    if (mode == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
514
        not nicparams[constants.NIC_LINK]):
515
      raise errors.ConfigurationError("Missing bridged NIC link")
Guido Trotter's avatar
Guido Trotter committed
516

Iustin Pop's avatar
Iustin Pop committed
517
518
519

class Disk(ConfigObject):
  """Config object representing a block device."""
520
  __slots__ = (["name", "dev_type", "logical_id", "children", "iv_name",
521
                "size", "mode", "params", "spindles", "pci"] + _UUID +
522
523
524
               # dynamic_params is special. It depends on the node this instance
               # is sent to, and should not be persisted.
               ["dynamic_params"])
Iustin Pop's avatar
Iustin Pop committed
525
526
527

  def CreateOnSecondary(self):
    """Test if this device needs to be created on a secondary node."""
528
    return self.dev_type in (constants.DT_DRBD8, constants.DT_PLAIN)
Iustin Pop's avatar
Iustin Pop committed
529
530
531

  def AssembleOnSecondary(self):
    """Test if this device needs to be assembled on a secondary node."""
532
    return self.dev_type in (constants.DT_DRBD8, constants.DT_PLAIN)
Iustin Pop's avatar
Iustin Pop committed
533
534
535

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

538
539
540
541
542
543
544
  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.

545
546
547
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

548
    """
549
    if self.dev_type == constants.DT_PLAIN:
550
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
551
    elif self.dev_type == constants.DT_BLOCK:
552
      return self.logical_id[1]
553
    elif self.dev_type == constants.DT_RBD:
554
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
555
556
    return None

557
558
559
560
561
562
563
564
565
566
567
568
  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.

    """
569
    if self.dev_type == constants.DT_DRBD8:
570
571
572
      return 0
    return -1

573
574
575
  def IsBasedOnDiskType(self, dev_type):
    """Check if the disk or its children are based on the given type.

576
    @type dev_type: L{constants.DTS_BLOCK}
577
578
579
580
581
582
583
584
585
586
587
    @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

Thomas Thrainer's avatar
Thomas Thrainer committed
588
  def GetNodes(self, node_uuid):
Iustin Pop's avatar
Iustin Pop committed
589
590
591
592
593
594
595
596
    """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.

    """
597
598
    if self.dev_type in [constants.DT_PLAIN, constants.DT_FILE,
                         constants.DT_BLOCK, constants.DT_RBD,
Santi Raffa's avatar
Santi Raffa committed
599
600
                         constants.DT_EXT, constants.DT_SHARED_FILE,
                         constants.DT_GLUSTER]:
Thomas Thrainer's avatar
Thomas Thrainer committed
601
      result = [node_uuid]
Helga Velroyen's avatar
Helga Velroyen committed
602
    elif self.dev_type in constants.DTS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
603
      result = [self.logical_id[0], self.logical_id[1]]
Thomas Thrainer's avatar
Thomas Thrainer committed
604
      if node_uuid not in result:
605
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
606
    else:
607
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
608
609
    return result

Thomas Thrainer's avatar
Thomas Thrainer committed
610
  def ComputeNodeTree(self, parent_node_uuid):
Iustin Pop's avatar
Iustin Pop committed
611
612
613
    """Compute the node/disk tree for this disk and its children.

    This method, given the node on which the parent disk lives, will
Thomas Thrainer's avatar
Thomas Thrainer committed
614
    return the list of all (node UUID, disk) pairs which describe the disk
615
616
617
    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
618
619

    """
Thomas Thrainer's avatar
Thomas Thrainer committed
620
    my_nodes = self.GetNodes(parent_node_uuid)
Iustin Pop's avatar
Iustin Pop committed
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
    result = [(node, self) for node in my_nodes]
    if not self.children:
      # leaf device
      return result
    for node in my_nodes:
      for child in self.children:
        child_result = child.ComputeNodeTree(node)
        if len(child_result) == 1:
          # child (and all its descendants) is simple, doesn't split
          # over multiple hosts, so we don't need to describe it, our
          # own entry for this node describes it completely
          continue
        else:
          # check if child nodes differ from my nodes; note that
          # subdisk can differ from the child itself, and be instead
          # one of its descendants
          for subnode, subdisk in child_result:
            if subnode not in my_nodes:
              result.append((subnode, subdisk))
            # otherwise child is under our own node, so we ignore this
            # entry (but probably the other results in the list will
            # be different)
    return result

Iustin Pop's avatar
Iustin Pop committed
645
646
647
648
649
650
651
652
653
654
655
  def ComputeGrowth(self, amount):
    """Compute the per-VG growth requirements.

    This only works for VG-based disks.

    @type amount: integer
    @param amount: the desired increase in (user-visible) disk space
    @rtype: dict
    @return: a dictionary of volume-groups and the required size

    """
656
    if self.dev_type == constants.DT_PLAIN:
Iustin Pop's avatar
Iustin Pop committed
657
      return {self.logical_id[0]: amount}
658
    elif self.dev_type == constants.DT_DRBD8:
Iustin Pop's avatar
Iustin Pop committed
659
660
661
662
663
664
665
666
      if self.children:
        return self.children[0].ComputeGrowth(amount)
      else:
        return {}
    else:
      # Other disk types do not require VG space
      return {}

667
668
669
670
671
672
673
674
  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.

    """
675
676
    if self.dev_type in (constants.DT_PLAIN, constants.DT_FILE,
                         constants.DT_RBD, constants.DT_EXT,
Santi Raffa's avatar
Santi Raffa committed
677
                         constants.DT_SHARED_FILE, constants.DT_GLUSTER):
678
      self.size += amount
679
    elif self.dev_type == constants.DT_DRBD8:
680
681
682
683
684
685
686
      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)

687
688
  def Update(self, size=None, mode=None, spindles=None):
    """Apply changes to size, spindles and mode.
689
690

    """
691
    if self.dev_type == constants.DT_DRBD8:
692
693
694
695
696
697
698
699
700
      if self.children:
        self.children[0].Update(size=size, mode=mode)
    else:
      assert not self.children

    if size is not None:
      self.size = size
    if mode is not None:
      self.mode = mode
701
702
    if spindles is not None:
      self.spindles = spindles
703

704
705
706
707
708
709
710
711
712
  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

713
714
  def UpdateDynamicDiskParams(self, target_node_uuid, nodes_ip):
    """Updates the dynamic disk params for the given node.
715

716
    This is mainly used for drbd, which needs ip/port configuration.
717
718

    Arguments:
Thomas Thrainer's avatar
Thomas Thrainer committed
719
      - target_node_uuid: the node UUID we wish to configure for
720
721
      - nodes_ip: a mapping of node name to ip

722
723
    The target_node must exist in nodes_ip, and should be one of the
    nodes in the logical ID if this device is a DRBD device.
724
725
726
727

    """
    if self.children:
      for child in self.children:
728
        child.UpdateDynamicDiskParams(target_node_uuid, nodes_ip)
729

730
    dyn_disk_params = {}
731
    if self.logical_id is not None and self.dev_type in constants.DTS_DRBD:
732
      pnode_uuid, snode_uuid, _, pminor, sminor, _ = self.logical_id
Thomas Thrainer's avatar
Thomas Thrainer committed
733
      if target_node_uuid not in (pnode_uuid, snode_uuid):
734
735
736
737
738
739
        # disk object is being sent to neither the primary nor the secondary
        # node. reset the dynamic parameters, the target node is not
        # supposed to use them.
        self.dynamic_params = dyn_disk_params
        return

Thomas Thrainer's avatar
Thomas Thrainer committed
740
741
      pnode_ip = nodes_ip.get(pnode_uuid, None)
      snode_ip = nodes_ip.get(snode_uuid, None)
742
743
744
      if pnode_ip is None or snode_ip is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(self))
Thomas Thrainer's avatar
Thomas Thrainer committed
745
      if pnode_uuid == target_node_uuid:
746
747
748
749
        dyn_disk_params[constants.DDP_LOCAL_IP] = pnode_ip
        dyn_disk_params[constants.DDP_REMOTE_IP] = snode_ip
        dyn_disk_params[constants.DDP_LOCAL_MINOR] = pminor
        dyn_disk_params[constants.DDP_REMOTE_MINOR] = sminor
750
      else: # it must be secondary, we tested above
751
752
753
754
755
756
        dyn_disk_params[constants.DDP_LOCAL_IP] = snode_ip
        dyn_disk_params[constants.DDP_REMOTE_IP] = pnode_ip
        dyn_disk_params[constants.DDP_LOCAL_MINOR] = sminor
        dyn_disk_params[constants.DDP_REMOTE_MINOR] = pminor

    self.dynamic_params = dyn_disk_params
757

758
  # pylint: disable=W0221
759
760
  def ToDict(self, include_dynamic_params=False,
             _with_private=False):
761
762
763
764
765
766
767
    """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()
768
769
    if not include_dynamic_params and "dynamic_params" in bo:
      del bo["dynamic_params"]
770
771
772
773

    for attr in ("children",):
      alist = bo.get(attr, None)
      if alist:
Iustin Pop's avatar
Iustin Pop committed
774
        bo[attr] = outils.ContainerToDicts(alist)
775
776
777
778
779
780
781
782
783
    return bo

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

    """
    obj = super(Disk, cls).FromDict(val)
    if obj.children:
Iustin Pop's avatar
Iustin Pop committed
784
      obj.children = outils.ContainerFromDicts(obj.children, list, Disk)
785
786
    if obj.logical_id and isinstance(obj.logical_id, list):
      obj.logical_id = tuple(obj.logical_id)
Helga Velroyen's avatar
Helga Velroyen committed
787
    if obj.dev_type in constants.DTS_DRBD:
788
789
790
      # we need a tuple of length six here
      if len(obj.logical_id) < 6:
        obj.logical_id += (None,) * (6 - len(obj.logical_id))
791
792
    return obj

793
794
795
796
  def __str__(self):
    """Custom str() formatter for disks.

    """
797
    if self.dev_type == constants.DT_PLAIN:
Michael Hanselmann's avatar
Michael Hanselmann committed
798
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
Helga Velroyen's avatar
Helga Velroyen committed
799
    elif self.dev_type in constants.DTS_DRBD:
800
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
801
      val = "<DRBD8("
802

803
804
      val += ("hosts=%s/%d-%s/%d, port=%s, " %
              (node_a, minor_a, node_b, minor_b, port))
805
806
807
808
809
      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:
810
811
      val = ("<Disk(type=%s, logical_id=%s, children=%s" %
             (self.dev_type, self.logical_id, self.children))
812
813
814
815
    if self.iv_name is None:
      val += ", not visible"
    else:
      val += ", visible as /dev/%s" % self.iv_name
816
817
    if self.spindles is not None:
      val += ", spindles=%s" % self.spindles
Iustin Pop's avatar
Iustin Pop committed
818
819
820
821
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
822
823
    return val

824
825
826
827
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
828
    all_errors = []
829
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
830
831
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
832

833
834
835
836
837
838
839
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.children:
      for child in self.children:
        child.UpgradeConfig()
840

841
    # FIXME: Make this configurable in Ganeti 2.7
842
843
844
845
846
847
    # Params should be an empty dict that gets filled any time needed
    # In case of ext template we allow arbitrary params that should not
    # be overrided during a config reload/upgrade.
    if not self.params or not isinstance(self.params, dict):
      self.params = {}

848
849
    # add here config upgrade for this disk

850
851
852
853
854
855
    # map of legacy device types (mapping differing LD constants to new
    # DT constants)
    LEG_DEV_TYPE_MAP = {"lvm": constants.DT_PLAIN, "drbd8": constants.DT_DRBD8}
    if self.dev_type in LEG_DEV_TYPE_MAP:
      self.dev_type = LEG_DEV_TYPE_MAP[self.dev_type]

856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
  @staticmethod
  def ComputeLDParams(disk_template, disk_params):
    """Computes Logical Disk parameters from Disk Template parameters.

    @type disk_template: string
    @param disk_template: disk template, one of L{constants.DISK_TEMPLATES}
    @type disk_params: dict
    @param disk_params: disk template parameters;
                        dict(template_name -> parameters
    @rtype: list(dict)
    @return: a list of dicts, one for each node of the disk hierarchy. Each dict
      contains the LD parameters of the node. The tree is flattened in-order.

    """
    if disk_template not in constants.DISK_TEMPLATES:
      raise errors.ProgrammerError("Unknown disk template %s" % disk_template)

    assert disk_template in disk_params

    result = list()
    dt_params = disk_params[disk_template]
877

878
    if disk_template == constants.DT_DRBD8:
879
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.DT_DRBD8], {
880
881
882
883
884
885
        constants.LDP_RESYNC_RATE: dt_params[constants.DRBD_RESYNC_RATE],
        constants.LDP_BARRIERS: dt_params[constants.DRBD_DISK_BARRIERS],
        constants.LDP_NO_META_FLUSH: dt_params[constants.DRBD_META_BARRIERS],
        constants.LDP_DEFAULT_METAVG: dt_params[constants.DRBD_DEFAULT_METAVG],
        constants.LDP_DISK_CUSTOM: dt_params[constants.DRBD_DISK_CUSTOM],
        constants.LDP_NET_CUSTOM: dt_params[constants.DRBD_NET_CUSTOM],
886
        constants.LDP_PROTOCOL: dt_params[constants.DRBD_PROTOCOL],
887
888
889
890
891
892
        constants.LDP_DYNAMIC_RESYNC: dt_params[constants.DRBD_DYNAMIC_RESYNC],
        constants.LDP_PLAN_AHEAD: dt_params[constants.DRBD_PLAN_AHEAD],
        constants.LDP_FILL_TARGET: dt_params[constants.DRBD_FILL_TARGET],
        constants.LDP_DELAY_TARGET: dt_params[constants.DRBD_DELAY_TARGET],
        constants.LDP_MAX_RATE: dt_params[constants.DRBD_MAX_RATE],
        constants.LDP_MIN_RATE: dt_params[constants.DRBD_MIN_RATE],
893
        }))
894
895

      # data LV
896
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.DT_PLAIN], {
897
        constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES],
898
        }))
899
900

      # metadata LV
901
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.DT_PLAIN], {
902
        constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES],
903
904
        }))

905
906
907
908
909
910
    else:
      defaults = constants.DISK_LD_DEFAULTS[disk_template]
      values = {}
      for field in defaults:
        values[field] = dt_params[field]
      result.append(FillDict(defaults, values))
911

912
913
    return result

Iustin Pop's avatar
Iustin Pop committed
914

915
class InstancePolicy(ConfigObject):
916
  """Config object representing instance policy limits dictionary.
917

918
919
920
921
  Note that this object is not actually used in the config, it's just
  used as a placeholder for a few functions.

  """
922
923
924
925
926
927
928
929
930
  @classmethod
  def UpgradeDiskTemplates(cls, ipolicy, enabled_disk_templates):
    """Upgrades the ipolicy configuration."""
    if constants.IPOLICY_DTS in ipolicy:
      if not set(ipolicy[constants.IPOLICY_DTS]).issubset(
        set(enabled_disk_templates)):
        ipolicy[constants.IPOLICY_DTS] = list(
          set(ipolicy[constants.IPOLICY_DTS]) & set(enabled_disk_templates))

931
  @classmethod
932
  def CheckParameterSyntax(cls, ipolicy, check_std):
933
934
    """ Check the instance policy for validity.

935
936
937
938
939
940
    @type ipolicy: dict
    @param ipolicy: dictionary with min/max/std specs and policies
    @type check_std: bool
    @param check_std: Whether to check std value or just assume compliance
    @raise errors.ConfigurationError: when the policy is not legal

941
    """
942
    InstancePolicy.CheckISpecSyntax(ipolicy, check_std)
943
944
    if constants.IPOLICY_DTS in ipolicy:
      InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS])
945
946
947
    for key in constants.IPOLICY_PARAMETERS:
      if key in ipolicy:
        InstancePolicy.CheckParameter(key, ipolicy[key])
948
949
950
951
    wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
    if wrong_keys:
      raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
                                      utils.CommaJoin(wrong_keys))
952

953
954
955
956
957
958
959
960
  @classmethod
  def _CheckIncompleteSpec(cls, spec, keyname):
    missing_params = constants.ISPECS_PARAMETERS - frozenset(spec.keys())
    if missing_params:
      msg = ("Missing instance specs parameters for %s: %s" %
             (keyname, utils.CommaJoin(missing_params)))
      raise errors.ConfigurationError(msg)

961
  @classmethod
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
  def CheckISpecSyntax(cls, ipolicy, check_std):
    """Check the instance policy specs for validity.

    @type ipolicy: dict
    @param ipolicy: dictionary with min/max/std specs
    @type check_std: bool
    @param check_std: Whether to check std value or just assume compliance
    @raise errors.ConfigurationError: when specs are not valid

    """
    if constants.ISPECS_MINMAX not in ipolicy:
      # Nothing to check
      return

    if check_std and constants.ISPECS_STD not in ipolicy:
      msg = "Missing key in ipolicy: %s" % constants.ISPECS_STD
      raise errors.ConfigurationError(msg)
    stdspec = ipolicy.get(constants.ISPECS_STD)
980
981
982
    if check_std:
      InstancePolicy._CheckIncompleteSpec(stdspec, constants.ISPECS_STD)

983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
    if not ipolicy[constants.ISPECS_MINMAX]:
      raise errors.ConfigurationError("Empty minmax specifications")
    std_is_good = False
    for minmaxspecs in ipolicy[constants.ISPECS_MINMAX]:
      missing = constants.ISPECS_MINMAX_KEYS - frozenset(minmaxspecs.keys())
      if missing:
        msg = "Missing instance specification: %s" % utils.CommaJoin(missing)
        raise errors.ConfigurationError(msg)
      for (key, spec) in minmaxspecs.items():
        InstancePolicy._CheckIncompleteSpec(spec, key)

      spec_std_ok = True
      for param in constants.ISPECS_PARAMETERS:
        par_std_ok = InstancePolicy._CheckISpecParamSyntax(minmaxspecs, stdspec,
                                                           param, check_std)
        spec_std_ok = spec_std_ok and par_std_ok
      std_is_good = std_is_good or spec_std_ok
    if not std_is_good:
1001
      raise errors.ConfigurationError("Invalid std specifications")
1002
1003
1004

  @classmethod
  def _CheckISpecParamSyntax(cls, minmaxspecs, stdspec, name, check_std):
1005
    """Check the instance policy specs for validity on a given key.
1006

1007
1008
    We check if the instance specs makes sense for a given key, that is
    if minmaxspecs[min][name] <= stdspec[name] <= minmaxspec[max][name].
1009

1010
1011
1012
1013
    @type minmaxspecs: dict
    @param minmaxspecs: dictionary with min and max instance spec
    @type stdspec: dict
    @param stdspec: dictionary with standard instance spec
1014
1015
    @type name: string
    @param name: what are the limits for
1016
1017
    @type check_std: bool
    @param check_std: Whether to check std value or just assume compliance
1018
1019
1020
1021
1022
    @rtype: bool
    @return: C{True} when specs are valid, C{False} when standard spec for the
        given name is not valid
    @raise errors.ConfigurationError: when min/max specs for the given name
        are not valid
1023
1024

    """
1025
1026
    minspec = minmaxspecs[constants.ISPECS_MIN]
    maxspec = minmaxspecs[constants.ISPECS_MAX]
1027
    min_v = minspec[name]
1028
    max_v = maxspec[name]
1029

1030
1031
1032
1033
1034
    if min_v > max_v:
      err = ("Invalid specification of min/max values for %s: %s/%s" %
             (name, min_v, max_v))
      raise errors.ConfigurationError(err)
    elif check_std:
1035
      std_v = stdspec.get(name, min_v)
1036
      return std_v >= min_v and std_v <= max_v
1037
    else:
1038
      return True
1039

1040
1041
1042
1043
1044
  @classmethod
  def CheckDiskTemplates(cls, disk_templates):
    """Checks the disk templates for validity.

    """
1045
1046
1047
    if not disk_templates:
      raise errors.ConfigurationError("Instance policy must contain" +
                                      " at least one disk template")
1048
1049
1050
1051
1052
    wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
    if wrong:
      raise errors.ConfigurationError("Invalid disk template(s) %s" %
                                      utils.CommaJoin(wrong))

1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
  @classmethod
  def CheckParameter(cls, key, value):
    """Checks a parameter.

    Currently we expect all parameters to be float values.

    """
    try:
      float(value)
    except (TypeError, ValueError), err:
      raise errors.ConfigurationError("Invalid value for key" " '%s':"
                                      " '%s', error: %s" % (key, value, err))

1066

1067
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1068
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
1069
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1070
1071
1072
    "name",
    "primary_node",
    "os",
1073
    "hypervisor",
1074
1075
    "hvparams",
    "beparams",
1076
    "osparams",
1077
    "osparams_private",
1078
    "admin_state",
Iustin Pop's avatar
Iustin Pop committed
1079
1080
1081
    "nics",
    "disks",
    "disk_template",
1082
    "disks_active",
1083
    "network_port",
1084
    "serial_no",
1085
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1086
1087
1088
1089

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

1090
1091
1092
1093
1094
1095
1096
1097
    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,
1098
                             "List of names of secondary nodes")
1099
1100
1101
1102

  def _ComputeAllNodes(self):
    """Compute the list of all nodes.

Iustin Pop's avatar
Iustin Pop committed
1103
1104
1105
1106
1107
1108
    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.

    """
1109
1110
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
Helga Velroyen's avatar
Helga Velroyen committed
1111
      if device.dev_type in constants.DTS_DRBD:
1112
1113
1114
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
1115
1116
      if device.children:
        for child in device.children:
1117
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
1118

1119
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
1120
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
1121
    for device in self.disks:
1122
1123
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
1124

1125
  all_nodes = property(_ComputeAllNodes, None, None,
1126
                       "List of names of all the nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
1127

Thomas Thrainer's avatar
Thomas Thrainer committed
1128
  def MapLVsByNode(self, lvmap=None, devs=None, node_uuid=None):
Iustin Pop's avatar
Iustin Pop committed
1129
1130
    """Provide a mapping of nodes to LVs this instance owns.

Iustin Pop's avatar
Iustin Pop committed
1131
1132
    This function figures out what logical volumes should belong on
    which nodes, recursing through a device tree.
Iustin Pop's avatar
Iustin Pop committed
1133

Thomas Thrainer's avatar
Thomas Thrainer committed
1134
    @type lvmap: dict
Iustin Pop's avatar
Iustin Pop committed
1135
1136
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Thomas Thrainer's avatar
Thomas Thrainer committed
1137
1138
1139
1140
1141
1142
    @type devs: list of L{Disk}
    @param devs: disks to get the LV name for. If None, all disk of this
        instance are used.
    @type node_uuid: string
    @param node_uuid: UUID of the node to get the LV names for. If None, the
        primary node of this instance is used.
1143
    @return: None if lvmap arg is given, otherwise, a dictionary of
Thomas Thrainer's avatar
Thomas Thrainer committed
1144
        the form { 'node_uuid' : ['volume1', 'volume2', ...], ... };
1145
1146
        volumeN is of the form "vg_name/lv_name", compatible with
        GetVolumeList()
Iustin Pop's avatar
Iustin Pop committed
1147
1148

    """
Thomas Thrainer's avatar
Thomas Thrainer committed
1149
1150
    if node_uuid is None:
      node_uuid = self.primary_node
Iustin Pop's avatar
Iustin Pop committed
1151
1152

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1153
      lvmap = {
Thomas Thrainer's avatar
Thomas Thrainer committed
1154
        node_uuid: [],
Michael Hanselmann's avatar
Michael Hanselmann committed
1155
        }
Iustin Pop's avatar
Iustin Pop committed
1156
1157
      ret = lvmap
    else: