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.
66 class LockError(GenericError):
67 """Lock error exception.
69 This signifies problems in the locking subsystem.
74 class PidFileLockError(LockError):
75 """PID file is already locked by another process.
80 class HypervisorError(GenericError):
81 """Hypervisor-related exception.
83 This is raised in case we can't communicate with the hypervisor
89 class ProgrammerError(GenericError):
90 """Programming-related error.
92 This is raised in cases we determine that the calling conventions
93 have been violated, meaning we got some desynchronisation between
94 parts of our code. It signifies a real programming bug.
99 class BlockDeviceError(GenericError):
100 """Block-device related exception.
102 This is raised in case we can't setup the instance's block devices
108 class ConfigurationError(GenericError):
109 """Configuration related exception.
111 Things like having an instance with a primary node that doesn't
112 exist in the config or such raise this exception.
117 class ConfigVersionMismatch(ConfigurationError):
118 """Version mismatch in the configuration file.
120 The error has two arguments: the expected and the actual found
126 class ReservationError(GenericError):
127 """Errors reserving a resource.
132 class RemoteError(GenericError):
133 """Programming-related error on remote call.
135 This is raised when an unhandled error occurs in a call to a
136 remote node. It usually signifies a real programming bug.
141 class SignatureError(GenericError):
142 """Error authenticating a remote message.
144 This is raised when the hmac signature on a message doesn't verify correctly
145 to the message itself. It can happen because of network unreliability or
146 because of spurious traffic.
151 class ParameterError(GenericError):
152 """A passed parameter to a command is invalid.
154 This is raised when the parameter passed to a request function is
155 invalid. Correct code should have verified this before passing the
158 The argument to this exception should be the parameter name.
163 class ResultValidationError(GenericError):
164 """The iallocation results fails validation.
169 class OpPrereqError(GenericError):
170 """Prerequisites for the OpCode are not fulfilled.
172 This exception will have either one or two arguments. For the
173 two-argument construction, the second argument should be one of the
179 class OpExecError(GenericError):
180 """Error during OpCode execution.
185 class OpResultError(GenericError):
186 """Issue with OpCode result.
191 class OpCodeUnknown(GenericError):
192 """Unknown opcode submitted.
194 This signifies a mismatch between the definitions on the client and
200 class JobLost(GenericError):
201 """Submitted job lost.
203 The job was submitted but it cannot be found in the current job
209 class JobFileCorrupted(GenericError):
210 """Job file could not be properly decoded/restored.
215 class ResolverError(GenericError):
216 """Host name cannot be resolved.
218 This is not a normal situation for Ganeti, as we rely on having a
221 The non-resolvable hostname is available as the first element of the
222 args tuple; the other two elements of the tuple are the first two
223 args of the socket.gaierror exception (error code and description).
228 class HooksFailure(GenericError):
229 """A generic hook failure.
231 This signifies usually a setup misconfiguration.
236 class HooksAbort(HooksFailure):
237 """A required hook has failed.
239 This caused an abort of the operation in the initial phase. This
240 exception always has an attribute args which is a list of tuples of:
241 - node: the source node on which this hooks has failed
242 - script: the name of the script which aborted the run
247 class UnitParseError(GenericError):
248 """Unable to parse size unit.
253 class ParseError(GenericError):
254 """Generic parse error.
256 Raised when unable to parse user input.
261 class TypeEnforcementError(GenericError):
262 """Unable to enforce data type.
267 class X509CertError(GenericError):
268 """Invalid X509 certificate.
270 This error has two arguments: the certificate filename and the error cause.
275 class TagError(GenericError):
276 """Generic tag error.
278 The argument to this exception will show the exact error.
283 class CommandError(GenericError):
284 """External command error.
289 class StorageError(GenericError):
290 """Storage-related exception.
295 class InotifyError(GenericError):
296 """Error raised when there is a failure setting up an inotify watcher.
301 class QuitGanetiException(Exception):
302 """Signal Ganeti that it must quit.
304 This is not necessarily an error (and thus not a subclass of
305 GenericError), but it's an exceptional circumstance and it is thus
306 treated. This instance should be instantiated with two values. The
307 first one will specify the return code to the caller, and the second
308 one will be the returned result (either as an error or as a normal
309 result). Usually only the leave cluster rpc call should return
310 status True (as there it's expected we quit), every other call will
311 return status False (as a critical error was encountered).
315 # Return a result of "True" to the caller, but quit ganeti afterwards
316 raise QuitGanetiException(True, None)
317 # Send an error to the caller, and quit ganeti
318 raise QuitGanetiException(False, "Fatal safety violation, shutting down")
323 class JobQueueError(GenericError):
329 class JobQueueDrainError(JobQueueError):
330 """Job queue is marked for drain error.
332 This is raised when a job submission attempt is made but the queue
338 class JobQueueFull(JobQueueError):
339 """Job queue full error.
341 Raised when job queue size reached its hard limit.
346 class ConfdMagicError(GenericError):
347 """A magic fourcc error in Ganeti confd.
349 Errors processing the fourcc in ganeti confd datagrams.
354 class ConfdClientError(GenericError):
355 """A magic fourcc error in Ganeti confd.
357 Errors in the confd client library.
362 class UdpDataSizeError(GenericError):
363 """UDP payload too big.
368 class NoCtypesError(GenericError):
369 """python ctypes module is not found in the system.
374 class IPAddressError(GenericError):
375 """Generic IP address error.
380 class LuxiError(GenericError):
386 class QueryFilterParseError(ParseError):
387 """Error while parsing query filter.
390 def GetDetails(self):
391 """Returns a list of strings with details about the error.
395 (_, inner) = self.args
399 return [str(inner.line),
400 (" " * (inner.column - 1)) + "^",
404 class RapiTestResult(GenericError):
405 """Exception containing results from RAPI test utilities.
410 class FileStoragePathError(GenericError):
411 """Error from file storage path validation.
416 # errors should be added above
419 def GetErrorClass(name):
420 """Return the class of an exception.
422 Given the class name, return the class itself.
425 @param name: the exception name
427 @return: the actual class, or None if not found
430 item = globals().get(name, None)
432 if not (isinstance(item, type(Exception)) and
433 issubclass(item, GenericError)):
438 def EncodeException(err):
439 """Encodes an exception into a format that L{MaybeRaise} will recognise.
441 The passed L{err} argument will be formatted as a tuple (exception
442 name, arguments) that the MaybeRaise function will recognise.
444 @type err: GenericError child
445 @param err: usually a child of GenericError (but any exception
448 @return: tuple of (exception name, exception arguments)
451 return (err.__class__.__name__, err.args)
454 def GetEncodedError(result):
455 """If this looks like an encoded Ganeti exception, return it.
457 This function tries to parse the passed argument and if it looks
458 like an encoding done by EncodeException, it will return the class
459 object and arguments.
463 if (isinstance(result, tlt) and len(result) == 2 and
464 isinstance(result[1], tlt)):
465 # custom ganeti errors
466 errcls = GetErrorClass(result[0])
468 return (errcls, tuple(result[1]))
473 def MaybeRaise(result):
474 """If this looks like an encoded Ganeti exception, raise it.
476 This function tries to parse the passed argument and if it looks
477 like an encoding done by EncodeException, it will re-raise it.
480 error = GetEncodedError(result)
482 (errcls, args) = error
483 # pylint: disable=W0142