4 # Copyright (C) 2006, 2007 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"
47 class GenericError(Exception):
48 """Base exception for Ganeti.
54 class LVMError(GenericError):
55 """LVM-related exception.
57 This exception codifies problems with LVM setup.
63 class LockError(GenericError):
64 """Lock error exception.
66 This signifies problems in the locking subsystem.
72 class HypervisorError(GenericError):
73 """Hypervisor-related exception.
75 This is raised in case we can't communicate with the hypervisor
82 class ProgrammerError(GenericError):
83 """Programming-related error.
85 This is raised in cases we determine that the calling conventions
86 have been violated, meaning we got some desynchronisation between
87 parts of our code. It signifies a real programming bug.
93 class BlockDeviceError(GenericError):
94 """Block-device related exception.
96 This is raised in case we can't setup the instance's block devices
103 class ConfigurationError(GenericError):
104 """Configuration related exception.
106 Things like having an instance with a primary node that doesn't
107 exist in the config or such raise this exception.
113 class RemoteError(GenericError):
114 """Programming-related error on remote call.
116 This is raised when an unhandled error occurs in a call to a
117 remote node. It usually signifies a real programming bug.
123 class SignatureError(GenericError):
124 """Error authenticating a remote message.
126 This is raised when the hmac signature on a message doesn't verify correctly
127 to the message itself. It can happen because of network unreliability or
128 because of spurious traffic.
134 class ParameterError(GenericError):
135 """A passed parameter to a command is invalid.
137 This is raised when the parameter passed to a request function is
138 invalid. Correct code should have verified this before passing the
141 The argument to this exception should be the parameter name.
147 class OpPrereqError(GenericError):
148 """Prerequisites for the OpCode are not fulfilled.
150 This exception will have either one or two arguments. For the
151 two-argument construction, the second argument should be one of the
157 class OpExecError(GenericError):
158 """Error during OpCode execution.
163 class OpCodeUnknown(GenericError):
164 """Unknown opcode submitted.
166 This signifies a mismatch between the definitions on the client and
172 class JobLost(GenericError):
173 """Submitted job lost.
175 The job was submitted but it cannot be found in the current job
181 class ResolverError(GenericError):
182 """Host name cannot be resolved.
184 This is not a normal situation for Ganeti, as we rely on having a
187 The non-resolvable hostname is available as the first element of the
188 args tuple; the other two elements of the tuple are the first two
189 args of the socket.gaierror exception (error code and description).
194 class HooksFailure(GenericError):
195 """A generic hook failure.
197 This signifies usually a setup misconfiguration.
202 class HooksAbort(HooksFailure):
203 """A required hook has failed.
205 This caused an abort of the operation in the initial phase. This
206 exception always has an attribute args which is a list of tuples of:
207 - node: the source node on which this hooks has failed
208 - script: the name of the script which aborted the run
213 class UnitParseError(GenericError):
214 """Unable to parse size unit.
219 class TypeEnforcementError(GenericError):
220 """Unable to enforce data type.
225 class SshKeyError(GenericError):
231 class TagError(GenericError):
232 """Generic tag error.
234 The argument to this exception will show the exact error.
239 class CommandError(GenericError):
240 """External command error.
245 class StorageError(GenericError):
246 """Storage-related exception.
251 class InotifyError(GenericError):
252 """Error raised when there is a failure setting up an inotify watcher.
257 class QuitGanetiException(Exception):
258 """Signal that Ganeti that it must quit.
260 This is not necessarily an error (and thus not a subclass of
261 GenericError), but it's an exceptional circumstance and it is thus
262 treated. This instance should be instantiated with two values. The
263 first one will specify the return code to the caller, and the second
264 one will be the returned result (either as an error or as a normal
265 result). Usually only the leave cluster rpc call should return
266 status True (as there it's expected we quit), every other call will
267 return status False (as a critical error was encountered).
271 # Return a result of "True" to the caller, but quit ganeti afterwards
272 raise QuitGanetiException(True, None)
273 # Send an error to the caller, and quit ganeti
274 raise QuitGanetiException(False, "Fatal safety violation, shutting down")
279 class JobQueueError(GenericError):
285 class JobQueueDrainError(JobQueueError):
286 """Job queue is marked for drain error.
288 This is raised when a job submission attempt is made but the queue
294 class JobQueueFull(JobQueueError):
295 """Job queue full error.
297 Raised when job queue size reached its hard limit.
302 class ConfdFatalError(GenericError):
303 """A fatal failure in Ganeti confd.
305 Events that compromise the ability of confd to proceed further.
306 (for example: inability to load the config file)
311 class ConfdRequestError(GenericError):
312 """A request error in Ganeti confd.
314 Events that should make confd abort the current request and proceed serving
320 class ConfdMagicError(GenericError):
321 """A magic fourcc error in Ganeti confd.
323 Errors processing the fourcc in ganeti confd datagrams.
328 class ConfdClientError(GenericError):
329 """A magic fourcc error in Ganeti confd.
331 Errors in the confd client library.
336 class UdpDataSizeError(GenericError):
337 """UDP payload too big.
342 # errors should be added above
345 def GetErrorClass(name):
346 """Return the class of an exception.
348 Given the class name, return the class itself.
351 @param name: the exception name
353 @return: the actual class, or None if not found
356 item = globals().get(name, None)
358 if not (isinstance(item, type(Exception)) and
359 issubclass(item, GenericError)):
364 def EncodeException(err):
365 """Encodes an exception into a format that L{MaybeRaise} will recognise.
367 The passed L{err} argument will be formatted as a tuple (exception
368 name, arguments) that the MaybeRaise function will recognise.
370 @type err: GenericError child
371 @param err: usually a child of GenericError (but any exception
374 @return: tuple of (exception name, exception arguments)
377 return (err.__class__.__name__, err.args)
380 def MaybeRaise(result):
381 """Is this looks like an encoded Ganeti exception, raise it.
383 This function tries to parse the passed argument and if it looks
384 like an encoding done by EncodeException, it will re-raise it.
388 if (isinstance(result, tlt) and len(result) == 2 and
389 isinstance(result[1], tlt)):
390 # custom ganeti errors
391 err_class = GetErrorClass(result[0])
392 if err_class is not None:
393 raise err_class, tuple(result[1])