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

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2012, 2013 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 """Base class for all hypervisors
  23
  24 The syntax for the _CHECK variables and the contents of the PARAMETERS
  25 dict is the same, see the docstring for L{BaseHypervisor.PARAMETERS}.
  26
  27 @var _FILE_CHECK: stub for file checks, without the required flag
  28 @var _DIR_CHECK: stub for directory checks, without the required flag
  29 @var REQ_FILE_CHECK: mandatory file parameter
  30 @var OPT_FILE_CHECK: optional file parameter
  31 @var REQ_DIR_CHECK: mandatory directory parametr
  32 @var OPT_DIR_CHECK: optional directory parameter
  33 @var NO_CHECK: parameter without any checks at all
  34 @var REQUIRED_CHECK: parameter required to exist (and non-false), but
  35     without other checks; beware that this can't be used for boolean
  36     parameters, where you should use NO_CHECK or a custom checker
  37
  38 """
  39
  40 import os
  41 import re
  42 import logging
  43
  44
  45 from ganeti import errors
  46 from ganeti import utils
  47 from ganeti import constants
  48
  49
  50 def _IsCpuMaskWellFormed(cpu_mask):
  51   """Verifies if the given single CPU mask is valid
  52
  53   The single CPU mask should be in the form "a,b,c,d", where each
  54   letter is a positive number or range.
  55
  56   """
  57   try:
  58     cpu_list = utils.ParseCpuMask(cpu_mask)
  59   except errors.ParseError, _:
  60     return False
  61   return isinstance(cpu_list, list) and len(cpu_list) > 0
  62
  63
  64 def _IsMultiCpuMaskWellFormed(cpu_mask):
  65   """Verifies if the given multiple CPU mask is valid
  66
  67   A valid multiple CPU mask is in the form "a:b:c:d", where each
  68   letter is a single CPU mask.
  69
  70   """
  71   try:
  72     utils.ParseMultiCpuMask(cpu_mask)
  73   except errors.ParseError, _:
  74     return False
  75
  76   return True
  77
  78
  79 # Read the BaseHypervisor.PARAMETERS docstring for the syntax of the
  80 # _CHECK values
  81
  82 # must be afile
  83 _FILE_CHECK = (utils.IsNormAbsPath, "must be an absolute normalized path",
  84                os.path.isfile, "not found or not a file")
  85
  86 # must be a directory
  87 _DIR_CHECK = (utils.IsNormAbsPath, "must be an absolute normalized path",
  88               os.path.isdir, "not found or not a directory")
  89
  90 # CPU mask must be well-formed
  91 # TODO: implement node level check for the CPU mask
  92 _CPU_MASK_CHECK = (_IsCpuMaskWellFormed,
  93                    "CPU mask definition is not well-formed",
  94                    None, None)
  95
  96 # Multiple CPU mask must be well-formed
  97 _MULTI_CPU_MASK_CHECK = (_IsMultiCpuMaskWellFormed,
  98                          "Multiple CPU mask definition is not well-formed",
  99                          None, None)
 100
 101 # Check for validity of port number
 102 _NET_PORT_CHECK = (lambda x: 0 < x < 65535, "invalid port number",
 103                    None, None)
 104
 105 # Check that an integer is non negative
 106 _NONNEGATIVE_INT_CHECK = (lambda x: x >= 0, "cannot be negative", None, None)
 107
 108 # nice wrappers for users
 109 REQ_FILE_CHECK = (True, ) + _FILE_CHECK
 110 OPT_FILE_CHECK = (False, ) + _FILE_CHECK
 111 REQ_DIR_CHECK = (True, ) + _DIR_CHECK
 112 OPT_DIR_CHECK = (False, ) + _DIR_CHECK
 113 REQ_NET_PORT_CHECK = (True, ) + _NET_PORT_CHECK
 114 OPT_NET_PORT_CHECK = (False, ) + _NET_PORT_CHECK
 115 REQ_CPU_MASK_CHECK = (True, ) + _CPU_MASK_CHECK
 116 OPT_CPU_MASK_CHECK = (False, ) + _CPU_MASK_CHECK
 117 REQ_MULTI_CPU_MASK_CHECK = (True, ) + _MULTI_CPU_MASK_CHECK
 118 OPT_MULTI_CPU_MASK_CHECK = (False, ) + _MULTI_CPU_MASK_CHECK
 119 REQ_NONNEGATIVE_INT_CHECK = (True, ) + _NONNEGATIVE_INT_CHECK
 120 OPT_NONNEGATIVE_INT_CHECK = (False, ) + _NONNEGATIVE_INT_CHECK
 121
 122 # no checks at all
 123 NO_CHECK = (False, None, None, None, None)
 124
 125 # required, but no other checks
 126 REQUIRED_CHECK = (True, None, None, None, None)
 127
 128 # migration type
 129 MIGRATION_MODE_CHECK = (True, lambda x: x in constants.HT_MIGRATION_MODES,
 130                         "invalid migration mode", None, None)
 131
 132
 133 def ParamInSet(required, my_set):
 134   """Builds parameter checker for set membership.
 135
 136   @type required: boolean
 137   @param required: whether this is a required parameter
 138   @type my_set: tuple, list or set
 139   @param my_set: allowed values set
 140
 141   """
 142   fn = lambda x: x in my_set
 143   err = ("The value must be one of: %s" % utils.CommaJoin(my_set))
 144   return (required, fn, err, None, None)
 145
 146
 147 class BaseHypervisor(object):
 148   """Abstract virtualisation technology interface
 149
 150   The goal is that all aspects of the virtualisation technology are
 151   abstracted away from the rest of code.
 152
 153   @cvar PARAMETERS: a dict of parameter name: check type; the check type is
 154       a five-tuple containing:
 155           - the required flag (boolean)
 156           - a function to check for syntax, that will be used in
 157             L{CheckParameterSyntax}, in the master daemon process
 158           - an error message for the above function
 159           - a function to check for parameter validity on the remote node,
 160             in the L{ValidateParameters} function
 161           - an error message for the above function
 162   @type CAN_MIGRATE: boolean
 163   @cvar CAN_MIGRATE: whether this hypervisor can do migration (either
 164       live or non-live)
 165
 166   """
 167   PARAMETERS = {}
 168   ANCILLARY_FILES = []
 169   ANCILLARY_FILES_OPT = []
 170   CAN_MIGRATE = False
 171
 172   def StartInstance(self, instance, block_devices, startup_paused):
 173     """Start an instance."""
 174     raise NotImplementedError
 175
 176   def StopInstance(self, instance, force=False, retry=False, name=None):
 177     """Stop an instance
 178
 179     @type instance: L{objects.Instance}
 180     @param instance: instance to stop
 181     @type force: boolean
 182     @param force: whether to do a "hard" stop (destroy)
 183     @type retry: boolean
 184     @param retry: whether this is just a retry call
 185     @type name: string or None
 186     @param name: if this parameter is passed, the the instance object
 187         should not be used (will be passed as None), and the shutdown
 188         must be done by name only
 189
 190     """
 191     raise NotImplementedError
 192
 193   def CleanupInstance(self, instance_name):
 194     """Cleanup after a stopped instance
 195
 196     This is an optional method, used by hypervisors that need to cleanup after
 197     an instance has been stopped.
 198
 199     @type instance_name: string
 200     @param instance_name: instance name to cleanup after
 201
 202     """
 203     pass
 204
 205   def RebootInstance(self, instance):
 206     """Reboot an instance."""
 207     raise NotImplementedError
 208
 209   def ListInstances(self, hvparams=None):
 210     """Get the list of running instances."""
 211     raise NotImplementedError
 212
 213   def GetInstanceInfo(self, instance_name):
 214     """Get instance properties.
 215
 216     @type instance_name: string
 217     @param instance_name: the instance name
 218
 219     @return: tuple (name, id, memory, vcpus, state, times)
 220
 221     """
 222     raise NotImplementedError
 223
 224   def GetAllInstancesInfo(self):
 225     """Get properties of all instances.
 226
 227     @return: list of tuples (name, id, memory, vcpus, stat, times)
 228
 229     """
 230     raise NotImplementedError
 231
 232   def GetNodeInfo(self):
 233     """Return information about the node.
 234
 235     @return: a dict with the following keys (values in MiB):
 236           - memory_total: the total memory size on the node
 237           - memory_free: the available memory on the node for instances
 238           - memory_dom0: the memory used by the node itself, if available
 239
 240     """
 241     raise NotImplementedError
 242
 243   @classmethod
 244   def GetInstanceConsole(cls, instance, hvparams, beparams):
 245     """Return information for connecting to the console of an instance.
 246
 247     """
 248     raise NotImplementedError
 249
 250   @classmethod
 251   def GetAncillaryFiles(cls):
 252     """Return a list of ancillary files to be copied to all nodes as ancillary
 253     configuration files.
 254
 255     @rtype: (list of absolute paths, list of absolute paths)
 256     @return: (all files, optional files)
 257
 258     """
 259     # By default we return a member variable, so that if an hypervisor has just
 260     # a static list of files it doesn't have to override this function.
 261     assert set(cls.ANCILLARY_FILES).issuperset(cls.ANCILLARY_FILES_OPT), \
 262       "Optional ancillary files must be a subset of ancillary files"
 263
 264     return (cls.ANCILLARY_FILES, cls.ANCILLARY_FILES_OPT)
 265
 266   def Verify(self, hvparams=None):
 267     """Verify the hypervisor.
 268
 269     @type hvparams: dict of strings
 270     @param hvparams: hypervisor parameters to be verified against
 271
 272     @return: Problem description if something is wrong, C{None} otherwise
 273
 274     """
 275     raise NotImplementedError
 276
 277   def MigrationInfo(self, instance): # pylint: disable=R0201,W0613
 278     """Get instance information to perform a migration.
 279
 280     By default assume no information is needed.
 281
 282     @type instance: L{objects.Instance}
 283     @param instance: instance to be migrated
 284     @rtype: string/data (opaque)
 285     @return: instance migration information - serialized form
 286
 287     """
 288     return ""
 289
 290   def AcceptInstance(self, instance, info, target):
 291     """Prepare to accept an instance.
 292
 293     By default assume no preparation is needed.
 294
 295     @type instance: L{objects.Instance}
 296     @param instance: instance to be accepted
 297     @type info: string/data (opaque)
 298     @param info: migration information, from the source node
 299     @type target: string
 300     @param target: target host (usually ip), on this node
 301
 302     """
 303     pass
 304
 305   def BalloonInstanceMemory(self, instance, mem):
 306     """Balloon an instance memory to a certain value.
 307
 308     @type instance: L{objects.Instance}
 309     @param instance: instance to be accepted
 310     @type mem: int
 311     @param mem: actual memory size to use for instance runtime
 312
 313     """
 314     raise NotImplementedError
 315
 316   def FinalizeMigrationDst(self, instance, info, success):
 317     """Finalize the instance migration on the target node.
 318
 319     Should finalize or revert any preparation done to accept the instance.
 320     Since by default we do no preparation, we also don't have anything to do
 321
 322     @type instance: L{objects.Instance}
 323     @param instance: instance whose migration is being finalized
 324     @type info: string/data (opaque)
 325     @param info: migration information, from the source node
 326     @type success: boolean
 327     @param success: whether the migration was a success or a failure
 328
 329     """
 330     pass
 331
 332   def MigrateInstance(self, instance, target, live):
 333     """Migrate an instance.
 334
 335     @type instance: L{objects.Instance}
 336     @param instance: the instance to be migrated
 337     @type target: string
 338     @param target: hostname (usually ip) of the target node
 339     @type live: boolean
 340     @param live: whether to do a live or non-live migration
 341
 342     """
 343     raise NotImplementedError
 344
 345   def FinalizeMigrationSource(self, instance, success, live):
 346     """Finalize the instance migration on the source node.
 347
 348     @type instance: L{objects.Instance}
 349     @param instance: the instance that was migrated
 350     @type success: bool
 351     @param success: whether the migration succeeded or not
 352     @type live: bool
 353     @param live: whether the user requested a live migration or not
 354
 355     """
 356     pass
 357
 358   def GetMigrationStatus(self, instance):
 359     """Get the migration status
 360
 361     @type instance: L{objects.Instance}
 362     @param instance: the instance that is being migrated
 363     @rtype: L{objects.MigrationStatus}
 364     @return: the status of the current migration (one of
 365              L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
 366              progress info that can be retrieved from the hypervisor
 367
 368     """
 369     raise NotImplementedError
 370
 371   def _InstanceStartupMemory(self, instance):
 372     """Get the correct startup memory for an instance
 373
 374     This function calculates how much memory an instance should be started
 375     with, making sure it's a value between the minimum and the maximum memory,
 376     but also trying to use no more than the current free memory on the node.
 377
 378     @type instance: L{objects.Instance}
 379     @param instance: the instance that is being started
 380     @rtype: integer
 381     @return: memory the instance should be started with
 382
 383     """
 384     free_memory = self.GetNodeInfo()["memory_free"]
 385     max_start_mem = min(instance.beparams[constants.BE_MAXMEM], free_memory)
 386     start_mem = max(instance.beparams[constants.BE_MINMEM], max_start_mem)
 387     return start_mem
 388
 389   @classmethod
 390   def CheckParameterSyntax(cls, hvparams):
 391     """Check the given parameters for validity.
 392
 393     This should check the passed set of parameters for
 394     validity. Classes should extend, not replace, this function.
 395
 396     @type hvparams:  dict
 397     @param hvparams: dictionary with parameter names/value
 398     @raise errors.HypervisorError: when a parameter is not valid
 399
 400     """
 401     for key in hvparams:
 402       if key not in cls.PARAMETERS:
 403         raise errors.HypervisorError("Parameter '%s' is not supported" % key)
 404
 405     # cheap tests that run on the master, should not access the world
 406     for name, (required, check_fn, errstr, _, _) in cls.PARAMETERS.items():
 407       if name not in hvparams:
 408         raise errors.HypervisorError("Parameter '%s' is missing" % name)
 409       value = hvparams[name]
 410       if not required and not value:
 411         continue
 412       if not value:
 413         raise errors.HypervisorError("Parameter '%s' is required but"
 414                                      " is currently not defined" % (name, ))
 415       if check_fn is not None and not check_fn(value):
 416         raise errors.HypervisorError("Parameter '%s' fails syntax"
 417                                      " check: %s (current value: '%s')" %
 418                                      (name, errstr, value))
 419
 420   @classmethod
 421   def ValidateParameters(cls, hvparams):
 422     """Check the given parameters for validity.
 423
 424     This should check the passed set of parameters for
 425     validity. Classes should extend, not replace, this function.
 426
 427     @type hvparams:  dict
 428     @param hvparams: dictionary with parameter names/value
 429     @raise errors.HypervisorError: when a parameter is not valid
 430
 431     """
 432     for name, (required, _, _, check_fn, errstr) in cls.PARAMETERS.items():
 433       value = hvparams[name]
 434       if not required and not value:
 435         continue
 436       if check_fn is not None and not check_fn(value):
 437         raise errors.HypervisorError("Parameter '%s' fails"
 438                                      " validation: %s (current value: '%s')" %
 439                                      (name, errstr, value))
 440
 441   @classmethod
 442   def PowercycleNode(cls):
 443     """Hard powercycle a node using hypervisor specific methods.
 444
 445     This method should hard powercycle the node, using whatever
 446     methods the hypervisor provides. Note that this means that all
 447     instances running on the node must be stopped too.
 448
 449     """
 450     raise NotImplementedError
 451
 452   @staticmethod
 453   def GetLinuxNodeInfo():
 454     """For linux systems, return actual OS information.
 455
 456     This is an abstraction for all non-hypervisor-based classes, where
 457     the node actually sees all the memory and CPUs via the /proc
 458     interface and standard commands. The other case if for example
 459     xen, where you only see the hardware resources via xen-specific
 460     tools.
 461
 462     @return: a dict with the following keys (values in MiB):
 463           - memory_total: the total memory size on the node
 464           - memory_free: the available memory on the node for instances
 465           - memory_dom0: the memory used by the node itself, if available
 466
 467     """
 468     try:
 469       data = utils.ReadFile("/proc/meminfo").splitlines()
 470     except EnvironmentError, err:
 471       raise errors.HypervisorError("Failed to list node info: %s" % (err,))
 472
 473     result = {}
 474     sum_free = 0
 475     try:
 476       for line in data:
 477         splitfields = line.split(":", 1)
 478
 479         if len(splitfields) > 1:
 480           key = splitfields[0].strip()
 481           val = splitfields[1].strip()
 482           if key == "MemTotal":
 483             result["memory_total"] = int(val.split()[0]) / 1024
 484           elif key in ("MemFree", "Buffers", "Cached"):
 485             sum_free += int(val.split()[0]) / 1024
 486           elif key == "Active":
 487             result["memory_dom0"] = int(val.split()[0]) / 1024
 488     except (ValueError, TypeError), err:
 489       raise errors.HypervisorError("Failed to compute memory usage: %s" %
 490                                    (err,))
 491     result["memory_free"] = sum_free
 492
 493     cpu_total = 0
 494     try:
 495       fh = open("/proc/cpuinfo")
 496       try:
 497         cpu_total = len(re.findall("(?m)^processor\s*:\s*[0-9]+\s*$",
 498                                    fh.read()))
 499       finally:
 500         fh.close()
 501     except EnvironmentError, err:
 502       raise errors.HypervisorError("Failed to list node info: %s" % (err,))
 503     result["cpu_total"] = cpu_total
 504     # FIXME: export correct data here
 505     result["cpu_nodes"] = 1
 506     result["cpu_sockets"] = 1
 507
 508     return result
 509
 510   @classmethod
 511   def LinuxPowercycle(cls):
 512     """Linux-specific powercycle method.
 513
 514     """
 515     try:
 516       fd = os.open("/proc/sysrq-trigger", os.O_WRONLY)
 517       try:
 518         os.write(fd, "b")
 519       finally:
 520         fd.close()
 521     except OSError:
 522       logging.exception("Can't open the sysrq-trigger file")
 523       result = utils.RunCmd(["reboot", "-n", "-f"])
 524       if not result:
 525         logging.error("Can't run shutdown: %s", result.output)
 526
 527   @staticmethod
 528   def _FormatVerifyResults(msgs):
 529     """Formats the verification results, given a list of errors.
 530
 531     @param msgs: list of errors, possibly empty
 532     @return: overall problem description if something is wrong,
 533         C{None} otherwise
 534
 535     """
 536     if msgs:
 537       return "; ".join(msgs)
 538     else:
 539       return None