4 # Copyright (C) 2006, 2007, 2008 Google Inc.
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.
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.
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
22 """Base class for all hypervisors
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}.
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
45 from ganeti import errors
46 from ganeti import utils
49 # Read the BaseHypervisor.PARAMETERS docstring for the syntax of the
53 _FILE_CHECK = (utils.IsNormAbsPath, "must be an absolute normalized path",
54 os.path.isfile, "not found or not a file")
57 _DIR_CHECK = (utils.IsNormAbsPath, "must be an absolute normalized path",
58 os.path.isdir, "not found or not a directory")
60 # nice wrappers for users
61 REQ_FILE_CHECK = (True, ) + _FILE_CHECK
62 OPT_FILE_CHECK = (False, ) + _FILE_CHECK
63 REQ_DIR_CHECK = (True, ) + _DIR_CHECK
64 OPT_DIR_CHECK = (False, ) + _DIR_CHECK
65 NET_PORT_CHECK = (True, lambda x: x > 0 and x < 65535, "invalid port number",
69 NO_CHECK = (False, None, None, None, None)
71 # required, but no other checks
72 REQUIRED_CHECK = (True, None, None, None, None)
75 def ParamInSet(required, my_set):
76 """Builds parameter checker for set membership.
78 @type required: boolean
79 @param required: whether this is a required parameter
80 @type my_set: tuple, list or set
81 @param my_set: allowed values set
84 fn = lambda x: x in my_set
85 err = ("The value must be one of: %s" % utils.CommaJoin(my_set))
86 return (required, fn, err, None, None)
89 class BaseHypervisor(object):
90 """Abstract virtualisation technology interface
92 The goal is that all aspects of the virtualisation technology are
93 abstracted away from the rest of code.
95 @cvar PARAMETERS: a dict of parameter name: check type; the check type is
96 a five-tuple containing:
97 - the required flag (boolean)
98 - a function to check for syntax, that will be used in
99 L{CheckParameterSyntax}, in the master daemon process
100 - an error message for the above function
101 - a function to check for parameter validity on the remote node,
102 in the L{ValidateParameters} function
103 - an error message for the above function
104 @type CAN_MIGRATE: boolean
105 @cvar CAN_MIGRATE: whether this hypervisor can do migration (either
116 def StartInstance(self, instance, block_devices):
117 """Start an instance."""
118 raise NotImplementedError
120 def StopInstance(self, instance, force=False, retry=False, name=None):
123 @type instance: L{objects.Instance}
124 @param instance: instance to stop
126 @param force: whether to do a "hard" stop (destroy)
128 @param retry: whether this is just a retry call
129 @type name: string or None
130 @param name: if this parameter is passed, the the instance object
131 should not be used (will be passed as None), and the shutdown
132 must be done by name only
135 raise NotImplementedError
137 def CleanupInstance(self, instance_name):
138 """Cleanup after a stopped instance
140 This is an optional method, used by hypervisors that need to cleanup after
141 an instance has been stopped.
143 @type instance_name: string
144 @param instance_name: instance name to cleanup after
149 def RebootInstance(self, instance):
150 """Reboot an instance."""
151 raise NotImplementedError
153 def ListInstances(self):
154 """Get the list of running instances."""
155 raise NotImplementedError
157 def GetInstanceInfo(self, instance_name):
158 """Get instance properties.
160 @type instance_name: string
161 @param instance_name: the instance name
163 @return: tuple (name, id, memory, vcpus, state, times)
166 raise NotImplementedError
168 def GetAllInstancesInfo(self):
169 """Get properties of all instances.
171 @return: list of tuples (name, id, memory, vcpus, stat, times)
174 raise NotImplementedError
176 def GetNodeInfo(self):
177 """Return information about the node.
179 @return: a dict with the following keys (values in MiB):
180 - memory_total: the total memory size on the node
181 - memory_free: the available memory on the node for instances
182 - memory_dom0: the memory used by the node itself, if available
185 raise NotImplementedError
188 def GetShellCommandForConsole(cls, instance, hvparams, beparams):
189 """Return a command for connecting to the console of an instance.
192 raise NotImplementedError
195 def GetAncillaryFiles(cls):
196 """Return a list of ancillary files to be copied to all nodes as ancillary
199 @rtype: list of strings
200 @return: list of absolute paths of files to ship cluster-wide
203 # By default we return a member variable, so that if an hypervisor has just
204 # a static list of files it doesn't have to override this function.
205 return cls.ANCILLARY_FILES
208 """Verify the hypervisor.
211 raise NotImplementedError
213 def MigrationInfo(self, instance): # pylint: disable-msg=R0201,W0613
214 """Get instance information to perform a migration.
216 By default assume no information is needed.
218 @type instance: L{objects.Instance}
219 @param instance: instance to be migrated
220 @rtype: string/data (opaque)
221 @return: instance migration information - serialized form
226 def AcceptInstance(self, instance, info, target):
227 """Prepare to accept an instance.
229 By default assume no preparation is needed.
231 @type instance: L{objects.Instance}
232 @param instance: instance to be accepted
233 @type info: string/data (opaque)
234 @param info: migration information, from the source node
236 @param target: target host (usually ip), on this node
241 def FinalizeMigration(self, instance, info, success):
242 """Finalized an instance migration.
244 Should finalize or revert any preparation done to accept the instance.
245 Since by default we do no preparation, we also don't have anything to do
247 @type instance: L{objects.Instance}
248 @param instance: instance whose migration is being finalized
249 @type info: string/data (opaque)
250 @param info: migration information, from the source node
251 @type success: boolean
252 @param success: whether the migration was a success or a failure
257 def MigrateInstance(self, instance, target, live):
258 """Migrate an instance.
260 @type instance: L{objects.Instance}
261 @param instance: the instance to be migrated
263 @param target: hostname (usually ip) of the target node
265 @param live: whether to do a live or non-live migration
268 raise NotImplementedError
271 def CheckParameterSyntax(cls, hvparams):
272 """Check the given parameters for validity.
274 This should check the passed set of parameters for
275 validity. Classes should extend, not replace, this function.
278 @param hvparams: dictionary with parameter names/value
279 @raise errors.HypervisorError: when a parameter is not valid
283 if key not in cls.PARAMETERS:
284 raise errors.HypervisorError("Parameter '%s' is not supported" % key)
286 # cheap tests that run on the master, should not access the world
287 for name, (required, check_fn, errstr, _, _) in cls.PARAMETERS.items():
288 if name not in hvparams:
289 raise errors.HypervisorError("Parameter '%s' is missing" % name)
290 value = hvparams[name]
291 if not required and not value:
294 raise errors.HypervisorError("Parameter '%s' is required but"
295 " is currently not defined" % (name, ))
296 if check_fn is not None and not check_fn(value):
297 raise errors.HypervisorError("Parameter '%s' fails syntax"
298 " check: %s (current value: '%s')" %
299 (name, errstr, value))
302 def ValidateParameters(cls, hvparams):
303 """Check the given parameters for validity.
305 This should check the passed set of parameters for
306 validity. Classes should extend, not replace, this function.
309 @param hvparams: dictionary with parameter names/value
310 @raise errors.HypervisorError: when a parameter is not valid
313 for name, (required, _, _, check_fn, errstr) in cls.PARAMETERS.items():
314 value = hvparams[name]
315 if not required and not value:
317 if check_fn is not None and not check_fn(value):
318 raise errors.HypervisorError("Parameter '%s' fails"
319 " validation: %s (current value: '%s')" %
320 (name, errstr, value))
323 def PowercycleNode(cls):
324 """Hard powercycle a node using hypervisor specific methods.
326 This method should hard powercycle the node, using whatever
327 methods the hypervisor provides. Note that this means that all
328 instances running on the node must be stopped too.
331 raise NotImplementedError
334 def GetLinuxNodeInfo():
335 """For linux systems, return actual OS information.
337 This is an abstraction for all non-hypervisor-based classes, where
338 the node actually sees all the memory and CPUs via the /proc
339 interface and standard commands. The other case if for example
340 xen, where you only see the hardware resources via xen-specific
343 @return: a dict with the following keys (values in MiB):
344 - memory_total: the total memory size on the node
345 - memory_free: the available memory on the node for instances
346 - memory_dom0: the memory used by the node itself, if available
350 data = utils.ReadFile("/proc/meminfo").splitlines()
351 except EnvironmentError, err:
352 raise errors.HypervisorError("Failed to list node info: %s" % (err,))
358 splitfields = line.split(":", 1)
360 if len(splitfields) > 1:
361 key = splitfields[0].strip()
362 val = splitfields[1].strip()
363 if key == 'MemTotal':
364 result['memory_total'] = int(val.split()[0])/1024
365 elif key in ('MemFree', 'Buffers', 'Cached'):
366 sum_free += int(val.split()[0])/1024
367 elif key == 'Active':
368 result['memory_dom0'] = int(val.split()[0])/1024
369 except (ValueError, TypeError), err:
370 raise errors.HypervisorError("Failed to compute memory usage: %s" %
372 result['memory_free'] = sum_free
376 fh = open("/proc/cpuinfo")
378 cpu_total = len(re.findall("(?m)^processor\s*:\s*[0-9]+\s*$",
382 except EnvironmentError, err:
383 raise errors.HypervisorError("Failed to list node info: %s" % (err,))
384 result['cpu_total'] = cpu_total
385 # FIXME: export correct data here
386 result['cpu_nodes'] = 1
387 result['cpu_sockets'] = 1
392 def LinuxPowercycle(cls):
393 """Linux-specific powercycle method.
397 fd = os.open("/proc/sysrq-trigger", os.O_WRONLY)
403 logging.exception("Can't open the sysrq-trigger file")
404 result = utils.RunCmd(["reboot", "-n", "-f"])
406 logging.error("Can't run shutdown: %s", result.output)