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 has two arguments: an error message, and one of the
178 class OpExecError(GenericError):
179 """Error during OpCode execution.
184 class OpResultError(GenericError):
185 """Issue with OpCode result.
190 class OpCodeUnknown(GenericError):
191 """Unknown opcode submitted.
193 This signifies a mismatch between the definitions on the client and
199 class JobLost(GenericError):
200 """Submitted job lost.
202 The job was submitted but it cannot be found in the current job
208 class JobFileCorrupted(GenericError):
209 """Job file could not be properly decoded/restored.
214 class ResolverError(GenericError):
215 """Host name cannot be resolved.
217 This is not a normal situation for Ganeti, as we rely on having a
220 The non-resolvable hostname is available as the first element of the
221 args tuple; the other two elements of the tuple are the first two
222 args of the socket.gaierror exception (error code and description).
227 class HooksFailure(GenericError):
228 """A generic hook failure.
230 This signifies usually a setup misconfiguration.
235 class HooksAbort(HooksFailure):
236 """A required hook has failed.
238 This caused an abort of the operation in the initial phase. This
239 exception always has an attribute args which is a list of tuples of:
240 - node: the source node on which this hooks has failed
241 - script: the name of the script which aborted the run
246 class UnitParseError(GenericError):
247 """Unable to parse size unit.
252 class ParseError(GenericError):
253 """Generic parse error.
255 Raised when unable to parse user input.
260 class TypeEnforcementError(GenericError):
261 """Unable to enforce data type.
266 class X509CertError(GenericError):
267 """Invalid X509 certificate.
269 This error has two arguments: the certificate filename and the error cause.
274 class TagError(GenericError):
275 """Generic tag error.
277 The argument to this exception will show the exact error.
282 class CommandError(GenericError):
283 """External command error.
288 class StorageError(GenericError):
289 """Storage-related exception.
294 class InotifyError(GenericError):
295 """Error raised when there is a failure setting up an inotify watcher.
300 class QuitGanetiException(Exception):
301 """Signal Ganeti that it must quit.
303 This is not necessarily an error (and thus not a subclass of
304 GenericError), but it's an exceptional circumstance and it is thus
305 treated. This exception should be instantiated with two values. The
306 first one will specify the return code to the caller, and the second
307 one will be the returned result (either as an error or as a normal
308 result). Usually only the leave cluster rpc call should return
309 status True (as there it's expected we quit), every other call will
310 return status False (as a critical error was encountered).
314 # Return a result of "True" to the caller, but quit ganeti afterwards
315 raise QuitGanetiException(True, None)
316 # Send an error to the caller, and quit ganeti
317 raise QuitGanetiException(False, "Fatal safety violation, shutting down")
322 class JobQueueError(GenericError):
328 class JobQueueDrainError(JobQueueError):
329 """Job queue is marked for drain error.
331 This is raised when a job submission attempt is made but the queue
337 class JobQueueFull(JobQueueError):
338 """Job queue full error.
340 Raised when job queue size reached its hard limit.
345 class ConfdMagicError(GenericError):
346 """A magic fourcc error in Ganeti confd.
348 Errors processing the fourcc in ganeti confd datagrams.
353 class ConfdClientError(GenericError):
354 """A magic fourcc error in Ganeti confd.
356 Errors in the confd client library.
361 class UdpDataSizeError(GenericError):
362 """UDP payload too big.
367 class NoCtypesError(GenericError):
368 """python ctypes module is not found in the system.
373 class IPAddressError(GenericError):
374 """Generic IP address error.
379 class LuxiError(GenericError):
385 class QueryFilterParseError(ParseError):
386 """Error while parsing query filter.
388 This exception must be instantiated with two values. The first one is a
389 string with an error description, the second one is an instance of a subclass
390 of C{pyparsing.ParseBaseException} (used to display the exact error
394 def GetDetails(self):
395 """Returns a list of strings with details about the error.
399 (_, inner) = self.args
403 return [str(inner.line),
404 (" " * (inner.column - 1)) + "^",
408 class RapiTestResult(GenericError):
409 """Exception containing results from RAPI test utilities.
414 class FileStoragePathError(GenericError):
415 """Error from file storage path validation.
420 # errors should be added above
423 def GetErrorClass(name):
424 """Return the class of an exception.
426 Given the class name, return the class itself.
429 @param name: the exception name
431 @return: the actual class, or None if not found
434 item = globals().get(name, None)
436 if not (isinstance(item, type(Exception)) and
437 issubclass(item, GenericError)):
442 def EncodeException(err):
443 """Encodes an exception into a format that L{MaybeRaise} will recognise.
445 The passed L{err} argument will be formatted as a tuple (exception
446 name, arguments) that the MaybeRaise function will recognise.
448 @type err: GenericError child
449 @param err: usually a child of GenericError (but any exception
452 @return: tuple of (exception name, exception arguments)
455 return (err.__class__.__name__, err.args)
458 def GetEncodedError(result):
459 """If this looks like an encoded Ganeti exception, return it.
461 This function tries to parse the passed argument and if it looks
462 like an encoding done by EncodeException, it will return the class
463 object and arguments.
467 if (isinstance(result, tlt) and len(result) == 2 and
468 isinstance(result[1], tlt)):
469 # custom ganeti errors
470 errcls = GetErrorClass(result[0])
472 return (errcls, tuple(result[1]))
477 def MaybeRaise(result):
478 """If this looks like an encoded Ganeti exception, raise it.
480 This function tries to parse the passed argument and if it looks
481 like an encoding done by EncodeException, it will re-raise it.
484 error = GetEncodedError(result)
486 (errcls, args) = error
487 # pylint: disable=W0142