4 # Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 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 PidFileLockError(LockError):
86 """PID file is already locked by another process.
91 class HypervisorError(GenericError):
92 """Hypervisor-related exception.
94 This is raised in case we can't communicate with the hypervisor
101 class ProgrammerError(GenericError):
102 """Programming-related error.
104 This is raised in cases we determine that the calling conventions
105 have been violated, meaning we got some desynchronisation between
106 parts of our code. It signifies a real programming bug.
112 class BlockDeviceError(GenericError):
113 """Block-device related exception.
115 This is raised in case we can't setup the instance's block devices
122 class ConfigurationError(GenericError):
123 """Configuration related exception.
125 Things like having an instance with a primary node that doesn't
126 exist in the config or such raise this exception.
132 class ConfigVersionMismatch(ConfigurationError):
133 """Version mismatch in the configuration file.
135 The error has two arguments: the expected and the actual found
142 class AddressPoolError(GenericError):
143 """Errors related to IP address pools.
148 class ReservationError(GenericError):
149 """Errors reserving a resource.
154 class RemoteError(GenericError):
155 """Programming-related error on remote call.
157 This is raised when an unhandled error occurs in a call to a
158 remote node. It usually signifies a real programming bug.
164 class SignatureError(GenericError):
165 """Error authenticating a remote message.
167 This is raised when the hmac signature on a message doesn't verify correctly
168 to the message itself. It can happen because of network unreliability or
169 because of spurious traffic.
175 class ParameterError(GenericError):
176 """A passed parameter to a command is invalid.
178 This is raised when the parameter passed to a request function is
179 invalid. Correct code should have verified this before passing the
182 The argument to this exception should be the parameter name.
188 class OpPrereqError(GenericError):
189 """Prerequisites for the OpCode are not fulfilled.
191 This exception will have either one or two arguments. For the
192 two-argument construction, the second argument should be one of the
198 class OpExecError(GenericError):
199 """Error during OpCode execution.
204 class OpResultError(GenericError):
205 """Issue with OpCode result.
210 class OpCodeUnknown(GenericError):
211 """Unknown opcode submitted.
213 This signifies a mismatch between the definitions on the client and
219 class JobLost(GenericError):
220 """Submitted job lost.
222 The job was submitted but it cannot be found in the current job
228 class JobFileCorrupted(GenericError):
229 """Job file could not be properly decoded/restored.
234 class ResolverError(GenericError):
235 """Host name cannot be resolved.
237 This is not a normal situation for Ganeti, as we rely on having a
240 The non-resolvable hostname is available as the first element of the
241 args tuple; the other two elements of the tuple are the first two
242 args of the socket.gaierror exception (error code and description).
247 class HooksFailure(GenericError):
248 """A generic hook failure.
250 This signifies usually a setup misconfiguration.
255 class HooksAbort(HooksFailure):
256 """A required hook has failed.
258 This caused an abort of the operation in the initial phase. This
259 exception always has an attribute args which is a list of tuples of:
260 - node: the source node on which this hooks has failed
261 - script: the name of the script which aborted the run
266 class UnitParseError(GenericError):
267 """Unable to parse size unit.
272 class ParseError(GenericError):
273 """Generic parse error.
275 Raised when unable to parse user input.
280 class TypeEnforcementError(GenericError):
281 """Unable to enforce data type.
286 class SshKeyError(GenericError):
292 class X509CertError(GenericError):
293 """Invalid X509 certificate.
295 This error has two arguments: the certificate filename and the error cause.
300 class TagError(GenericError):
301 """Generic tag error.
303 The argument to this exception will show the exact error.
308 class CommandError(GenericError):
309 """External command error.
314 class StorageError(GenericError):
315 """Storage-related exception.
320 class InotifyError(GenericError):
321 """Error raised when there is a failure setting up an inotify watcher.
326 class QuitGanetiException(Exception):
327 """Signal Ganeti that it must quit.
329 This is not necessarily an error (and thus not a subclass of
330 GenericError), but it's an exceptional circumstance and it is thus
331 treated. This instance should be instantiated with two values. The
332 first one will specify the return code to the caller, and the second
333 one will be the returned result (either as an error or as a normal
334 result). Usually only the leave cluster rpc call should return
335 status True (as there it's expected we quit), every other call will
336 return status False (as a critical error was encountered).
340 # Return a result of "True" to the caller, but quit ganeti afterwards
341 raise QuitGanetiException(True, None)
342 # Send an error to the caller, and quit ganeti
343 raise QuitGanetiException(False, "Fatal safety violation, shutting down")
348 class JobQueueError(GenericError):
354 class JobQueueDrainError(JobQueueError):
355 """Job queue is marked for drain error.
357 This is raised when a job submission attempt is made but the queue
363 class JobQueueFull(JobQueueError):
364 """Job queue full error.
366 Raised when job queue size reached its hard limit.
371 class ConfdRequestError(GenericError):
372 """A request error in Ganeti confd.
374 Events that should make confd abort the current request and proceed serving
380 class ConfdMagicError(GenericError):
381 """A magic fourcc error in Ganeti confd.
383 Errors processing the fourcc in ganeti confd datagrams.
388 class ConfdClientError(GenericError):
389 """A magic fourcc error in Ganeti confd.
391 Errors in the confd client library.
396 class UdpDataSizeError(GenericError):
397 """UDP payload too big.
402 class NoCtypesError(GenericError):
403 """python ctypes module is not found in the system.
408 class IPAddressError(GenericError):
409 """Generic IP address error.
414 class LuxiError(GenericError):
420 class QueryFilterParseError(ParseError):
421 """Error while parsing query filter.
424 def GetDetails(self):
425 """Returns a list of strings with details about the error.
429 (_, inner) = self.args
433 return [str(inner.line),
434 (" " * (inner.column - 1)) + "^",
438 class RapiTestResult(GenericError):
439 """Exception containing results from RAPI test utilities.
444 # errors should be added above
447 def GetErrorClass(name):
448 """Return the class of an exception.
450 Given the class name, return the class itself.
453 @param name: the exception name
455 @return: the actual class, or None if not found
458 item = globals().get(name, None)
460 if not (isinstance(item, type(Exception)) and
461 issubclass(item, GenericError)):
466 def EncodeException(err):
467 """Encodes an exception into a format that L{MaybeRaise} will recognise.
469 The passed L{err} argument will be formatted as a tuple (exception
470 name, arguments) that the MaybeRaise function will recognise.
472 @type err: GenericError child
473 @param err: usually a child of GenericError (but any exception
476 @return: tuple of (exception name, exception arguments)
479 return (err.__class__.__name__, err.args)
482 def GetEncodedError(result):
483 """If this looks like an encoded Ganeti exception, return it.
485 This function tries to parse the passed argument and if it looks
486 like an encoding done by EncodeException, it will return the class
487 object and arguments.
491 if (isinstance(result, tlt) and len(result) == 2 and
492 isinstance(result[1], tlt)):
493 # custom ganeti errors
494 errcls = GetErrorClass(result[0])
496 return (errcls, tuple(result[1]))
501 def MaybeRaise(result):
502 """If this looks like an encoded Ganeti exception, raise it.
504 This function tries to parse the passed argument and if it looks
505 like an encoding done by EncodeException, it will re-raise it.
508 error = GetEncodedError(result)
510 (errcls, args) = error
511 # pylint: disable=W0142