4 # Copyright (C) 2006, 2007, 2008, 2009, 2010 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 """Ganeti exception handling"""
25 # OpPrereqError failure types
28 ECODE_RESOLVER = "resolver_error"
29 # not enough resources (iallocator failure, disk space, memory, etc.)
30 ECODE_NORES = "insufficient_resources"
31 # wrong arguments (at syntax level)
32 ECODE_INVAL = "wrong_input"
34 ECODE_STATE = "wrong_state"
36 ECODE_NOENT = "unknown_entity"
37 # entity already exists
38 ECODE_EXISTS = "already_exists"
39 # resource not unique (e.g. MAC or IP duplication)
40 ECODE_NOTUNIQUE = "resource_not_unique"
41 # internal cluster error
42 ECODE_FAULT = "internal_error"
43 # environment error (e.g. node disk error)
44 ECODE_ENVIRON = "environment_error"
46 #: List of all failure types
47 ECODE_ALL = frozenset([
60 class GenericError(Exception):
61 """Base exception for Ganeti.
67 class LVMError(GenericError):
68 """LVM-related exception.
70 This exception codifies problems with LVM setup.
76 class LockError(GenericError):
77 """Lock error exception.
79 This signifies problems in the locking subsystem.
85 class HypervisorError(GenericError):
86 """Hypervisor-related exception.
88 This is raised in case we can't communicate with the hypervisor
95 class ProgrammerError(GenericError):
96 """Programming-related error.
98 This is raised in cases we determine that the calling conventions
99 have been violated, meaning we got some desynchronisation between
100 parts of our code. It signifies a real programming bug.
106 class BlockDeviceError(GenericError):
107 """Block-device related exception.
109 This is raised in case we can't setup the instance's block devices
116 class ConfigurationError(GenericError):
117 """Configuration related exception.
119 Things like having an instance with a primary node that doesn't
120 exist in the config or such raise this exception.
126 class ConfigVersionMismatch(ConfigurationError):
127 """Version mismatch in the configuration file.
129 The error has two arguments: the expected and the actual found
136 class ReservationError(GenericError):
137 """Errors reserving a resource.
142 class RemoteError(GenericError):
143 """Programming-related error on remote call.
145 This is raised when an unhandled error occurs in a call to a
146 remote node. It usually signifies a real programming bug.
152 class SignatureError(GenericError):
153 """Error authenticating a remote message.
155 This is raised when the hmac signature on a message doesn't verify correctly
156 to the message itself. It can happen because of network unreliability or
157 because of spurious traffic.
163 class ParameterError(GenericError):
164 """A passed parameter to a command is invalid.
166 This is raised when the parameter passed to a request function is
167 invalid. Correct code should have verified this before passing the
170 The argument to this exception should be the parameter name.
176 class OpPrereqError(GenericError):
177 """Prerequisites for the OpCode are not fulfilled.
179 This exception will have either one or two arguments. For the
180 two-argument construction, the second argument should be one of the
186 class OpExecError(GenericError):
187 """Error during OpCode execution.
192 class OpResultError(GenericError):
193 """Issue with OpCode result.
198 class OpCodeUnknown(GenericError):
199 """Unknown opcode submitted.
201 This signifies a mismatch between the definitions on the client and
207 class JobLost(GenericError):
208 """Submitted job lost.
210 The job was submitted but it cannot be found in the current job
216 class JobFileCorrupted(GenericError):
217 """Job file could not be properly decoded/restored.
222 class ResolverError(GenericError):
223 """Host name cannot be resolved.
225 This is not a normal situation for Ganeti, as we rely on having a
228 The non-resolvable hostname is available as the first element of the
229 args tuple; the other two elements of the tuple are the first two
230 args of the socket.gaierror exception (error code and description).
235 class HooksFailure(GenericError):
236 """A generic hook failure.
238 This signifies usually a setup misconfiguration.
243 class HooksAbort(HooksFailure):
244 """A required hook has failed.
246 This caused an abort of the operation in the initial phase. This
247 exception always has an attribute args which is a list of tuples of:
248 - node: the source node on which this hooks has failed
249 - script: the name of the script which aborted the run
254 class UnitParseError(GenericError):
255 """Unable to parse size unit.
260 class ParseError(GenericError):
261 """Generic parse error.
263 Raised when unable to parse user input.
268 class TypeEnforcementError(GenericError):
269 """Unable to enforce data type.
274 class SshKeyError(GenericError):
280 class TagError(GenericError):
281 """Generic tag error.
283 The argument to this exception will show the exact error.
288 class CommandError(GenericError):
289 """External command error.
294 class StorageError(GenericError):
295 """Storage-related exception.
300 class InotifyError(GenericError):
301 """Error raised when there is a failure setting up an inotify watcher.
306 class QuitGanetiException(Exception):
307 """Signal Ganeti that it must quit.
309 This is not necessarily an error (and thus not a subclass of
310 GenericError), but it's an exceptional circumstance and it is thus
311 treated. This instance should be instantiated with two values. The
312 first one will specify the return code to the caller, and the second
313 one will be the returned result (either as an error or as a normal
314 result). Usually only the leave cluster rpc call should return
315 status True (as there it's expected we quit), every other call will
316 return status False (as a critical error was encountered).
320 # Return a result of "True" to the caller, but quit ganeti afterwards
321 raise QuitGanetiException(True, None)
322 # Send an error to the caller, and quit ganeti
323 raise QuitGanetiException(False, "Fatal safety violation, shutting down")
328 class JobQueueError(GenericError):
334 class JobQueueDrainError(JobQueueError):
335 """Job queue is marked for drain error.
337 This is raised when a job submission attempt is made but the queue
343 class JobQueueFull(JobQueueError):
344 """Job queue full error.
346 Raised when job queue size reached its hard limit.
351 class ConfdRequestError(GenericError):
352 """A request error in Ganeti confd.
354 Events that should make confd abort the current request and proceed serving
360 class ConfdMagicError(GenericError):
361 """A magic fourcc error in Ganeti confd.
363 Errors processing the fourcc in ganeti confd datagrams.
368 class ConfdClientError(GenericError):
369 """A magic fourcc error in Ganeti confd.
371 Errors in the confd client library.
376 class UdpDataSizeError(GenericError):
377 """UDP payload too big.
382 class NoCtypesError(GenericError):
383 """python ctypes module is not found in the system.
388 class IPAddressError(GenericError):
389 """Generic IP address error.
394 class LuxiError(GenericError):
400 class QueryFilterParseError(ParseError):
401 """Error while parsing query filter.
404 def GetDetails(self):
405 """Returns a list of strings with details about the error.
409 (_, inner) = self.args
413 return [str(inner.line),
414 (" " * (inner.column - 1)) + "^",
418 # errors should be added above
421 def GetErrorClass(name):
422 """Return the class of an exception.
424 Given the class name, return the class itself.
427 @param name: the exception name
429 @return: the actual class, or None if not found
432 item = globals().get(name, None)
434 if not (isinstance(item, type(Exception)) and
435 issubclass(item, GenericError)):
440 def EncodeException(err):
441 """Encodes an exception into a format that L{MaybeRaise} will recognise.
443 The passed L{err} argument will be formatted as a tuple (exception
444 name, arguments) that the MaybeRaise function will recognise.
446 @type err: GenericError child
447 @param err: usually a child of GenericError (but any exception
450 @return: tuple of (exception name, exception arguments)
453 return (err.__class__.__name__, err.args)
456 def GetEncodedError(result):
457 """If this looks like an encoded Ganeti exception, return it.
459 This function tries to parse the passed argument and if it looks
460 like an encoding done by EncodeException, it will return the class
461 object and arguments.
465 if (isinstance(result, tlt) and len(result) == 2 and
466 isinstance(result[1], tlt)):
467 # custom ganeti errors
468 errcls = GetErrorClass(result[0])
470 return (errcls, tuple(result[1]))
475 def MaybeRaise(result):
476 """If this looks like an encoded Ganeti exception, raise it.
478 This function tries to parse the passed argument and if it looks
479 like an encoding done by EncodeException, it will re-raise it.
482 error = GetEncodedError(result)
484 (errcls, args) = error