code.grnet.gr Git - ganeti-local/blob - lib/config.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Google Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 # 02110-1301, USA.
  20
  21
  22 """Configuration management for Ganeti
  23
  24 This module provides the interface to the Ganeti cluster configuration.
  25
  26 The configuration data is stored on every node but is updated on the master
  27 only. After each update, the master distributes the data to the other nodes.
  28
  29 Currently, the data storage format is JSON. YAML was slow and consuming too
  30 much memory.
  31
  32 """
  33
  34 # pylint: disable-msg=R0904
  35 # R0904: Too many public methods
  36
  37 import os
  38 import random
  39 import logging
  40 import time
  41
  42 from ganeti import errors
  43 from ganeti import locking
  44 from ganeti import utils
  45 from ganeti import constants
  46 from ganeti import rpc
  47 from ganeti import objects
  48 from ganeti import serializer
  49 from ganeti import uidpool
  50 from ganeti import netutils
  51 from ganeti import runtime
  52
  53
  54 _config_lock = locking.SharedLock("ConfigWriter")
  55
  56 # job id used for resource management at config upgrade time
  57 _UPGRADE_CONFIG_JID = "jid-cfg-upgrade"
  58
  59
  60 def _ValidateConfig(data):
  61   """Verifies that a configuration objects looks valid.
  62
  63   This only verifies the version of the configuration.
  64
  65   @raise errors.ConfigurationError: if the version differs from what
  66       we expect
  67
  68   """
  69   if data.version != constants.CONFIG_VERSION:
  70     raise errors.ConfigVersionMismatch(constants.CONFIG_VERSION, data.version)
  71
  72
  73 class TemporaryReservationManager:
  74   """A temporary resource reservation manager.
  75
  76   This is used to reserve resources in a job, before using them, making sure
  77   other jobs cannot get them in the meantime.
  78
  79   """
  80   def __init__(self):
  81     self._ec_reserved = {}
  82
  83   def Reserved(self, resource):
  84     for holder_reserved in self._ec_reserved.values():
  85       if resource in holder_reserved:
  86         return True
  87     return False
  88
  89   def Reserve(self, ec_id, resource):
  90     if self.Reserved(resource):
  91       raise errors.ReservationError("Duplicate reservation for resource '%s'"
  92                                     % str(resource))
  93     if ec_id not in self._ec_reserved:
  94       self._ec_reserved[ec_id] = set([resource])
  95     else:
  96       self._ec_reserved[ec_id].add(resource)
  97
  98   def DropECReservations(self, ec_id):
  99     if ec_id in self._ec_reserved:
 100       del self._ec_reserved[ec_id]
 101
 102   def GetReserved(self):
 103     all_reserved = set()
 104     for holder_reserved in self._ec_reserved.values():
 105       all_reserved.update(holder_reserved)
 106     return all_reserved
 107
 108   def Generate(self, existing, generate_one_fn, ec_id):
 109     """Generate a new resource of this type
 110
 111     """
 112     assert callable(generate_one_fn)
 113
 114     all_elems = self.GetReserved()
 115     all_elems.update(existing)
 116     retries = 64
 117     while retries > 0:
 118       new_resource = generate_one_fn()
 119       if new_resource is not None and new_resource not in all_elems:
 120         break
 121     else:
 122       raise errors.ConfigurationError("Not able generate new resource"
 123                                       " (last tried: %s)" % new_resource)
 124     self.Reserve(ec_id, new_resource)
 125     return new_resource
 126
 127
 128 class ConfigWriter:
 129   """The interface to the cluster configuration.
 130
 131   @ivar _temporary_lvs: reservation manager for temporary LVs
 132   @ivar _all_rms: a list of all temporary reservation managers
 133
 134   """
 135   def __init__(self, cfg_file=None, offline=False, _getents=runtime.GetEnts,
 136                accept_foreign=False):
 137     self.write_count = 0
 138     self._lock = _config_lock
 139     self._config_data = None
 140     self._offline = offline
 141     if cfg_file is None:
 142       self._cfg_file = constants.CLUSTER_CONF_FILE
 143     else:
 144       self._cfg_file = cfg_file
 145     self._getents = _getents
 146     self._temporary_ids = TemporaryReservationManager()
 147     self._temporary_drbds = {}
 148     self._temporary_macs = TemporaryReservationManager()
 149     self._temporary_secrets = TemporaryReservationManager()
 150     self._temporary_lvs = TemporaryReservationManager()
 151     self._all_rms = [self._temporary_ids, self._temporary_macs,
 152                      self._temporary_secrets, self._temporary_lvs]
 153     # Note: in order to prevent errors when resolving our name in
 154     # _DistributeConfig, we compute it here once and reuse it; it's
 155     # better to raise an error before starting to modify the config
 156     # file than after it was modified
 157     self._my_hostname = netutils.Hostname.GetSysName()
 158     self._last_cluster_serial = -1
 159     self._cfg_id = None
 160     self._OpenConfig(accept_foreign)
 161
 162   # this method needs to be static, so that we can call it on the class
 163   @staticmethod
 164   def IsCluster():
 165     """Check if the cluster is configured.
 166
 167     """
 168     return os.path.exists(constants.CLUSTER_CONF_FILE)
 169
 170   def _GenerateOneMAC(self):
 171     """Generate one mac address
 172
 173     """
 174     prefix = self._config_data.cluster.mac_prefix
 175     byte1 = random.randrange(0, 256)
 176     byte2 = random.randrange(0, 256)
 177     byte3 = random.randrange(0, 256)
 178     mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
 179     return mac
 180
 181   @locking.ssynchronized(_config_lock, shared=1)
 182   def GetNdParams(self, node):
 183     """Get the node params populated with cluster defaults.
 184
 185     @type node: L{object.Node}
 186     @param node: The node we want to know the params for
 187     @return: A dict with the filled in node params
 188
 189     """
 190     nodegroup = self._UnlockedGetNodeGroup(node.group)
 191     return self._config_data.cluster.FillND(node, nodegroup)
 192
 193   @locking.ssynchronized(_config_lock, shared=1)
 194   def GenerateMAC(self, ec_id):
 195     """Generate a MAC for an instance.
 196
 197     This should check the current instances for duplicates.
 198
 199     """
 200     existing = self._AllMACs()
 201     return self._temporary_ids.Generate(existing, self._GenerateOneMAC, ec_id)
 202
 203   @locking.ssynchronized(_config_lock, shared=1)
 204   def ReserveMAC(self, mac, ec_id):
 205     """Reserve a MAC for an instance.
 206
 207     This only checks instances managed by this cluster, it does not
 208     check for potential collisions elsewhere.
 209
 210     """
 211     all_macs = self._AllMACs()
 212     if mac in all_macs:
 213       raise errors.ReservationError("mac already in use")
 214     else:
 215       self._temporary_macs.Reserve(mac, ec_id)
 216
 217   @locking.ssynchronized(_config_lock, shared=1)
 218   def ReserveLV(self, lv_name, ec_id):
 219     """Reserve an VG/LV pair for an instance.
 220
 221     @type lv_name: string
 222     @param lv_name: the logical volume name to reserve
 223
 224     """
 225     all_lvs = self._AllLVs()
 226     if lv_name in all_lvs:
 227       raise errors.ReservationError("LV already in use")
 228     else:
 229       self._temporary_lvs.Reserve(lv_name, ec_id)
 230
 231   @locking.ssynchronized(_config_lock, shared=1)
 232   def GenerateDRBDSecret(self, ec_id):
 233     """Generate a DRBD secret.
 234
 235     This checks the current disks for duplicates.
 236
 237     """
 238     return self._temporary_secrets.Generate(self._AllDRBDSecrets(),
 239                                             utils.GenerateSecret,
 240                                             ec_id)
 241
 242   def _AllLVs(self):
 243     """Compute the list of all LVs.
 244
 245     """
 246     lvnames = set()
 247     for instance in self._config_data.instances.values():
 248       node_data = instance.MapLVsByNode()
 249       for lv_list in node_data.values():
 250         lvnames.update(lv_list)
 251     return lvnames
 252
 253   def _AllIDs(self, include_temporary):
 254     """Compute the list of all UUIDs and names we have.
 255
 256     @type include_temporary: boolean
 257     @param include_temporary: whether to include the _temporary_ids set
 258     @rtype: set
 259     @return: a set of IDs
 260
 261     """
 262     existing = set()
 263     if include_temporary:
 264       existing.update(self._temporary_ids.GetReserved())
 265     existing.update(self._AllLVs())
 266     existing.update(self._config_data.instances.keys())
 267     existing.update(self._config_data.nodes.keys())
 268     existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
 269     return existing
 270
 271   def _GenerateUniqueID(self, ec_id):
 272     """Generate an unique UUID.
 273
 274     This checks the current node, instances and disk names for
 275     duplicates.
 276
 277     @rtype: string
 278     @return: the unique id
 279
 280     """
 281     existing = self._AllIDs(include_temporary=False)
 282     return self._temporary_ids.Generate(existing, utils.NewUUID, ec_id)
 283
 284   @locking.ssynchronized(_config_lock, shared=1)
 285   def GenerateUniqueID(self, ec_id):
 286     """Generate an unique ID.
 287
 288     This is just a wrapper over the unlocked version.
 289
 290     @type ec_id: string
 291     @param ec_id: unique id for the job to reserve the id to
 292
 293     """
 294     return self._GenerateUniqueID(ec_id)
 295
 296   def _AllMACs(self):
 297     """Return all MACs present in the config.
 298
 299     @rtype: list
 300     @return: the list of all MACs
 301
 302     """
 303     result = []
 304     for instance in self._config_data.instances.values():
 305       for nic in instance.nics:
 306         result.append(nic.mac)
 307
 308     return result
 309
 310   def _AllDRBDSecrets(self):
 311     """Return all DRBD secrets present in the config.
 312
 313     @rtype: list
 314     @return: the list of all DRBD secrets
 315
 316     """
 317     def helper(disk, result):
 318       """Recursively gather secrets from this disk."""
 319       if disk.dev_type == constants.DT_DRBD8:
 320         result.append(disk.logical_id[5])
 321       if disk.children:
 322         for child in disk.children:
 323           helper(child, result)
 324
 325     result = []
 326     for instance in self._config_data.instances.values():
 327       for disk in instance.disks:
 328         helper(disk, result)
 329
 330     return result
 331
 332   def _CheckDiskIDs(self, disk, l_ids, p_ids):
 333     """Compute duplicate disk IDs
 334
 335     @type disk: L{objects.Disk}
 336     @param disk: the disk at which to start searching
 337     @type l_ids: list
 338     @param l_ids: list of current logical ids
 339     @type p_ids: list
 340     @param p_ids: list of current physical ids
 341     @rtype: list
 342     @return: a list of error messages
 343
 344     """
 345     result = []
 346     if disk.logical_id is not None:
 347       if disk.logical_id in l_ids:
 348         result.append("duplicate logical id %s" % str(disk.logical_id))
 349       else:
 350         l_ids.append(disk.logical_id)
 351     if disk.physical_id is not None:
 352       if disk.physical_id in p_ids:
 353         result.append("duplicate physical id %s" % str(disk.physical_id))
 354       else:
 355         p_ids.append(disk.physical_id)
 356
 357     if disk.children:
 358       for child in disk.children:
 359         result.extend(self._CheckDiskIDs(child, l_ids, p_ids))
 360     return result
 361
 362   def _UnlockedVerifyConfig(self):
 363     """Verify function.
 364
 365     @rtype: list
 366     @return: a list of error messages; a non-empty list signifies
 367         configuration errors
 368
 369     """
 370     # pylint: disable-msg=R0914
 371     result = []
 372     seen_macs = []
 373     ports = {}
 374     data = self._config_data
 375     cluster = data.cluster
 376     seen_lids = []
 377     seen_pids = []
 378
 379     # global cluster checks
 380     if not cluster.enabled_hypervisors:
 381       result.append("enabled hypervisors list doesn't have any entries")
 382     invalid_hvs = set(cluster.enabled_hypervisors) - constants.HYPER_TYPES
 383     if invalid_hvs:
 384       result.append("enabled hypervisors contains invalid entries: %s" %
 385                     invalid_hvs)
 386     missing_hvp = (set(cluster.enabled_hypervisors) -
 387                    set(cluster.hvparams.keys()))
 388     if missing_hvp:
 389       result.append("hypervisor parameters missing for the enabled"
 390                     " hypervisor(s) %s" % utils.CommaJoin(missing_hvp))
 391
 392     if cluster.master_node not in data.nodes:
 393       result.append("cluster has invalid primary node '%s'" %
 394                     cluster.master_node)
 395
 396     def _helper(owner, attr, value, template):
 397       try:
 398         utils.ForceDictType(value, template)
 399       except errors.GenericError, err:
 400         result.append("%s has invalid %s: %s" % (owner, attr, err))
 401
 402     def _helper_nic(owner, params):
 403       try:
 404         objects.NIC.CheckParameterSyntax(params)
 405       except errors.ConfigurationError, err:
 406         result.append("%s has invalid nicparams: %s" % (owner, err))
 407
 408     # check cluster parameters
 409     _helper("cluster", "beparams", cluster.SimpleFillBE({}),
 410             constants.BES_PARAMETER_TYPES)
 411     _helper("cluster", "nicparams", cluster.SimpleFillNIC({}),
 412             constants.NICS_PARAMETER_TYPES)
 413     _helper_nic("cluster", cluster.SimpleFillNIC({}))
 414     _helper("cluster", "ndparams", cluster.SimpleFillND({}),
 415             constants.NDS_PARAMETER_TYPES)
 416
 417     # per-instance checks
 418     for instance_name in data.instances:
 419       instance = data.instances[instance_name]
 420       if instance.name != instance_name:
 421         result.append("instance '%s' is indexed by wrong name '%s'" %
 422                       (instance.name, instance_name))
 423       if instance.primary_node not in data.nodes:
 424         result.append("instance '%s' has invalid primary node '%s'" %
 425                       (instance_name, instance.primary_node))
 426       for snode in instance.secondary_nodes:
 427         if snode not in data.nodes:
 428           result.append("instance '%s' has invalid secondary node '%s'" %
 429                         (instance_name, snode))
 430       for idx, nic in enumerate(instance.nics):
 431         if nic.mac in seen_macs:
 432           result.append("instance '%s' has NIC %d mac %s duplicate" %
 433                         (instance_name, idx, nic.mac))
 434         else:
 435           seen_macs.append(nic.mac)
 436         if nic.nicparams:
 437           filled = cluster.SimpleFillNIC(nic.nicparams)
 438           owner = "instance %s nic %d" % (instance.name, idx)
 439           _helper(owner, "nicparams",
 440                   filled, constants.NICS_PARAMETER_TYPES)
 441           _helper_nic(owner, filled)
 442
 443       # parameter checks
 444       if instance.beparams:
 445         _helper("instance %s" % instance.name, "beparams",
 446                 cluster.FillBE(instance), constants.BES_PARAMETER_TYPES)
 447
 448       # gather the drbd ports for duplicate checks
 449       for dsk in instance.disks:
 450         if dsk.dev_type in constants.LDS_DRBD:
 451           tcp_port = dsk.logical_id[2]
 452           if tcp_port not in ports:
 453             ports[tcp_port] = []
 454           ports[tcp_port].append((instance.name, "drbd disk %s" % dsk.iv_name))
 455       # gather network port reservation
 456       net_port = getattr(instance, "network_port", None)
 457       if net_port is not None:
 458         if net_port not in ports:
 459           ports[net_port] = []
 460         ports[net_port].append((instance.name, "network port"))
 461
 462       # instance disk verify
 463       for idx, disk in enumerate(instance.disks):
 464         result.extend(["instance '%s' disk %d error: %s" %
 465                        (instance.name, idx, msg) for msg in disk.Verify()])
 466         result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
 467
 468     # cluster-wide pool of free ports
 469     for free_port in cluster.tcpudp_port_pool:
 470       if free_port not in ports:
 471         ports[free_port] = []
 472       ports[free_port].append(("cluster", "port marked as free"))
 473
 474     # compute tcp/udp duplicate ports
 475     keys = ports.keys()
 476     keys.sort()
 477     for pnum in keys:
 478       pdata = ports[pnum]
 479       if len(pdata) > 1:
 480         txt = utils.CommaJoin(["%s/%s" % val for val in pdata])
 481         result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))
 482
 483     # highest used tcp port check
 484     if keys:
 485       if keys[-1] > cluster.highest_used_port:
 486         result.append("Highest used port mismatch, saved %s, computed %s" %
 487                       (cluster.highest_used_port, keys[-1]))
 488
 489     if not data.nodes[cluster.master_node].master_candidate:
 490       result.append("Master node is not a master candidate")
 491
 492     # master candidate checks
 493     mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
 494     if mc_now < mc_max:
 495       result.append("Not enough master candidates: actual %d, target %d" %
 496                     (mc_now, mc_max))
 497
 498     # node checks
 499     for node_name, node in data.nodes.items():
 500       if node.name != node_name:
 501         result.append("Node '%s' is indexed by wrong name '%s'" %
 502                       (node.name, node_name))
 503       if [node.master_candidate, node.drained, node.offline].count(True) > 1:
 504         result.append("Node %s state is invalid: master_candidate=%s,"
 505                       " drain=%s, offline=%s" %
 506                       (node.name, node.master_candidate, node.drained,
 507                        node.offline))
 508       if node.group not in data.nodegroups:
 509         result.append("Node '%s' has invalid group '%s'" %
 510                       (node.name, node.group))
 511       else:
 512         _helper("node %s" % node.name, "ndparams",
 513                 cluster.FillND(node, data.nodegroups[node.group]),
 514                 constants.NDS_PARAMETER_TYPES)
 515
 516     # nodegroups checks
 517     nodegroups_names = set()
 518     for nodegroup_uuid in data.nodegroups:
 519       nodegroup = data.nodegroups[nodegroup_uuid]
 520       if nodegroup.uuid != nodegroup_uuid:
 521         result.append("node group '%s' (uuid: '%s') indexed by wrong uuid '%s'"
 522                       % (nodegroup.name, nodegroup.uuid, nodegroup_uuid))
 523       if utils.UUID_RE.match(nodegroup.name.lower()):
 524         result.append("node group '%s' (uuid: '%s') has uuid-like name" %
 525                       (nodegroup.name, nodegroup.uuid))
 526       if nodegroup.name in nodegroups_names:
 527         result.append("duplicate node group name '%s'" % nodegroup.name)
 528       else:
 529         nodegroups_names.add(nodegroup.name)
 530       if nodegroup.ndparams:
 531         _helper("group %s" % nodegroup.name, "ndparams",
 532                 cluster.SimpleFillND(nodegroup.ndparams),
 533                 constants.NDS_PARAMETER_TYPES)
 534
 535
 536     # drbd minors check
 537     _, duplicates = self._UnlockedComputeDRBDMap()
 538     for node, minor, instance_a, instance_b in duplicates:
 539       result.append("DRBD minor %d on node %s is assigned twice to instances"
 540                     " %s and %s" % (minor, node, instance_a, instance_b))
 541
 542     # IP checks
 543     default_nicparams = cluster.nicparams[constants.PP_DEFAULT]
 544     ips = {}
 545
 546     def _AddIpAddress(ip, name):
 547       ips.setdefault(ip, []).append(name)
 548
 549     _AddIpAddress(cluster.master_ip, "cluster_ip")
 550
 551     for node in data.nodes.values():
 552       _AddIpAddress(node.primary_ip, "node:%s/primary" % node.name)
 553       if node.secondary_ip != node.primary_ip:
 554         _AddIpAddress(node.secondary_ip, "node:%s/secondary" % node.name)
 555
 556     for instance in data.instances.values():
 557       for idx, nic in enumerate(instance.nics):
 558         if nic.ip is None:
 559           continue
 560
 561         nicparams = objects.FillDict(default_nicparams, nic.nicparams)
 562         nic_mode = nicparams[constants.NIC_MODE]
 563         nic_link = nicparams[constants.NIC_LINK]
 564
 565         if nic_mode == constants.NIC_MODE_BRIDGED:
 566           link = "bridge:%s" % nic_link
 567         elif nic_mode == constants.NIC_MODE_ROUTED:
 568           link = "route:%s" % nic_link
 569         else:
 570           raise errors.ProgrammerError("NIC mode '%s' not handled" % nic_mode)
 571
 572         _AddIpAddress("%s/%s" % (link, nic.ip),
 573                       "instance:%s/nic:%d" % (instance.name, idx))
 574
 575     for ip, owners in ips.items():
 576       if len(owners) > 1:
 577         result.append("IP address %s is used by multiple owners: %s" %
 578                       (ip, utils.CommaJoin(owners)))
 579
 580     return result
 581
 582   @locking.ssynchronized(_config_lock, shared=1)
 583   def VerifyConfig(self):
 584     """Verify function.
 585
 586     This is just a wrapper over L{_UnlockedVerifyConfig}.
 587
 588     @rtype: list
 589     @return: a list of error messages; a non-empty list signifies
 590         configuration errors
 591
 592     """
 593     return self._UnlockedVerifyConfig()
 594
 595   def _UnlockedSetDiskID(self, disk, node_name):
 596     """Convert the unique ID to the ID needed on the target nodes.
 597
 598     This is used only for drbd, which needs ip/port configuration.
 599
 600     The routine descends down and updates its children also, because
 601     this helps when the only the top device is passed to the remote
 602     node.
 603
 604     This function is for internal use, when the config lock is already held.
 605
 606     """
 607     if disk.children:
 608       for child in disk.children:
 609         self._UnlockedSetDiskID(child, node_name)
 610
 611     if disk.logical_id is None and disk.physical_id is not None:
 612       return
 613     if disk.dev_type == constants.LD_DRBD8:
 614       pnode, snode, port, pminor, sminor, secret = disk.logical_id
 615       if node_name not in (pnode, snode):
 616         raise errors.ConfigurationError("DRBD device not knowing node %s" %
 617                                         node_name)
 618       pnode_info = self._UnlockedGetNodeInfo(pnode)
 619       snode_info = self._UnlockedGetNodeInfo(snode)
 620       if pnode_info is None or snode_info is None:
 621         raise errors.ConfigurationError("Can't find primary or secondary node"
 622                                         " for %s" % str(disk))
 623       p_data = (pnode_info.secondary_ip, port)
 624       s_data = (snode_info.secondary_ip, port)
 625       if pnode == node_name:
 626         disk.physical_id = p_data + s_data + (pminor, secret)
 627       else: # it must be secondary, we tested above
 628         disk.physical_id = s_data + p_data + (sminor, secret)
 629     else:
 630       disk.physical_id = disk.logical_id
 631     return
 632
 633   @locking.ssynchronized(_config_lock)
 634   def SetDiskID(self, disk, node_name):
 635     """Convert the unique ID to the ID needed on the target nodes.
 636
 637     This is used only for drbd, which needs ip/port configuration.
 638
 639     The routine descends down and updates its children also, because
 640     this helps when the only the top device is passed to the remote
 641     node.
 642
 643     """
 644     return self._UnlockedSetDiskID(disk, node_name)
 645
 646   @locking.ssynchronized(_config_lock)
 647   def AddTcpUdpPort(self, port):
 648     """Adds a new port to the available port pool.
 649
 650     """
 651     if not isinstance(port, int):
 652       raise errors.ProgrammerError("Invalid type passed for port")
 653
 654     self._config_data.cluster.tcpudp_port_pool.add(port)
 655     self._WriteConfig()
 656
 657   @locking.ssynchronized(_config_lock, shared=1)
 658   def GetPortList(self):
 659     """Returns a copy of the current port list.
 660
 661     """
 662     return self._config_data.cluster.tcpudp_port_pool.copy()
 663
 664   @locking.ssynchronized(_config_lock)
 665   def AllocatePort(self):
 666     """Allocate a port.
 667
 668     The port will be taken from the available port pool or from the
 669     default port range (and in this case we increase
 670     highest_used_port).
 671
 672     """
 673     # If there are TCP/IP ports configured, we use them first.
 674     if self._config_data.cluster.tcpudp_port_pool:
 675       port = self._config_data.cluster.tcpudp_port_pool.pop()
 676     else:
 677       port = self._config_data.cluster.highest_used_port + 1
 678       if port >= constants.LAST_DRBD_PORT:
 679         raise errors.ConfigurationError("The highest used port is greater"
 680                                         " than %s. Aborting." %
 681                                         constants.LAST_DRBD_PORT)
 682       self._config_data.cluster.highest_used_port = port
 683
 684     self._WriteConfig()
 685     return port
 686
 687   def _UnlockedComputeDRBDMap(self):
 688     """Compute the used DRBD minor/nodes.
 689
 690     @rtype: (dict, list)
 691     @return: dictionary of node_name: dict of minor: instance_name;
 692         the returned dict will have all the nodes in it (even if with
 693         an empty list), and a list of duplicates; if the duplicates
 694         list is not empty, the configuration is corrupted and its caller
 695         should raise an exception
 696
 697     """
 698     def _AppendUsedPorts(instance_name, disk, used):
 699       duplicates = []
 700       if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
 701         node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
 702         for node, port in ((node_a, minor_a), (node_b, minor_b)):
 703           assert node in used, ("Node '%s' of instance '%s' not found"
 704                                 " in node list" % (node, instance_name))
 705           if port in used[node]:
 706             duplicates.append((node, port, instance_name, used[node][port]))
 707           else:
 708             used[node][port] = instance_name
 709       if disk.children:
 710         for child in disk.children:
 711           duplicates.extend(_AppendUsedPorts(instance_name, child, used))
 712       return duplicates
 713
 714     duplicates = []
 715     my_dict = dict((node, {}) for node in self._config_data.nodes)
 716     for instance in self._config_data.instances.itervalues():
 717       for disk in instance.disks:
 718         duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
 719     for (node, minor), instance in self._temporary_drbds.iteritems():
 720       if minor in my_dict[node] and my_dict[node][minor] != instance:
 721         duplicates.append((node, minor, instance, my_dict[node][minor]))
 722       else:
 723         my_dict[node][minor] = instance
 724     return my_dict, duplicates
 725
 726   @locking.ssynchronized(_config_lock)
 727   def ComputeDRBDMap(self):
 728     """Compute the used DRBD minor/nodes.
 729
 730     This is just a wrapper over L{_UnlockedComputeDRBDMap}.
 731
 732     @return: dictionary of node_name: dict of minor: instance_name;
 733         the returned dict will have all the nodes in it (even if with
 734         an empty list).
 735
 736     """
 737     d_map, duplicates = self._UnlockedComputeDRBDMap()
 738     if duplicates:
 739       raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
 740                                       str(duplicates))
 741     return d_map
 742
 743   @locking.ssynchronized(_config_lock)
 744   def AllocateDRBDMinor(self, nodes, instance):
 745     """Allocate a drbd minor.
 746
 747     The free minor will be automatically computed from the existing
 748     devices. A node can be given multiple times in order to allocate
 749     multiple minors. The result is the list of minors, in the same
 750     order as the passed nodes.
 751
 752     @type instance: string
 753     @param instance: the instance for which we allocate minors
 754
 755     """
 756     assert isinstance(instance, basestring), \
 757            "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
 758
 759     d_map, duplicates = self._UnlockedComputeDRBDMap()
 760     if duplicates:
 761       raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
 762                                       str(duplicates))
 763     result = []
 764     for nname in nodes:
 765       ndata = d_map[nname]
 766       if not ndata:
 767         # no minors used, we can start at 0
 768         result.append(0)
 769         ndata[0] = instance
 770         self._temporary_drbds[(nname, 0)] = instance
 771         continue
 772       keys = ndata.keys()
 773       keys.sort()
 774       ffree = utils.FirstFree(keys)
 775       if ffree is None:
 776         # return the next minor
 777         # TODO: implement high-limit check
 778         minor = keys[-1] + 1
 779       else:
 780         minor = ffree
 781       # double-check minor against current instances
 782       assert minor not in d_map[nname], \
 783              ("Attempt to reuse allocated DRBD minor %d on node %s,"
 784               " already allocated to instance %s" %
 785               (minor, nname, d_map[nname][minor]))
 786       ndata[minor] = instance
 787       # double-check minor against reservation
 788       r_key = (nname, minor)
 789       assert r_key not in self._temporary_drbds, \
 790              ("Attempt to reuse reserved DRBD minor %d on node %s,"
 791               " reserved for instance %s" %
 792               (minor, nname, self._temporary_drbds[r_key]))
 793       self._temporary_drbds[r_key] = instance
 794       result.append(minor)
 795     logging.debug("Request to allocate drbd minors, input: %s, returning %s",
 796                   nodes, result)
 797     return result
 798
 799   def _UnlockedReleaseDRBDMinors(self, instance):
 800     """Release temporary drbd minors allocated for a given instance.
 801
 802     @type instance: string
 803     @param instance: the instance for which temporary minors should be
 804                      released
 805
 806     """
 807     assert isinstance(instance, basestring), \
 808            "Invalid argument passed to ReleaseDRBDMinors"
 809     for key, name in self._temporary_drbds.items():
 810       if name == instance:
 811         del self._temporary_drbds[key]
 812
 813   @locking.ssynchronized(_config_lock)
 814   def ReleaseDRBDMinors(self, instance):
 815     """Release temporary drbd minors allocated for a given instance.
 816
 817     This should be called on the error paths, on the success paths
 818     it's automatically called by the ConfigWriter add and update
 819     functions.
 820
 821     This function is just a wrapper over L{_UnlockedReleaseDRBDMinors}.
 822
 823     @type instance: string
 824     @param instance: the instance for which temporary minors should be
 825                      released
 826
 827     """
 828     self._UnlockedReleaseDRBDMinors(instance)
 829
 830   @locking.ssynchronized(_config_lock, shared=1)
 831   def GetConfigVersion(self):
 832     """Get the configuration version.
 833
 834     @return: Config version
 835
 836     """
 837     return self._config_data.version
 838
 839   @locking.ssynchronized(_config_lock, shared=1)
 840   def GetClusterName(self):
 841     """Get cluster name.
 842
 843     @return: Cluster name
 844
 845     """
 846     return self._config_data.cluster.cluster_name
 847
 848   @locking.ssynchronized(_config_lock, shared=1)
 849   def GetMasterNode(self):
 850     """Get the hostname of the master node for this cluster.
 851
 852     @return: Master hostname
 853
 854     """
 855     return self._config_data.cluster.master_node
 856
 857   @locking.ssynchronized(_config_lock, shared=1)
 858   def GetMasterIP(self):
 859     """Get the IP of the master node for this cluster.
 860
 861     @return: Master IP
 862
 863     """
 864     return self._config_data.cluster.master_ip
 865
 866   @locking.ssynchronized(_config_lock, shared=1)
 867   def GetMasterNetdev(self):
 868     """Get the master network device for this cluster.
 869
 870     """
 871     return self._config_data.cluster.master_netdev
 872
 873   @locking.ssynchronized(_config_lock, shared=1)
 874   def GetFileStorageDir(self):
 875     """Get the file storage dir for this cluster.
 876
 877     """
 878     return self._config_data.cluster.file_storage_dir
 879
 880   @locking.ssynchronized(_config_lock, shared=1)
 881   def GetHypervisorType(self):
 882     """Get the hypervisor type for this cluster.
 883
 884     """
 885     return self._config_data.cluster.enabled_hypervisors[0]
 886
 887   @locking.ssynchronized(_config_lock, shared=1)
 888   def GetHostKey(self):
 889     """Return the rsa hostkey from the config.
 890
 891     @rtype: string
 892     @return: the rsa hostkey
 893
 894     """
 895     return self._config_data.cluster.rsahostkeypub
 896
 897   @locking.ssynchronized(_config_lock, shared=1)
 898   def GetDefaultIAllocator(self):
 899     """Get the default instance allocator for this cluster.
 900
 901     """
 902     return self._config_data.cluster.default_iallocator
 903
 904   @locking.ssynchronized(_config_lock, shared=1)
 905   def GetPrimaryIPFamily(self):
 906     """Get cluster primary ip family.
 907
 908     @return: primary ip family
 909
 910     """
 911     return self._config_data.cluster.primary_ip_family
 912
 913   @locking.ssynchronized(_config_lock)
 914   def AddNodeGroup(self, group, ec_id, check_uuid=True):
 915     """Add a node group to the configuration.
 916
 917     This method calls group.UpgradeConfig() to fill any missing attributes
 918     according to their default values.
 919
 920     @type group: L{objects.NodeGroup}
 921     @param group: the NodeGroup object to add
 922     @type ec_id: string
 923     @param ec_id: unique id for the job to use when creating a missing UUID
 924     @type check_uuid: bool
 925     @param check_uuid: add an UUID to the group if it doesn't have one or, if
 926                        it does, ensure that it does not exist in the
 927                        configuration already
 928
 929     """
 930     self._UnlockedAddNodeGroup(group, ec_id, check_uuid)
 931     self._WriteConfig()
 932
 933   def _UnlockedAddNodeGroup(self, group, ec_id, check_uuid):
 934     """Add a node group to the configuration.
 935
 936     """
 937     logging.info("Adding node group %s to configuration", group.name)
 938
 939     # Some code might need to add a node group with a pre-populated UUID
 940     # generated with ConfigWriter.GenerateUniqueID(). We allow them to bypass
 941     # the "does this UUID" exist already check.
 942     if check_uuid:
 943       self._EnsureUUID(group, ec_id)
 944
 945     group.serial_no = 1
 946     group.ctime = group.mtime = time.time()
 947     group.UpgradeConfig()
 948
 949     self._config_data.nodegroups[group.uuid] = group
 950     self._config_data.cluster.serial_no += 1
 951
 952   @locking.ssynchronized(_config_lock)
 953   def RemoveNodeGroup(self, group_uuid):
 954     """Remove a node group from the configuration.
 955
 956     @type group_uuid: string
 957     @param group_uuid: the UUID of the node group to remove
 958
 959     """
 960     logging.info("Removing node group %s from configuration", group_uuid)
 961
 962     if group_uuid not in self._config_data.nodegroups:
 963       raise errors.ConfigurationError("Unknown node group '%s'" % group_uuid)
 964
 965     assert len(self._config_data.nodegroups) != 1, \
 966             "Group '%s' is the only group, cannot be removed" % group_uuid
 967
 968     del self._config_data.nodegroups[group_uuid]
 969     self._config_data.cluster.serial_no += 1
 970     self._WriteConfig()
 971
 972   @locking.ssynchronized(_config_lock, shared=1)
 973   def LookupNodeGroup(self, target):
 974     """Lookup a node group's UUID.
 975
 976     @type target: string or None
 977     @param target: group name or UUID or None to look for the default
 978     @rtype: string
 979     @return: nodegroup UUID
 980     @raises errors.OpPrereqError: when the target group cannot be found
 981
 982     """
 983     if target is None:
 984       if len(self._config_data.nodegroups) != 1:
 985         raise errors.OpPrereqError("More than one node group exists. Target"
 986                                    " group must be specified explicitely.")
 987       else:
 988         return self._config_data.nodegroups.keys()[0]
 989     if target in self._config_data.nodegroups:
 990       return target
 991     for nodegroup in self._config_data.nodegroups.values():
 992       if nodegroup.name == target:
 993         return nodegroup.uuid
 994     raise errors.OpPrereqError("Node group '%s' not found" % target,
 995                                errors.ECODE_NOENT)
 996
 997   def _UnlockedGetNodeGroup(self, uuid):
 998     """Lookup a node group.
 999
1000     @type uuid: string
1001     @param uuid: group UUID
1002     @rtype: L{objects.NodeGroup} or None
1003     @return: nodegroup object, or None if not found
1004
1005     """
1006     if uuid not in self._config_data.nodegroups:
1007       return None
1008
1009     return self._config_data.nodegroups[uuid]
1010
1011   @locking.ssynchronized(_config_lock, shared=1)
1012   def GetNodeGroup(self, uuid):
1013     """Lookup a node group.
1014
1015     @type uuid: string
1016     @param uuid: group UUID
1017     @rtype: L{objects.NodeGroup} or None
1018     @return: nodegroup object, or None if not found
1019
1020     """
1021     return self._UnlockedGetNodeGroup(uuid)
1022
1023   @locking.ssynchronized(_config_lock, shared=1)
1024   def GetAllNodeGroupsInfo(self):
1025     """Get the configuration of all node groups.
1026
1027     """
1028     return dict(self._config_data.nodegroups)
1029
1030   @locking.ssynchronized(_config_lock, shared=1)
1031   def GetNodeGroupList(self):
1032     """Get a list of node groups.
1033
1034     """
1035     return self._config_data.nodegroups.keys()
1036
1037   @locking.ssynchronized(_config_lock)
1038   def AddInstance(self, instance, ec_id):
1039     """Add an instance to the config.
1040
1041     This should be used after creating a new instance.
1042
1043     @type instance: L{objects.Instance}
1044     @param instance: the instance object
1045
1046     """
1047     if not isinstance(instance, objects.Instance):
1048       raise errors.ProgrammerError("Invalid type passed to AddInstance")
1049
1050     if instance.disk_template != constants.DT_DISKLESS:
1051       all_lvs = instance.MapLVsByNode()
1052       logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
1053
1054     all_macs = self._AllMACs()
1055     for nic in instance.nics:
1056       if nic.mac in all_macs:
1057         raise errors.ConfigurationError("Cannot add instance %s:"
1058                                         " MAC address '%s' already in use." %
1059                                         (instance.name, nic.mac))
1060
1061     self._EnsureUUID(instance, ec_id)
1062
1063     instance.serial_no = 1
1064     instance.ctime = instance.mtime = time.time()
1065     self._config_data.instances[instance.name] = instance
1066     self._config_data.cluster.serial_no += 1
1067     self._UnlockedReleaseDRBDMinors(instance.name)
1068     self._WriteConfig()
1069
1070   def _EnsureUUID(self, item, ec_id):
1071     """Ensures a given object has a valid UUID.
1072
1073     @param item: the instance or node to be checked
1074     @param ec_id: the execution context id for the uuid reservation
1075
1076     """
1077     if not item.uuid:
1078       item.uuid = self._GenerateUniqueID(ec_id)
1079     elif item.uuid in self._AllIDs(include_temporary=True):
1080       raise errors.ConfigurationError("Cannot add '%s': UUID %s already"
1081                                       " in use" % (item.name, item.uuid))
1082
1083   def _SetInstanceStatus(self, instance_name, status):
1084     """Set the instance's status to a given value.
1085
1086     """
1087     assert isinstance(status, bool), \
1088            "Invalid status '%s' passed to SetInstanceStatus" % (status,)
1089
1090     if instance_name not in self._config_data.instances:
1091       raise errors.ConfigurationError("Unknown instance '%s'" %
1092                                       instance_name)
1093     instance = self._config_data.instances[instance_name]
1094     if instance.admin_up != status:
1095       instance.admin_up = status
1096       instance.serial_no += 1
1097       instance.mtime = time.time()
1098       self._WriteConfig()
1099
1100   @locking.ssynchronized(_config_lock)
1101   def MarkInstanceUp(self, instance_name):
1102     """Mark the instance status to up in the config.
1103
1104     """
1105     self._SetInstanceStatus(instance_name, True)
1106
1107   @locking.ssynchronized(_config_lock)
1108   def RemoveInstance(self, instance_name):
1109     """Remove the instance from the configuration.
1110
1111     """
1112     if instance_name not in self._config_data.instances:
1113       raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
1114     del self._config_data.instances[instance_name]
1115     self._config_data.cluster.serial_no += 1
1116     self._WriteConfig()
1117
1118   @locking.ssynchronized(_config_lock)
1119   def RenameInstance(self, old_name, new_name):
1120     """Rename an instance.
1121
1122     This needs to be done in ConfigWriter and not by RemoveInstance
1123     combined with AddInstance as only we can guarantee an atomic
1124     rename.
1125
1126     """
1127     if old_name not in self._config_data.instances:
1128       raise errors.ConfigurationError("Unknown instance '%s'" % old_name)
1129     inst = self._config_data.instances[old_name]
1130     del self._config_data.instances[old_name]
1131     inst.name = new_name
1132
1133     for disk in inst.disks:
1134       if disk.dev_type == constants.LD_FILE:
1135         # rename the file paths in logical and physical id
1136         file_storage_dir = os.path.dirname(os.path.dirname(disk.logical_id[1]))
1137         disk_fname = "disk%s" % disk.iv_name.split("/")[1]
1138         disk.physical_id = disk.logical_id = (disk.logical_id[0],
1139                                               utils.PathJoin(file_storage_dir,
1140                                                              inst.name,
1141                                                              disk_fname))
1142
1143     # Force update of ssconf files
1144     self._config_data.cluster.serial_no += 1
1145
1146     self._config_data.instances[inst.name] = inst
1147     self._WriteConfig()
1148
1149   @locking.ssynchronized(_config_lock)
1150   def MarkInstanceDown(self, instance_name):
1151     """Mark the status of an instance to down in the configuration.
1152
1153     """
1154     self._SetInstanceStatus(instance_name, False)
1155
1156   def _UnlockedGetInstanceList(self):
1157     """Get the list of instances.
1158
1159     This function is for internal use, when the config lock is already held.
1160
1161     """
1162     return self._config_data.instances.keys()
1163
1164   @locking.ssynchronized(_config_lock, shared=1)
1165   def GetInstanceList(self):
1166     """Get the list of instances.
1167
1168     @return: array of instances, ex. ['instance2.example.com',
1169         'instance1.example.com']
1170
1171     """
1172     return self._UnlockedGetInstanceList()
1173
1174   @locking.ssynchronized(_config_lock, shared=1)
1175   def ExpandInstanceName(self, short_name):
1176     """Attempt to expand an incomplete instance name.
1177
1178     """
1179     return utils.MatchNameComponent(short_name,
1180                                     self._config_data.instances.keys(),
1181                                     case_sensitive=False)
1182
1183   def _UnlockedGetInstanceInfo(self, instance_name):
1184     """Returns information about an instance.
1185
1186     This function is for internal use, when the config lock is already held.
1187
1188     """
1189     if instance_name not in self._config_data.instances:
1190       return None
1191
1192     return self._config_data.instances[instance_name]
1193
1194   @locking.ssynchronized(_config_lock, shared=1)
1195   def GetInstanceInfo(self, instance_name):
1196     """Returns information about an instance.
1197
1198     It takes the information from the configuration file. Other information of
1199     an instance are taken from the live systems.
1200
1201     @param instance_name: name of the instance, e.g.
1202         I{instance1.example.com}
1203
1204     @rtype: L{objects.Instance}
1205     @return: the instance object
1206
1207     """
1208     return self._UnlockedGetInstanceInfo(instance_name)
1209
1210   @locking.ssynchronized(_config_lock, shared=1)
1211   def GetAllInstancesInfo(self):
1212     """Get the configuration of all instances.
1213
1214     @rtype: dict
1215     @return: dict of (instance, instance_info), where instance_info is what
1216               would GetInstanceInfo return for the node
1217
1218     """
1219     my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
1220                     for instance in self._UnlockedGetInstanceList()])
1221     return my_dict
1222
1223   @locking.ssynchronized(_config_lock)
1224   def AddNode(self, node, ec_id):
1225     """Add a node to the configuration.
1226
1227     @type node: L{objects.Node}
1228     @param node: a Node instance
1229
1230     """
1231     logging.info("Adding node %s to configuration", node.name)
1232
1233     self._EnsureUUID(node, ec_id)
1234
1235     node.serial_no = 1
1236     node.ctime = node.mtime = time.time()
1237     self._UnlockedAddNodeToGroup(node.name, node.group)
1238     self._config_data.nodes[node.name] = node
1239     self._config_data.cluster.serial_no += 1
1240     self._WriteConfig()
1241
1242   @locking.ssynchronized(_config_lock)
1243   def RemoveNode(self, node_name):
1244     """Remove a node from the configuration.
1245
1246     """
1247     logging.info("Removing node %s from configuration", node_name)
1248
1249     if node_name not in self._config_data.nodes:
1250       raise errors.ConfigurationError("Unknown node '%s'" % node_name)
1251
1252     self._UnlockedRemoveNodeFromGroup(self._config_data.nodes[node_name])
1253     del self._config_data.nodes[node_name]
1254     self._config_data.cluster.serial_no += 1
1255     self._WriteConfig()
1256
1257   @locking.ssynchronized(_config_lock, shared=1)
1258   def ExpandNodeName(self, short_name):
1259     """Attempt to expand an incomplete instance name.
1260
1261     """
1262     return utils.MatchNameComponent(short_name,
1263                                     self._config_data.nodes.keys(),
1264                                     case_sensitive=False)
1265
1266   def _UnlockedGetNodeInfo(self, node_name):
1267     """Get the configuration of a node, as stored in the config.
1268
1269     This function is for internal use, when the config lock is already
1270     held.
1271
1272     @param node_name: the node name, e.g. I{node1.example.com}
1273
1274     @rtype: L{objects.Node}
1275     @return: the node object
1276
1277     """
1278     if node_name not in self._config_data.nodes:
1279       return None
1280
1281     return self._config_data.nodes[node_name]
1282
1283   @locking.ssynchronized(_config_lock, shared=1)
1284   def GetNodeInfo(self, node_name):
1285     """Get the configuration of a node, as stored in the config.
1286
1287     This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
1288
1289     @param node_name: the node name, e.g. I{node1.example.com}
1290
1291     @rtype: L{objects.Node}
1292     @return: the node object
1293
1294     """
1295     return self._UnlockedGetNodeInfo(node_name)
1296
1297   @locking.ssynchronized(_config_lock, shared=1)
1298   def GetNodeInstances(self, node_name):
1299     """Get the instances of a node, as stored in the config.
1300
1301     @param node_name: the node name, e.g. I{node1.example.com}
1302
1303     @rtype: (list, list)
1304     @return: a tuple with two lists: the primary and the secondary instances
1305
1306     """
1307     pri = []
1308     sec = []
1309     for inst in self._config_data.instances.values():
1310       if inst.primary_node == node_name:
1311         pri.append(inst.name)
1312       if node_name in inst.secondary_nodes:
1313         sec.append(inst.name)
1314     return (pri, sec)
1315
1316   def _UnlockedGetNodeList(self):
1317     """Return the list of nodes which are in the configuration.
1318
1319     This function is for internal use, when the config lock is already
1320     held.
1321
1322     @rtype: list
1323
1324     """
1325     return self._config_data.nodes.keys()
1326
1327   @locking.ssynchronized(_config_lock, shared=1)
1328   def GetNodeList(self):
1329     """Return the list of nodes which are in the configuration.
1330
1331     """
1332     return self._UnlockedGetNodeList()
1333
1334   def _UnlockedGetOnlineNodeList(self):
1335     """Return the list of nodes which are online.
1336
1337     """
1338     all_nodes = [self._UnlockedGetNodeInfo(node)
1339                  for node in self._UnlockedGetNodeList()]
1340     return [node.name for node in all_nodes if not node.offline]
1341
1342   @locking.ssynchronized(_config_lock, shared=1)
1343   def GetOnlineNodeList(self):
1344     """Return the list of nodes which are online.
1345
1346     """
1347     return self._UnlockedGetOnlineNodeList()
1348
1349   @locking.ssynchronized(_config_lock, shared=1)
1350   def GetVmCapableNodeList(self):
1351     """Return the list of nodes which are not vm capable.
1352
1353     """
1354     all_nodes = [self._UnlockedGetNodeInfo(node)
1355                  for node in self._UnlockedGetNodeList()]
1356     return [node.name for node in all_nodes if node.vm_capable]
1357
1358   @locking.ssynchronized(_config_lock, shared=1)
1359   def GetNonVmCapableNodeList(self):
1360     """Return the list of nodes which are not vm capable.
1361
1362     """
1363     all_nodes = [self._UnlockedGetNodeInfo(node)
1364                  for node in self._UnlockedGetNodeList()]
1365     return [node.name for node in all_nodes if not node.vm_capable]
1366
1367   @locking.ssynchronized(_config_lock, shared=1)
1368   def GetAllNodesInfo(self):
1369     """Get the configuration of all nodes.
1370
1371     @rtype: dict
1372     @return: dict of (node, node_info), where node_info is what
1373               would GetNodeInfo return for the node
1374
1375     """
1376     my_dict = dict([(node, self._UnlockedGetNodeInfo(node))
1377                     for node in self._UnlockedGetNodeList()])
1378     return my_dict
1379
1380   def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1381     """Get the number of current and maximum desired and possible candidates.
1382
1383     @type exceptions: list
1384     @param exceptions: if passed, list of nodes that should be ignored
1385     @rtype: tuple
1386     @return: tuple of (current, desired and possible, possible)
1387
1388     """
1389     mc_now = mc_should = mc_max = 0
1390     for node in self._config_data.nodes.values():
1391       if exceptions and node.name in exceptions:
1392         continue
1393       if not (node.offline or node.drained) and node.master_capable:
1394         mc_max += 1
1395       if node.master_candidate:
1396         mc_now += 1
1397     mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
1398     return (mc_now, mc_should, mc_max)
1399
1400   @locking.ssynchronized(_config_lock, shared=1)
1401   def GetMasterCandidateStats(self, exceptions=None):
1402     """Get the number of current and maximum possible candidates.
1403
1404     This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.
1405
1406     @type exceptions: list
1407     @param exceptions: if passed, list of nodes that should be ignored
1408     @rtype: tuple
1409     @return: tuple of (current, max)
1410
1411     """
1412     return self._UnlockedGetMasterCandidateStats(exceptions)
1413
1414   @locking.ssynchronized(_config_lock)
1415   def MaintainCandidatePool(self, exceptions):
1416     """Try to grow the candidate pool to the desired size.
1417
1418     @type exceptions: list
1419     @param exceptions: if passed, list of nodes that should be ignored
1420     @rtype: list
1421     @return: list with the adjusted nodes (L{objects.Node} instances)
1422
1423     """
1424     mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1425     mod_list = []
1426     if mc_now < mc_max:
1427       node_list = self._config_data.nodes.keys()
1428       random.shuffle(node_list)
1429       for name in node_list:
1430         if mc_now >= mc_max:
1431           break
1432         node = self._config_data.nodes[name]
1433         if (node.master_candidate or node.offline or node.drained or
1434             node.name in exceptions or not node.master_capable):
1435           continue
1436         mod_list.append(node)
1437         node.master_candidate = True
1438         node.serial_no += 1
1439         mc_now += 1
1440       if mc_now != mc_max:
1441         # this should not happen
1442         logging.warning("Warning: MaintainCandidatePool didn't manage to"
1443                         " fill the candidate pool (%d/%d)", mc_now, mc_max)
1444       if mod_list:
1445         self._config_data.cluster.serial_no += 1
1446         self._WriteConfig()
1447
1448     return mod_list
1449
1450   def _UnlockedAddNodeToGroup(self, node_name, nodegroup_uuid):
1451     """Add a given node to the specified group.
1452
1453     """
1454     if nodegroup_uuid not in self._config_data.nodegroups:
1455       # This can happen if a node group gets deleted between its lookup and
1456       # when we're adding the first node to it, since we don't keep a lock in
1457       # the meantime. It's ok though, as we'll fail cleanly if the node group
1458       # is not found anymore.
1459       raise errors.OpExecError("Unknown node group: %s" % nodegroup_uuid)
1460     if node_name not in self._config_data.nodegroups[nodegroup_uuid].members:
1461       self._config_data.nodegroups[nodegroup_uuid].members.append(node_name)
1462
1463   def _UnlockedRemoveNodeFromGroup(self, node):
1464     """Remove a given node from its group.
1465
1466     """
1467     nodegroup = node.group
1468     if nodegroup not in self._config_data.nodegroups:
1469       logging.warning("Warning: node '%s' has unknown node group '%s'"
1470                       " (while being removed from it)", node.name, nodegroup)
1471     nodegroup_obj = self._config_data.nodegroups[nodegroup]
1472     if node.name not in nodegroup_obj.members:
1473       logging.warning("Warning: node '%s' not a member of its node group '%s'"
1474                       " (while being removed from it)", node.name, nodegroup)
1475     else:
1476       nodegroup_obj.members.remove(node.name)
1477
1478   def _BumpSerialNo(self):
1479     """Bump up the serial number of the config.
1480
1481     """
1482     self._config_data.serial_no += 1
1483     self._config_data.mtime = time.time()
1484
1485   def _AllUUIDObjects(self):
1486     """Returns all objects with uuid attributes.
1487
1488     """
1489     return (self._config_data.instances.values() +
1490             self._config_data.nodes.values() +
1491             self._config_data.nodegroups.values() +
1492             [self._config_data.cluster])
1493
1494   def _OpenConfig(self, accept_foreign):
1495     """Read the config data from disk.
1496
1497     """
1498     raw_data = utils.ReadFile(self._cfg_file)
1499
1500     try:
1501       data = objects.ConfigData.FromDict(serializer.Load(raw_data))
1502     except Exception, err:
1503       raise errors.ConfigurationError(err)
1504
1505     # Make sure the configuration has the right version
1506     _ValidateConfig(data)
1507
1508     if (not hasattr(data, 'cluster') or
1509         not hasattr(data.cluster, 'rsahostkeypub')):
1510       raise errors.ConfigurationError("Incomplete configuration"
1511                                       " (missing cluster.rsahostkeypub)")
1512
1513     if data.cluster.master_node != self._my_hostname and not accept_foreign:
1514       msg = ("The configuration denotes node %s as master, while my"
1515              " hostname is %s; opening a foreign configuration is only"
1516              " possible in accept_foreign mode" %
1517              (data.cluster.master_node, self._my_hostname))
1518       raise errors.ConfigurationError(msg)
1519
1520     # Upgrade configuration if needed
1521     data.UpgradeConfig()
1522
1523     self._config_data = data
1524     # reset the last serial as -1 so that the next write will cause
1525     # ssconf update
1526     self._last_cluster_serial = -1
1527
1528     # And finally run our (custom) config upgrade sequence
1529     self._UpgradeConfig()
1530
1531     self._cfg_id = utils.GetFileID(path=self._cfg_file)
1532
1533   def _UpgradeConfig(self):
1534     """Run upgrade steps that cannot be done purely in the objects.
1535
1536     This is because some data elements need uniqueness across the
1537     whole configuration, etc.
1538
1539     @warning: this function will call L{_WriteConfig()}, but also
1540         L{DropECReservations} so it needs to be called only from a
1541         "safe" place (the constructor). If one wanted to call it with
1542         the lock held, a DropECReservationUnlocked would need to be
1543         created first, to avoid causing deadlock.
1544
1545     """
1546     modified = False
1547     for item in self._AllUUIDObjects():
1548       if item.uuid is None:
1549         item.uuid = self._GenerateUniqueID(_UPGRADE_CONFIG_JID)
1550         modified = True
1551     if not self._config_data.nodegroups:
1552       default_nodegroup_name = constants.INITIAL_NODE_GROUP_NAME
1553       default_nodegroup = objects.NodeGroup(name=default_nodegroup_name,
1554                                             members=[])
1555       self._UnlockedAddNodeGroup(default_nodegroup, _UPGRADE_CONFIG_JID, True)
1556       modified = True
1557     for node in self._config_data.nodes.values():
1558       if not node.group:
1559         node.group = self.LookupNodeGroup(None)
1560         modified = True
1561       # This is technically *not* an upgrade, but needs to be done both when
1562       # nodegroups are being added, and upon normally loading the config,
1563       # because the members list of a node group is discarded upon
1564       # serializing/deserializing the object.
1565       self._UnlockedAddNodeToGroup(node.name, node.group)
1566     if modified:
1567       self._WriteConfig()
1568       # This is ok even if it acquires the internal lock, as _UpgradeConfig is
1569       # only called at config init time, without the lock held
1570       self.DropECReservations(_UPGRADE_CONFIG_JID)
1571
1572   def _DistributeConfig(self, feedback_fn):
1573     """Distribute the configuration to the other nodes.
1574
1575     Currently, this only copies the configuration file. In the future,
1576     it could be used to encapsulate the 2/3-phase update mechanism.
1577
1578     """
1579     if self._offline:
1580       return True
1581
1582     bad = False
1583
1584     node_list = []
1585     addr_list = []
1586     myhostname = self._my_hostname
1587     # we can skip checking whether _UnlockedGetNodeInfo returns None
1588     # since the node list comes from _UnlocketGetNodeList, and we are
1589     # called with the lock held, so no modifications should take place
1590     # in between
1591     for node_name in self._UnlockedGetNodeList():
1592       if node_name == myhostname:
1593         continue
1594       node_info = self._UnlockedGetNodeInfo(node_name)
1595       if not node_info.master_candidate:
1596         continue
1597       node_list.append(node_info.name)
1598       addr_list.append(node_info.primary_ip)
1599
1600     result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
1601                                             address_list=addr_list)
1602     for to_node, to_result in result.items():
1603       msg = to_result.fail_msg
1604       if msg:
1605         msg = ("Copy of file %s to node %s failed: %s" %
1606                (self._cfg_file, to_node, msg))
1607         logging.error(msg)
1608
1609         if feedback_fn:
1610           feedback_fn(msg)
1611
1612         bad = True
1613
1614     return not bad
1615
1616   def _WriteConfig(self, destination=None, feedback_fn=None):
1617     """Write the configuration data to persistent storage.
1618
1619     """
1620     assert feedback_fn is None or callable(feedback_fn)
1621
1622     # Warn on config errors, but don't abort the save - the
1623     # configuration has already been modified, and we can't revert;
1624     # the best we can do is to warn the user and save as is, leaving
1625     # recovery to the user
1626     config_errors = self._UnlockedVerifyConfig()
1627     if config_errors:
1628       errmsg = ("Configuration data is not consistent: %s" %
1629                 (utils.CommaJoin(config_errors)))
1630       logging.critical(errmsg)
1631       if feedback_fn:
1632         feedback_fn(errmsg)
1633
1634     if destination is None:
1635       destination = self._cfg_file
1636     self._BumpSerialNo()
1637     txt = serializer.Dump(self._config_data.ToDict())
1638
1639     getents = self._getents()
1640     try:
1641       fd = utils.SafeWriteFile(destination, self._cfg_id, data=txt,
1642                                close=False, gid=getents.confd_gid, mode=0640)
1643     except errors.LockError:
1644       raise errors.ConfigurationError("The configuration file has been"
1645                                       " modified since the last write, cannot"
1646                                       " update")
1647     try:
1648       self._cfg_id = utils.GetFileID(fd=fd)
1649     finally:
1650       os.close(fd)
1651
1652     self.write_count += 1
1653
1654     # and redistribute the config file to master candidates
1655     self._DistributeConfig(feedback_fn)
1656
1657     # Write ssconf files on all nodes (including locally)
1658     if self._last_cluster_serial < self._config_data.cluster.serial_no:
1659       if not self._offline:
1660         result = rpc.RpcRunner.call_write_ssconf_files(
1661           self._UnlockedGetOnlineNodeList(),
1662           self._UnlockedGetSsconfValues())
1663
1664         for nname, nresu in result.items():
1665           msg = nresu.fail_msg
1666           if msg:
1667             errmsg = ("Error while uploading ssconf files to"
1668                       " node %s: %s" % (nname, msg))
1669             logging.warning(errmsg)
1670
1671             if feedback_fn:
1672               feedback_fn(errmsg)
1673
1674       self._last_cluster_serial = self._config_data.cluster.serial_no
1675
1676   def _UnlockedGetSsconfValues(self):
1677     """Return the values needed by ssconf.
1678
1679     @rtype: dict
1680     @return: a dictionary with keys the ssconf names and values their
1681         associated value
1682
1683     """
1684     fn = "\n".join
1685     instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1686     node_names = utils.NiceSort(self._UnlockedGetNodeList())
1687     node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]
1688     node_pri_ips = ["%s %s" % (ninfo.name, ninfo.primary_ip)
1689                     for ninfo in node_info]
1690     node_snd_ips = ["%s %s" % (ninfo.name, ninfo.secondary_ip)
1691                     for ninfo in node_info]
1692
1693     instance_data = fn(instance_names)
1694     off_data = fn(node.name for node in node_info if node.offline)
1695     on_data = fn(node.name for node in node_info if not node.offline)
1696     mc_data = fn(node.name for node in node_info if node.master_candidate)
1697     mc_ips_data = fn(node.primary_ip for node in node_info
1698                      if node.master_candidate)
1699     node_data = fn(node_names)
1700     node_pri_ips_data = fn(node_pri_ips)
1701     node_snd_ips_data = fn(node_snd_ips)
1702
1703     cluster = self._config_data.cluster
1704     cluster_tags = fn(cluster.GetTags())
1705
1706     hypervisor_list = fn(cluster.enabled_hypervisors)
1707
1708     uid_pool = uidpool.FormatUidPool(cluster.uid_pool, separator="\n")
1709
1710     nodegroups = ["%s %s" % (nodegroup.uuid, nodegroup.name) for nodegroup in
1711                   self._config_data.nodegroups.values()]
1712     nodegroups_data = fn(utils.NiceSort(nodegroups))
1713
1714     return {
1715       constants.SS_CLUSTER_NAME: cluster.cluster_name,
1716       constants.SS_CLUSTER_TAGS: cluster_tags,
1717       constants.SS_FILE_STORAGE_DIR: cluster.file_storage_dir,
1718       constants.SS_MASTER_CANDIDATES: mc_data,
1719       constants.SS_MASTER_CANDIDATES_IPS: mc_ips_data,
1720       constants.SS_MASTER_IP: cluster.master_ip,
1721       constants.SS_MASTER_NETDEV: cluster.master_netdev,
1722       constants.SS_MASTER_NODE: cluster.master_node,
1723       constants.SS_NODE_LIST: node_data,
1724       constants.SS_NODE_PRIMARY_IPS: node_pri_ips_data,
1725       constants.SS_NODE_SECONDARY_IPS: node_snd_ips_data,
1726       constants.SS_OFFLINE_NODES: off_data,
1727       constants.SS_ONLINE_NODES: on_data,
1728       constants.SS_PRIMARY_IP_FAMILY: str(cluster.primary_ip_family),
1729       constants.SS_INSTANCE_LIST: instance_data,
1730       constants.SS_RELEASE_VERSION: constants.RELEASE_VERSION,
1731       constants.SS_HYPERVISOR_LIST: hypervisor_list,
1732       constants.SS_MAINTAIN_NODE_HEALTH: str(cluster.maintain_node_health),
1733       constants.SS_UID_POOL: uid_pool,
1734       constants.SS_NODEGROUPS: nodegroups_data,
1735       }
1736
1737   @locking.ssynchronized(_config_lock, shared=1)
1738   def GetSsconfValues(self):
1739     """Wrapper using lock around _UnlockedGetSsconf().
1740
1741     """
1742     return self._UnlockedGetSsconfValues()
1743
1744   @locking.ssynchronized(_config_lock, shared=1)
1745   def GetVGName(self):
1746     """Return the volume group name.
1747
1748     """
1749     return self._config_data.cluster.volume_group_name
1750
1751   @locking.ssynchronized(_config_lock)
1752   def SetVGName(self, vg_name):
1753     """Set the volume group name.
1754
1755     """
1756     self._config_data.cluster.volume_group_name = vg_name
1757     self._config_data.cluster.serial_no += 1
1758     self._WriteConfig()
1759
1760   @locking.ssynchronized(_config_lock, shared=1)
1761   def GetDRBDHelper(self):
1762     """Return DRBD usermode helper.
1763
1764     """
1765     return self._config_data.cluster.drbd_usermode_helper
1766
1767   @locking.ssynchronized(_config_lock)
1768   def SetDRBDHelper(self, drbd_helper):
1769     """Set DRBD usermode helper.
1770
1771     """
1772     self._config_data.cluster.drbd_usermode_helper = drbd_helper
1773     self._config_data.cluster.serial_no += 1
1774     self._WriteConfig()
1775
1776   @locking.ssynchronized(_config_lock, shared=1)
1777   def GetMACPrefix(self):
1778     """Return the mac prefix.
1779
1780     """
1781     return self._config_data.cluster.mac_prefix
1782
1783   @locking.ssynchronized(_config_lock, shared=1)
1784   def GetClusterInfo(self):
1785     """Returns information about the cluster
1786
1787     @rtype: L{objects.Cluster}
1788     @return: the cluster object
1789
1790     """
1791     return self._config_data.cluster
1792
1793   @locking.ssynchronized(_config_lock, shared=1)
1794   def HasAnyDiskOfType(self, dev_type):
1795     """Check if in there is at disk of the given type in the configuration.
1796
1797     """
1798     return self._config_data.HasAnyDiskOfType(dev_type)
1799
1800   @locking.ssynchronized(_config_lock)
1801   def Update(self, target, feedback_fn):
1802     """Notify function to be called after updates.
1803
1804     This function must be called when an object (as returned by
1805     GetInstanceInfo, GetNodeInfo, GetCluster) has been updated and the
1806     caller wants the modifications saved to the backing store. Note
1807     that all modified objects will be saved, but the target argument
1808     is the one the caller wants to ensure that it's saved.
1809
1810     @param target: an instance of either L{objects.Cluster},
1811         L{objects.Node} or L{objects.Instance} which is existing in
1812         the cluster
1813     @param feedback_fn: Callable feedback function
1814
1815     """
1816     if self._config_data is None:
1817       raise errors.ProgrammerError("Configuration file not read,"
1818                                    " cannot save.")
1819     update_serial = False
1820     if isinstance(target, objects.Cluster):
1821       test = target == self._config_data.cluster
1822     elif isinstance(target, objects.Node):
1823       test = target in self._config_data.nodes.values()
1824       update_serial = True
1825     elif isinstance(target, objects.Instance):
1826       test = target in self._config_data.instances.values()
1827     elif isinstance(target, objects.NodeGroup):
1828       test = target in self._config_data.nodegroups.values()
1829     else:
1830       raise errors.ProgrammerError("Invalid object type (%s) passed to"
1831                                    " ConfigWriter.Update" % type(target))
1832     if not test:
1833       raise errors.ConfigurationError("Configuration updated since object"
1834                                       " has been read or unknown object")
1835     target.serial_no += 1
1836     target.mtime = now = time.time()
1837
1838     if update_serial:
1839       # for node updates, we need to increase the cluster serial too
1840       self._config_data.cluster.serial_no += 1
1841       self._config_data.cluster.mtime = now
1842
1843     if isinstance(target, objects.Instance):
1844       self._UnlockedReleaseDRBDMinors(target.name)
1845
1846     self._WriteConfig(feedback_fn=feedback_fn)
1847
1848   @locking.ssynchronized(_config_lock)
1849   def DropECReservations(self, ec_id):
1850     """Drop per-execution-context reservations
1851
1852     """
1853     for rm in self._all_rms:
1854       rm.DropECReservations(ec_id)