errors.py 10.2 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Ganeti exception handling"""


25
26
# OpPrereqError failure types

27
28
# resolver errors
ECODE_RESOLVER = "resolver_error"
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# not enough resources (iallocator failure, disk space, memory, etc.)
ECODE_NORES = "insufficient_resources"
# wrong arguments (at syntax level)
ECODE_INVAL = "wrong_input"
# wrong entity state
ECODE_STATE = "wrong_state"
# entity not found
ECODE_NOENT = "unknown_entity"
# entity already exists
ECODE_EXISTS = "already_exists"
# resource not unique (e.g. MAC or IP duplication)
ECODE_NOTUNIQUE = "resource_not_unique"
# internal cluster error
ECODE_FAULT = "internal_error"
# environment error (e.g. node disk error)
ECODE_ENVIRON = "environment_error"

46
47
48
49
50
51
52
53
54
55
56
57
58
#: List of all failure types
ECODE_ALL = frozenset([
  ECODE_RESOLVER,
  ECODE_NORES,
  ECODE_INVAL,
  ECODE_STATE,
  ECODE_NOENT,
  ECODE_EXISTS,
  ECODE_NOTUNIQUE,
  ECODE_FAULT,
  ECODE_ENVIRON,
  ])

59

Iustin Pop's avatar
Iustin Pop committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
class GenericError(Exception):
  """Base exception for Ganeti.

  """
  pass


class LVMError(GenericError):
  """LVM-related exception.

  This exception codifies problems with LVM setup.

  """
  pass


class LockError(GenericError):
  """Lock error exception.

  This signifies problems in the locking subsystem.

  """
  pass


class HypervisorError(GenericError):
  """Hypervisor-related exception.

  This is raised in case we can't communicate with the hypervisor
  properly.

  """
  pass


class ProgrammerError(GenericError):
  """Programming-related error.

  This is raised in cases we determine that the calling conventions
  have been violated, meaning we got some desynchronisation between
  parts of our code. It signifies a real programming bug.

  """
  pass


class BlockDeviceError(GenericError):
  """Block-device related exception.

  This is raised in case we can't setup the instance's block devices
  properly.

  """
  pass


class ConfigurationError(GenericError):
  """Configuration related exception.

  Things like having an instance with a primary node that doesn't
  exist in the config or such raise this exception.

  """
  pass


126
127
128
129
130
131
132
133
134
135
class ConfigVersionMismatch(ConfigurationError):
  """Version mismatch in the configuration file.

  The error has two arguments: the expected and the actual found
  version.

  """
  pass


Guido Trotter's avatar
Guido Trotter committed
136
137
138
139
140
141
class ReservationError(GenericError):
  """Errors reserving a resource.

  """


Iustin Pop's avatar
Iustin Pop committed
142
143
144
145
146
147
148
149
150
151
class RemoteError(GenericError):
  """Programming-related error on remote call.

  This is raised when an unhandled error occurs in a call to a
  remote node.  It usually signifies a real programming bug.

  """
  pass


152
153
154
155
156
157
158
159
160
161
162
class SignatureError(GenericError):
  """Error authenticating a remote message.

  This is raised when the hmac signature on a message doesn't verify correctly
  to the message itself. It can happen because of network unreliability or
  because of spurious traffic.

  """
  pass


Iustin Pop's avatar
Iustin Pop committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class ParameterError(GenericError):
  """A passed parameter to a command is invalid.

  This is raised when the parameter passed to a request function is
  invalid. Correct code should have verified this before passing the
  request structure.

  The argument to this exception should be the parameter name.

  """
  pass


class OpPrereqError(GenericError):
  """Prerequisites for the OpCode are not fulfilled.

179
180
181
182
  This exception will have either one or two arguments. For the
  two-argument construction, the second argument should be one of the
  ECODE_* codes.

Iustin Pop's avatar
Iustin Pop committed
183
184
  """

185

Iustin Pop's avatar
Iustin Pop committed
186
187
188
189
190
class OpExecError(GenericError):
  """Error during OpCode execution.

  """

191

192
193
194
195
196
197
class OpResultError(GenericError):
  """Issue with OpCode result.

  """


Iustin Pop's avatar
Iustin Pop committed
198
199
200
201
202
203
204
205
class OpCodeUnknown(GenericError):
  """Unknown opcode submitted.

  This signifies a mismatch between the definitions on the client and
  server side.

  """

206

207
208
209
210
211
212
213
214
215
class JobLost(GenericError):
  """Submitted job lost.

  The job was submitted but it cannot be found in the current job
  list.

  """


216
217
218
219
220
221
class JobFileCorrupted(GenericError):
  """Job file could not be properly decoded/restored.

  """


222
223
224
225
226
227
228
229
230
231
232
233
234
class ResolverError(GenericError):
  """Host name cannot be resolved.

  This is not a normal situation for Ganeti, as we rely on having a
  working resolver.

  The non-resolvable hostname is available as the first element of the
  args tuple; the other two elements of the tuple are the first two
  args of the socket.gaierror exception (error code and description).

  """


Iustin Pop's avatar
Iustin Pop committed
235
236
237
238
239
240
241
class HooksFailure(GenericError):
  """A generic hook failure.

  This signifies usually a setup misconfiguration.

  """

242

Iustin Pop's avatar
Iustin Pop committed
243
244
245
246
247
248
249
250
251
252
class HooksAbort(HooksFailure):
  """A required hook has failed.

  This caused an abort of the operation in the initial phase. This
  exception always has an attribute args which is a list of tuples of:
    - node: the source node on which this hooks has failed
    - script: the name of the script which aborted the run

  """

253

Iustin Pop's avatar
Iustin Pop committed
254
255
256
257
258
class UnitParseError(GenericError):
  """Unable to parse size unit.

  """

259

260
261
262
263
264
265
266
267
class ParseError(GenericError):
  """Generic parse error.

  Raised when unable to parse user input.

  """


268
269
270
271
class TypeEnforcementError(GenericError):
  """Unable to enforce data type.

  """
Iustin Pop's avatar
Iustin Pop committed
272

273

Iustin Pop's avatar
Iustin Pop committed
274
275
class SshKeyError(GenericError):
  """Invalid SSH key.
276

Iustin Pop's avatar
Iustin Pop committed
277
  """
278
279
280
281
282
283
284
285


class TagError(GenericError):
  """Generic tag error.

  The argument to this exception will show the exact error.

  """
286
287
288
289
290
291


class CommandError(GenericError):
  """External command error.

  """
Guido Trotter's avatar
Guido Trotter committed
292
293


294
295
296
297
298
class StorageError(GenericError):
  """Storage-related exception.

  """

Guido Trotter's avatar
Guido Trotter committed
299
300
301
302
303
304

class InotifyError(GenericError):
  """Error raised when there is a failure setting up an inotify watcher.

  """

305

Guido Trotter's avatar
Guido Trotter committed
306
class QuitGanetiException(Exception):
307
  """Signal Ganeti that it must quit.
Guido Trotter's avatar
Guido Trotter committed
308

309
310
311
312
313
314
315
316
  This is not necessarily an error (and thus not a subclass of
  GenericError), but it's an exceptional circumstance and it is thus
  treated. This instance should be instantiated with two values. The
  first one will specify the return code to the caller, and the second
  one will be the returned result (either as an error or as a normal
  result). Usually only the leave cluster rpc call should return
  status True (as there it's expected we quit), every other call will
  return status False (as a critical error was encountered).
Guido Trotter's avatar
Guido Trotter committed
317

Iustin Pop's avatar
Iustin Pop committed
318
319
  Examples::

Guido Trotter's avatar
Guido Trotter committed
320
    # Return a result of "True" to the caller, but quit ganeti afterwards
321
    raise QuitGanetiException(True, None)
Guido Trotter's avatar
Guido Trotter committed
322
    # Send an error to the caller, and quit ganeti
323
    raise QuitGanetiException(False, "Fatal safety violation, shutting down")
Guido Trotter's avatar
Guido Trotter committed
324
325
326

  """

327

328
class JobQueueError(GenericError):
329
330
331
  """Job queue error.

  """
332
333


334
335
336
337
338
339
340
341
342
class JobQueueDrainError(JobQueueError):
  """Job queue is marked for drain error.

  This is raised when a job submission attempt is made but the queue
  is marked for drain.

  """


Michael Hanselmann's avatar
Michael Hanselmann committed
343
344
345
346
347
348
349
350
class JobQueueFull(JobQueueError):
  """Job queue full error.

  Raised when job queue size reached its hard limit.

  """


Guido Trotter's avatar
Guido Trotter committed
351
352
353
354
355
356
357
358
359
class ConfdRequestError(GenericError):
  """A request error in Ganeti confd.

  Events that should make confd abort the current request and proceed serving
  different ones.

  """


360
361
362
363
364
365
366
367
class ConfdMagicError(GenericError):
  """A magic fourcc error in Ganeti confd.

  Errors processing the fourcc in ganeti confd datagrams.

  """


Guido Trotter's avatar
Guido Trotter committed
368
369
370
371
372
373
374
375
class ConfdClientError(GenericError):
  """A magic fourcc error in Ganeti confd.

  Errors in the confd client library.

  """


376
377
378
379
380
381
class UdpDataSizeError(GenericError):
  """UDP payload too big.

  """


382
383
384
385
386
387
class NoCtypesError(GenericError):
  """python ctypes module is not found in the system.

  """


388
389
390
391
392
393
class IPAddressError(GenericError):
  """Generic IP address error.

  """


394
395
396
397
398
399
class LuxiError(GenericError):
  """LUXI error.

  """


400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
class QueryFilterParseError(ParseError):
  """Error while parsing query filter.

  """
  def GetDetails(self):
    """Returns a list of strings with details about the error.

    """
    try:
      (_, inner) = self.args
    except IndexError:
      return None

    return [str(inner.line),
            (" " * (inner.column - 1)) + "^",
            str(inner)]


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
# errors should be added above


def GetErrorClass(name):
  """Return the class of an exception.

  Given the class name, return the class itself.

  @type name: str
  @param name: the exception name
  @rtype: class
  @return: the actual class, or None if not found

  """
  item = globals().get(name, None)
  if item is not None:
    if not (isinstance(item, type(Exception)) and
            issubclass(item, GenericError)):
      item = None
  return item
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455


def EncodeException(err):
  """Encodes an exception into a format that L{MaybeRaise} will recognise.

  The passed L{err} argument will be formatted as a tuple (exception
  name, arguments) that the MaybeRaise function will recognise.

  @type err: GenericError child
  @param err: usually a child of GenericError (but any exception
      will be accepted)
  @rtype: tuple
  @return: tuple of (exception name, exception arguments)

  """
  return (err.__class__.__name__, err.args)


456
457
def GetEncodedError(result):
  """If this looks like an encoded Ganeti exception, return it.
458
459

  This function tries to parse the passed argument and if it looks
460
461
  like an encoding done by EncodeException, it will return the class
  object and arguments.
462
463
464
465
466
467

  """
  tlt = (tuple, list)
  if (isinstance(result, tlt) and len(result) == 2 and
      isinstance(result[1], tlt)):
    # custom ganeti errors
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
    errcls = GetErrorClass(result[0])
    if errcls:
      return (errcls, tuple(result[1]))

  return None


def MaybeRaise(result):
  """If this looks like an encoded Ganeti exception, raise it.

  This function tries to parse the passed argument and if it looks
  like an encoding done by EncodeException, it will re-raise it.

  """
  error = GetEncodedError(result)
  if error:
    (errcls, args) = error
Michael Hanselmann's avatar
Michael Hanselmann committed
485
    raise errcls(args)