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
30 from ganeti import utils
31 from ganeti import constants
32 from ganeti import errors
33 from ganeti import objects
34 from ganeti.hypervisor import hv_base
37 class FakeHypervisor(hv_base.BaseHypervisor):
38 """Fake hypervisor interface.
40 This can be used for testing the ganeti code without having to have
41 a real virtualisation software installed.
46 _ROOT_DIR = constants.RUN_GANETI_DIR + "/fake-hypervisor"
49 hv_base.BaseHypervisor.__init__(self)
50 utils.EnsureDirs([(self._ROOT_DIR, constants.RUN_DIRS_MODE)])
52 def ListInstances(self):
53 """Get the list of running instances.
56 return os.listdir(self._ROOT_DIR)
58 def GetInstanceInfo(self, instance_name):
59 """Get instance properties.
61 @param instance_name: the instance name
63 @return: tuple of (name, id, memory, vcpus, stat, times)
66 file_name = self._InstanceFile(instance_name)
67 if not os.path.exists(file_name):
70 fh = open(file_name, "r")
72 inst_id = fh.readline().strip()
73 memory = utils.TryConvert(int, fh.readline().strip())
74 vcpus = utils.TryConvert(int, fh.readline().strip())
77 return (instance_name, inst_id, memory, vcpus, stat, times)
81 raise errors.HypervisorError("Failed to list instance %s: %s" %
84 def GetAllInstancesInfo(self):
85 """Get properties of all instances.
87 @return: list of tuples (name, id, memory, vcpus, stat, times)
91 for file_name in os.listdir(self._ROOT_DIR):
93 fh = open(utils.PathJoin(self._ROOT_DIR, file_name), "r")
100 inst_id = fh.readline().strip()
101 memory = utils.TryConvert(int, fh.readline().strip())
102 vcpus = utils.TryConvert(int, fh.readline().strip())
107 data.append((file_name, inst_id, memory, vcpus, stat, times))
109 raise errors.HypervisorError("Failed to list instances: %s" % err)
113 def _InstanceFile(cls, instance_name):
114 """Compute the instance file for an instance name.
117 return utils.PathJoin(cls._ROOT_DIR, instance_name)
119 def _IsAlive(self, instance_name):
120 """Checks if an instance is alive.
123 file_name = self._InstanceFile(instance_name)
124 return os.path.exists(file_name)
126 def _MarkUp(self, instance):
127 """Mark the instance as running.
129 This does no checks, which should be done by its callers.
132 file_name = self._InstanceFile(instance.name)
133 fh = file(file_name, "w")
135 fh.write("0\n%d\n%d\n" %
136 (instance.beparams[constants.BE_MAXMEM],
137 instance.beparams[constants.BE_VCPUS]))
141 def _MarkDown(self, instance_name):
142 """Mark the instance as running.
144 This does no checks, which should be done by its callers.
147 file_name = self._InstanceFile(instance_name)
148 utils.RemoveFile(file_name)
150 def StartInstance(self, instance, block_devices, startup_paused):
151 """Start an instance.
153 For the fake hypervisor, it just creates a file in the base dir,
154 creating an exception if it already exists. We don't actually
155 handle race conditions properly, since these are *FAKE* instances.
158 if self._IsAlive(instance.name):
159 raise errors.HypervisorError("Failed to start instance %s: %s" %
160 (instance.name, "already running"))
162 self._MarkUp(instance)
164 raise errors.HypervisorError("Failed to start instance %s: %s" %
165 (instance.name, err))
167 def StopInstance(self, instance, force=False, retry=False, name=None):
170 For the fake hypervisor, this just removes the file in the base
171 dir, if it exist, otherwise we raise an exception.
176 if not self._IsAlive(name):
177 raise errors.HypervisorError("Failed to stop instance %s: %s" %
178 (name, "not running"))
181 def RebootInstance(self, instance):
182 """Reboot an instance.
184 For the fake hypervisor, this does nothing.
189 def GetNodeInfo(self):
190 """Return information about the node.
192 This is just a wrapper over the base GetLinuxNodeInfo method.
194 @return: a dict with the following keys (values in MiB):
195 - memory_total: the total memory size on the node
196 - memory_free: the available memory on the node for instances
197 - memory_dom0: the memory used by the node itself, if available
200 result = self.GetLinuxNodeInfo()
201 # substract running instances
202 all_instances = self.GetAllInstancesInfo()
203 result["memory_free"] -= min(result["memory_free"],
204 sum([row[2] for row in all_instances]))
208 def GetInstanceConsole(cls, instance, hvparams, beparams):
209 """Return information for connecting to the console of an instance.
212 return objects.InstanceConsole(instance=instance.name,
213 kind=constants.CONS_MESSAGE,
214 message=("Console not available for fake"
218 """Verify the hypervisor.
220 For the fake hypervisor, it just checks the existence of the base
224 if not os.path.exists(self._ROOT_DIR):
225 return "The required directory '%s' does not exist." % self._ROOT_DIR
228 def PowercycleNode(cls):
229 """Fake hypervisor powercycle, just a wrapper over Linux powercycle.
232 cls.LinuxPowercycle()
234 def AcceptInstance(self, instance, info, target):
235 """Prepare to accept an instance.
237 @type instance: L{objects.Instance}
238 @param instance: instance to be accepted
240 @param info: instance info, not used
242 @param target: target host (usually ip), on this node
245 if self._IsAlive(instance.name):
246 raise errors.HypervisorError("Can't accept instance, already running")
248 def MigrateInstance(self, instance, target, live):
249 """Migrate an instance.
251 @type instance: L{objects.Instance}
252 @param instance: the instance to be migrated
254 @param target: hostname (usually ip) of the target node
256 @param live: whether to do a live or non-live migration
259 logging.debug("Fake hypervisor migrating %s to %s (live=%s)",
260 instance, target, live)
262 def FinalizeMigrationDst(self, instance, info, success):
263 """Finalize the instance migration on the target node.
265 For the fake hv, this just marks the instance up.
267 @type instance: L{objects.Instance}
268 @param instance: instance whose migration is being finalized
269 @type info: string/data (opaque)
270 @param info: migration information, from the source node
271 @type success: boolean
272 @param success: whether the migration was a success or a failure
276 self._MarkUp(instance)
279 self._MarkDown(instance.name)
281 def PostMigrationCleanup(self, instance):
282 """Clean-up after a migration.
284 To be executed on the source node.
286 @type instance: L{objects.Instance}
287 @param instance: the instance that was migrated
292 def FinalizeMigrationSource(self, instance, success, live):
293 """Finalize the instance migration on the source node.
295 @type instance: L{objects.Instance}
296 @param instance: the instance that was migrated
298 @param success: whether the migration succeeded or not
300 @param live: whether the user requested a live migration or not
303 # pylint: disable=W0613
305 self._MarkDown(instance.name)
307 def GetMigrationStatus(self, instance):
308 """Get the migration status
310 The fake hypervisor migration always succeeds.
312 @type instance: L{objects.Instance}
313 @param instance: the instance that is being migrated
314 @rtype: L{objects.MigrationStatus}
315 @return: the status of the current migration (one of
316 L{constants.HV_MIGRATION_VALID_STATUSES}), plus any additional
317 progress info that can be retrieved from the hypervisor
320 return objects.MigrationStatus(status=constants.HV_MIGRATION_COMPLETED)