Statistics
| Branch: | Tag: | Revision:

root / lib / errors.py @ b6267745

History | View | Annotate | Download (10.3 kB)

1
#
2
#
3

    
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc.
5
#
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.
10
#
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.
15
#
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
19
# 02110-1301, USA.
20

    
21

    
22
"""Ganeti exception handling"""
23

    
24

    
25
# OpPrereqError failure types
26

    
27
# resolver errors
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"
33
# wrong entity state
34
ECODE_STATE = "wrong_state"
35
# entity not found
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"
45

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

    
59

    
60
class GenericError(Exception):
61
  """Base exception for Ganeti.
62

63
  """
64
  pass
65

    
66

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

70
  This exception codifies problems with LVM setup.
71

72
  """
73
  pass
74

    
75

    
76
class LockError(GenericError):
77
  """Lock error exception.
78

79
  This signifies problems in the locking subsystem.
80

81
  """
82
  pass
83

    
84

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

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

91
  """
92
  pass
93

    
94

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

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

102
  """
103
  pass
104

    
105

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

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

112
  """
113
  pass
114

    
115

    
116
class ConfigurationError(GenericError):
117
  """Configuration related exception.
118

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

122
  """
123
  pass
124

    
125

    
126
class ConfigVersionMismatch(ConfigurationError):
127
  """Version mismatch in the configuration file.
128

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

132
  """
133
  pass
134

    
135

    
136
class ReservationError(GenericError):
137
  """Errors reserving a resource.
138

139
  """
140

    
141

    
142
class RemoteError(GenericError):
143
  """Programming-related error on remote call.
144

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

148
  """
149
  pass
150

    
151

    
152
class SignatureError(GenericError):
153
  """Error authenticating a remote message.
154

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

159
  """
160
  pass
161

    
162

    
163
class ParameterError(GenericError):
164
  """A passed parameter to a command is invalid.
165

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

170
  The argument to this exception should be the parameter name.
171

172
  """
173
  pass
174

    
175

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

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

183
  """
184

    
185

    
186
class OpExecError(GenericError):
187
  """Error during OpCode execution.
188

189
  """
190

    
191

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

195
  """
196

    
197

    
198
class OpCodeUnknown(GenericError):
199
  """Unknown opcode submitted.
200

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

204
  """
205

    
206

    
207
class JobLost(GenericError):
208
  """Submitted job lost.
209

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

213
  """
214

    
215

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

219
  """
220

    
221

    
222
class ResolverError(GenericError):
223
  """Host name cannot be resolved.
224

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

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

232
  """
233

    
234

    
235
class HooksFailure(GenericError):
236
  """A generic hook failure.
237

238
  This signifies usually a setup misconfiguration.
239

240
  """
241

    
242

    
243
class HooksAbort(HooksFailure):
244
  """A required hook has failed.
245

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

251
  """
252

    
253

    
254
class UnitParseError(GenericError):
255
  """Unable to parse size unit.
256

257
  """
258

    
259

    
260
class ParseError(GenericError):
261
  """Generic parse error.
262

263
  Raised when unable to parse user input.
264

265
  """
266

    
267

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

271
  """
272

    
273

    
274
class SshKeyError(GenericError):
275
  """Invalid SSH key.
276

277
  """
278

    
279

    
280
class X509CertError(GenericError):
281
  """Invalid X509 certificate.
282

283
  This error has two arguments: the certificate filename and the error cause.
284

285
  """
286

    
287

    
288
class TagError(GenericError):
289
  """Generic tag error.
290

291
  The argument to this exception will show the exact error.
292

293
  """
294

    
295

    
296
class CommandError(GenericError):
297
  """External command error.
298

299
  """
300

    
301

    
302
class StorageError(GenericError):
303
  """Storage-related exception.
304

305
  """
306

    
307

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

311
  """
312

    
313

    
314
class QuitGanetiException(Exception):
315
  """Signal Ganeti that it must quit.
316

317
  This is not necessarily an error (and thus not a subclass of
318
  GenericError), but it's an exceptional circumstance and it is thus
319
  treated. This instance should be instantiated with two values. The
320
  first one will specify the return code to the caller, and the second
321
  one will be the returned result (either as an error or as a normal
322
  result). Usually only the leave cluster rpc call should return
323
  status True (as there it's expected we quit), every other call will
324
  return status False (as a critical error was encountered).
325

326
  Examples::
327

328
    # Return a result of "True" to the caller, but quit ganeti afterwards
329
    raise QuitGanetiException(True, None)
330
    # Send an error to the caller, and quit ganeti
331
    raise QuitGanetiException(False, "Fatal safety violation, shutting down")
332

333
  """
334

    
335

    
336
class JobQueueError(GenericError):
337
  """Job queue error.
338

339
  """
340

    
341

    
342
class JobQueueDrainError(JobQueueError):
343
  """Job queue is marked for drain error.
344

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

348
  """
349

    
350

    
351
class JobQueueFull(JobQueueError):
352
  """Job queue full error.
353

354
  Raised when job queue size reached its hard limit.
355

356
  """
357

    
358

    
359
class ConfdRequestError(GenericError):
360
  """A request error in Ganeti confd.
361

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

365
  """
366

    
367

    
368
class ConfdMagicError(GenericError):
369
  """A magic fourcc error in Ganeti confd.
370

371
  Errors processing the fourcc in ganeti confd datagrams.
372

373
  """
374

    
375

    
376
class ConfdClientError(GenericError):
377
  """A magic fourcc error in Ganeti confd.
378

379
  Errors in the confd client library.
380

381
  """
382

    
383

    
384
class UdpDataSizeError(GenericError):
385
  """UDP payload too big.
386

387
  """
388

    
389

    
390
class NoCtypesError(GenericError):
391
  """python ctypes module is not found in the system.
392

393
  """
394

    
395

    
396
class IPAddressError(GenericError):
397
  """Generic IP address error.
398

399
  """
400

    
401

    
402
class LuxiError(GenericError):
403
  """LUXI error.
404

405
  """
406

    
407

    
408
class QueryFilterParseError(ParseError):
409
  """Error while parsing query filter.
410

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

415
    """
416
    try:
417
      (_, inner) = self.args
418
    except IndexError:
419
      return None
420

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

    
425

    
426
# errors should be added above
427

    
428

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

432
  Given the class name, return the class itself.
433

434
  @type name: str
435
  @param name: the exception name
436
  @rtype: class
437
  @return: the actual class, or None if not found
438

439
  """
440
  item = globals().get(name, None)
441
  if item is not None:
442
    if not (isinstance(item, type(Exception)) and
443
            issubclass(item, GenericError)):
444
      item = None
445
  return item
446

    
447

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

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

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

460
  """
461
  return (err.__class__.__name__, err.args)
462

    
463

    
464
def GetEncodedError(result):
465
  """If this looks like an encoded Ganeti exception, return it.
466

467
  This function tries to parse the passed argument and if it looks
468
  like an encoding done by EncodeException, it will return the class
469
  object and arguments.
470

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

    
480
  return None
481

    
482

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

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

489
  """
490
  error = GetEncodedError(result)
491
  if error:
492
    (errcls, args) = error
493
    raise errcls(args)