jqueue.py 42.5 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
2
3
#
#

4
# Copyright (C) 2006, 2007, 2008 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
#
# 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.


22
23
"""Module implementing the job queue handling.

24
25
26
27
28
Locking: there's a single, large lock in the L{JobQueue} class. It's
used by all other classes in this module.

@var JOBQUEUE_THREADS: the number of worker threads we start for
    processing jobs
29
30

"""
Iustin Pop's avatar
Iustin Pop committed
31

32
import os
Michael Hanselmann's avatar
Michael Hanselmann committed
33
34
import logging
import threading
35
36
import errno
import re
37
import time
38
import weakref
Iustin Pop's avatar
Iustin Pop committed
39

Michael Hanselmann's avatar
Michael Hanselmann committed
40
from ganeti import constants
41
from ganeti import serializer
Michael Hanselmann's avatar
Michael Hanselmann committed
42
from ganeti import workerpool
43
from ganeti import opcodes
Iustin Pop's avatar
Iustin Pop committed
44
from ganeti import errors
Michael Hanselmann's avatar
Michael Hanselmann committed
45
from ganeti import mcpu
46
from ganeti import utils
47
from ganeti import jstore
48
from ganeti import rpc
Michael Hanselmann's avatar
Michael Hanselmann committed
49

50

51
JOBQUEUE_THREADS = 25
52
JOBS_PER_ARCHIVE_DIRECTORY = 10000
Michael Hanselmann's avatar
Michael Hanselmann committed
53

Iustin Pop's avatar
Iustin Pop committed
54

55
class CancelJob(Exception):
56
57
58
59
60
  """Special exception to cancel a job.

  """


61
def TimeStampNow():
62
63
64
65
66
67
  """Returns the current timestamp.

  @rtype: tuple
  @return: the current time in the (seconds, microseconds) format

  """
68
69
70
  return utils.SplitTime(time.time())


Michael Hanselmann's avatar
Michael Hanselmann committed
71
class _QueuedOpCode(object):
Michael Hanselmann's avatar
Michael Hanselmann committed
72
  """Encapsulates an opcode object.
Michael Hanselmann's avatar
Michael Hanselmann committed
73

74
75
76
77
78
79
  @ivar log: holds the execution log and consists of tuples
  of the form C{(log_serial, timestamp, level, message)}
  @ivar input: the OpCode we encapsulate
  @ivar status: the current status
  @ivar result: the result of the LU execution
  @ivar start_timestamp: timestamp for the start of the execution
Iustin Pop's avatar
Iustin Pop committed
80
  @ivar exec_timestamp: timestamp for the actual LU Exec() function invocation
81
  @ivar stop_timestamp: timestamp for the end of the execution
82

Michael Hanselmann's avatar
Michael Hanselmann committed
83
  """
84
  __slots__ = ["input", "status", "result", "log",
Iustin Pop's avatar
Iustin Pop committed
85
               "start_timestamp", "exec_timestamp", "end_timestamp",
86
87
               "__weakref__"]

Michael Hanselmann's avatar
Michael Hanselmann committed
88
  def __init__(self, op):
89
90
91
92
93
94
    """Constructor for the _QuededOpCode.

    @type op: L{opcodes.OpCode}
    @param op: the opcode we encapsulate

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
95
96
97
98
    self.input = op
    self.status = constants.OP_STATUS_QUEUED
    self.result = None
    self.log = []
99
    self.start_timestamp = None
Iustin Pop's avatar
Iustin Pop committed
100
    self.exec_timestamp = None
101
    self.end_timestamp = None
102
103
104

  @classmethod
  def Restore(cls, state):
105
106
107
108
109
110
111
112
    """Restore the _QueuedOpCode from the serialized form.

    @type state: dict
    @param state: the serialized state
    @rtype: _QueuedOpCode
    @return: a new _QueuedOpCode instance

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
113
114
115
116
117
    obj = _QueuedOpCode.__new__(cls)
    obj.input = opcodes.OpCode.LoadOpCode(state["input"])
    obj.status = state["status"]
    obj.result = state["result"]
    obj.log = state["log"]
118
    obj.start_timestamp = state.get("start_timestamp", None)
Iustin Pop's avatar
Iustin Pop committed
119
    obj.exec_timestamp = state.get("exec_timestamp", None)
120
    obj.end_timestamp = state.get("end_timestamp", None)
121
122
123
    return obj

  def Serialize(self):
124
125
126
127
128
129
    """Serializes this _QueuedOpCode.

    @rtype: dict
    @return: the dictionary holding the serialized state

    """
130
131
132
133
134
    return {
      "input": self.input.__getstate__(),
      "status": self.status,
      "result": self.result,
      "log": self.log,
135
      "start_timestamp": self.start_timestamp,
Iustin Pop's avatar
Iustin Pop committed
136
      "exec_timestamp": self.exec_timestamp,
137
      "end_timestamp": self.end_timestamp,
138
      }
139

Michael Hanselmann's avatar
Michael Hanselmann committed
140
141
142
143

class _QueuedJob(object):
  """In-memory job representation.

144
145
146
147
148
149
150
151
152
153
154
155
156
  This is what we use to track the user-submitted jobs. Locking must
  be taken care of by users of this class.

  @type queue: L{JobQueue}
  @ivar queue: the parent queue
  @ivar id: the job ID
  @type ops: list
  @ivar ops: the list of _QueuedOpCode that constitute the job
  @type log_serial: int
  @ivar log_serial: holds the index for the next log entry
  @ivar received_timestamp: the timestamp for when the job was received
  @ivar start_timestmap: the timestamp for start of execution
  @ivar end_timestamp: the timestamp for end of execution
157
  @ivar lock_status: In-memory locking information for debugging
158
  @ivar change: a Condition variable we use for waiting for job changes
Michael Hanselmann's avatar
Michael Hanselmann committed
159
160

  """
Iustin Pop's avatar
Iustin Pop committed
161
  # pylint: disable-msg=W0212
162
  __slots__ = ["queue", "id", "ops", "log_serial",
163
               "received_timestamp", "start_timestamp", "end_timestamp",
164
               "lock_status", "change",
165
166
               "__weakref__"]

Michael Hanselmann's avatar
Michael Hanselmann committed
167
  def __init__(self, queue, job_id, ops):
168
169
170
171
172
173
174
175
176
177
178
    """Constructor for the _QueuedJob.

    @type queue: L{JobQueue}
    @param queue: our parent queue
    @type job_id: job_id
    @param job_id: our job id
    @type ops: list
    @param ops: the list of opcodes we hold, which will be encapsulated
        in _QueuedOpCodes

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
179
    if not ops:
Guido Trotter's avatar
Guido Trotter committed
180
      raise errors.GenericError("A job needs at least one opcode")
Michael Hanselmann's avatar
Michael Hanselmann committed
181

Michael Hanselmann's avatar
Michael Hanselmann committed
182
    self.queue = queue
183
    self.id = job_id
Michael Hanselmann's avatar
Michael Hanselmann committed
184
    self.ops = [_QueuedOpCode(op) for op in ops]
185
    self.log_serial = 0
186
187
188
    self.received_timestamp = TimeStampNow()
    self.start_timestamp = None
    self.end_timestamp = None
189

190
191
192
    # In-memory attributes
    self.lock_status = None

193
194
    # Condition to wait for changes
    self.change = threading.Condition(self.queue._lock)
195

196
197
198
199
200
201
202
  def __repr__(self):
    status = ["%s.%s" % (self.__class__.__module__, self.__class__.__name__),
              "id=%s" % self.id,
              "ops=%s" % ",".join([op.input.Summary() for op in self.ops])]

    return "<%s at %#x>" % (" ".join(status), id(self))

203
  @classmethod
Michael Hanselmann's avatar
Michael Hanselmann committed
204
  def Restore(cls, queue, state):
205
206
207
208
209
210
211
212
213
214
    """Restore a _QueuedJob from serialized state:

    @type queue: L{JobQueue}
    @param queue: to which queue the restored job belongs
    @type state: dict
    @param state: the serialized state
    @rtype: _JobQueue
    @return: the restored _JobQueue instance

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
215
216
217
    obj = _QueuedJob.__new__(cls)
    obj.queue = queue
    obj.id = state["id"]
218
219
220
    obj.received_timestamp = state.get("received_timestamp", None)
    obj.start_timestamp = state.get("start_timestamp", None)
    obj.end_timestamp = state.get("end_timestamp", None)
221

222
223
224
    # In-memory attributes
    obj.lock_status = None

225
226
227
228
229
230
231
232
233
234
235
    obj.ops = []
    obj.log_serial = 0
    for op_state in state["ops"]:
      op = _QueuedOpCode.Restore(op_state)
      for log_entry in op.log:
        obj.log_serial = max(obj.log_serial, log_entry[0])
      obj.ops.append(op)

    # Condition to wait for changes
    obj.change = threading.Condition(obj.queue._lock)

236
237
238
    return obj

  def Serialize(self):
239
240
241
242
243
244
    """Serialize the _JobQueue instance.

    @rtype: dict
    @return: the serialized state

    """
245
246
    return {
      "id": self.id,
Michael Hanselmann's avatar
Michael Hanselmann committed
247
      "ops": [op.Serialize() for op in self.ops],
248
249
250
      "start_timestamp": self.start_timestamp,
      "end_timestamp": self.end_timestamp,
      "received_timestamp": self.received_timestamp,
251
252
      }

Michael Hanselmann's avatar
Michael Hanselmann committed
253
  def CalcStatus(self):
254
255
256
257
258
259
260
261
262
263
    """Compute the status of this job.

    This function iterates over all the _QueuedOpCodes in the job and
    based on their status, computes the job status.

    The algorithm is:
      - if we find a cancelled, or finished with error, the job
        status will be the same
      - otherwise, the last opcode with the status one of:
          - waitlock
264
          - canceling
265
266
267
268
269
270
271
272
273
274
          - running

        will determine the job status

      - otherwise, it means either all opcodes are queued, or success,
        and the job status will be the same

    @return: the job status

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
275
276
277
    status = constants.JOB_STATUS_QUEUED

    all_success = True
Michael Hanselmann's avatar
Michael Hanselmann committed
278
279
    for op in self.ops:
      if op.status == constants.OP_STATUS_SUCCESS:
Michael Hanselmann's avatar
Michael Hanselmann committed
280
281
282
283
        continue

      all_success = False

Michael Hanselmann's avatar
Michael Hanselmann committed
284
      if op.status == constants.OP_STATUS_QUEUED:
Michael Hanselmann's avatar
Michael Hanselmann committed
285
        pass
Iustin Pop's avatar
Iustin Pop committed
286
287
      elif op.status == constants.OP_STATUS_WAITLOCK:
        status = constants.JOB_STATUS_WAITLOCK
Michael Hanselmann's avatar
Michael Hanselmann committed
288
      elif op.status == constants.OP_STATUS_RUNNING:
Michael Hanselmann's avatar
Michael Hanselmann committed
289
        status = constants.JOB_STATUS_RUNNING
290
291
292
      elif op.status == constants.OP_STATUS_CANCELING:
        status = constants.JOB_STATUS_CANCELING
        break
Michael Hanselmann's avatar
Michael Hanselmann committed
293
      elif op.status == constants.OP_STATUS_ERROR:
294
295
296
        status = constants.JOB_STATUS_ERROR
        # The whole job fails if one opcode failed
        break
Michael Hanselmann's avatar
Michael Hanselmann committed
297
      elif op.status == constants.OP_STATUS_CANCELED:
298
299
        status = constants.OP_STATUS_CANCELED
        break
Michael Hanselmann's avatar
Michael Hanselmann committed
300
301
302
303
304
305

    if all_success:
      status = constants.JOB_STATUS_SUCCESS

    return status

306
  def GetLogEntries(self, newer_than):
307
308
309
    """Selectively returns the log entries.

    @type newer_than: None or int
Michael Hanselmann's avatar
Michael Hanselmann committed
310
    @param newer_than: if this is None, return all log entries,
311
312
313
314
315
316
        otherwise return only the log entries with serial higher
        than this value
    @rtype: list
    @return: the list of the log entries selected

    """
317
318
319
320
321
322
323
    if newer_than is None:
      serial = -1
    else:
      serial = newer_than

    entries = []
    for op in self.ops:
324
      entries.extend(filter(lambda entry: entry[0] > serial, op.log))
325
326
327

    return entries

328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
  def GetInfo(self, fields):
    """Returns information about a job.

    @type fields: list
    @param fields: names of fields to return
    @rtype: list
    @return: list with one element for each field
    @raise errors.OpExecError: when an invalid field
        has been passed

    """
    row = []
    for fname in fields:
      if fname == "id":
        row.append(self.id)
      elif fname == "status":
        row.append(self.CalcStatus())
      elif fname == "ops":
        row.append([op.input.__getstate__() for op in self.ops])
      elif fname == "opresult":
        row.append([op.result for op in self.ops])
      elif fname == "opstatus":
        row.append([op.status for op in self.ops])
      elif fname == "oplog":
        row.append([op.log for op in self.ops])
      elif fname == "opstart":
        row.append([op.start_timestamp for op in self.ops])
      elif fname == "opexec":
        row.append([op.exec_timestamp for op in self.ops])
      elif fname == "opend":
        row.append([op.end_timestamp for op in self.ops])
      elif fname == "received_ts":
        row.append(self.received_timestamp)
      elif fname == "start_ts":
        row.append(self.start_timestamp)
      elif fname == "end_ts":
        row.append(self.end_timestamp)
      elif fname == "lock_status":
        row.append(self.lock_status)
      elif fname == "summary":
        row.append([op.input.Summary() for op in self.ops])
      else:
        raise errors.OpExecError("Invalid self query field '%s'" % fname)
    return row

373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
  def MarkUnfinishedOps(self, status, result):
    """Mark unfinished opcodes with a given status and result.

    This is an utility function for marking all running or waiting to
    be run opcodes with a given status. Opcodes which are already
    finalised are not changed.

    @param status: a given opcode status
    @param result: the opcode result

    """
    not_marked = True
    for op in self.ops:
      if op.status in constants.OPS_FINALIZED:
        assert not_marked, "Finalized opcodes found after non-finalized ones"
        continue
      op.status = status
      op.result = result
      not_marked = False

393

394
class _OpExecCallbacks(mcpu.OpExecCbBase):
395
396
  def __init__(self, queue, job, op):
    """Initializes this class.
397

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
    @type queue: L{JobQueue}
    @param queue: Job queue
    @type job: L{_QueuedJob}
    @param job: Job object
    @type op: L{_QueuedOpCode}
    @param op: OpCode

    """
    assert queue, "Queue is missing"
    assert job, "Job is missing"
    assert op, "Opcode is missing"

    self._queue = queue
    self._job = job
    self._op = op

  def NotifyStart(self):
Iustin Pop's avatar
Iustin Pop committed
415
416
    """Mark the opcode as running, not lock-waiting.

417
418
419
420
    This is called from the mcpu code as a notifier function, when the LU is
    finally about to start the Exec() method. Of course, to have end-user
    visible results, the opcode must be initially (before calling into
    Processor.ExecOpCode) set to OP_STATUS_WAITLOCK.
Iustin Pop's avatar
Iustin Pop committed
421
422

    """
423
    self._queue.acquire()
Iustin Pop's avatar
Iustin Pop committed
424
    try:
425
426
      assert self._op.status in (constants.OP_STATUS_WAITLOCK,
                                 constants.OP_STATUS_CANCELING)
427

428
429
430
      # All locks are acquired by now
      self._job.lock_status = None

431
      # Cancel here if we were asked to
432
      if self._op.status == constants.OP_STATUS_CANCELING:
433
434
        raise CancelJob()

435
      self._op.status = constants.OP_STATUS_RUNNING
Iustin Pop's avatar
Iustin Pop committed
436
      self._op.exec_timestamp = TimeStampNow()
Iustin Pop's avatar
Iustin Pop committed
437
    finally:
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
      self._queue.release()

  def Feedback(self, *args):
    """Append a log entry.

    """
    assert len(args) < 3

    if len(args) == 1:
      log_type = constants.ELOG_MESSAGE
      log_msg = args[0]
    else:
      (log_type, log_msg) = args

    # The time is split to make serialization easier and not lose
    # precision.
    timestamp = utils.SplitTime(time.time())
Iustin Pop's avatar
Iustin Pop committed
455

456
457
458
459
460
461
462
463
464
    self._queue.acquire()
    try:
      self._job.log_serial += 1
      self._op.log.append((self._job.log_serial, timestamp, log_type, log_msg))

      self._job.change.notifyAll()
    finally:
      self._queue.release()

465
466
467
468
469
470
471
472
473
  def ReportLocks(self, msg):
    """Write locking information to the job.

    Called whenever the LU processor is waiting for a lock or has acquired one.

    """
    # Not getting the queue lock because this is a single assignment
    self._job.lock_status = msg

474
475
476
477
478

class _JobQueueWorker(workerpool.BaseWorker):
  """The actual job workers.

  """
Iustin Pop's avatar
Iustin Pop committed
479
  def RunTask(self, job): # pylint: disable-msg=W0221
Michael Hanselmann's avatar
Michael Hanselmann committed
480
481
    """Job executor.

482
483
    This functions processes a job. It is closely tied to the _QueuedJob and
    _QueuedOpCode classes.
Michael Hanselmann's avatar
Michael Hanselmann committed
484

485
486
487
    @type job: L{_QueuedJob}
    @param job: the job to be processed

Michael Hanselmann's avatar
Michael Hanselmann committed
488
    """
489
    logging.info("Processing job %s", job.id)
490
    proc = mcpu.Processor(self.pool.queue.context, job.id)
491
    queue = job.queue
Michael Hanselmann's avatar
Michael Hanselmann committed
492
    try:
Michael Hanselmann's avatar
Michael Hanselmann committed
493
494
495
      try:
        count = len(job.ops)
        for idx, op in enumerate(job.ops):
496
          op_summary = op.input.Summary()
497
498
499
500
501
502
503
504
505
          if op.status == constants.OP_STATUS_SUCCESS:
            # this is a job that was partially completed before master
            # daemon shutdown, so it can be expected that some opcodes
            # are already completed successfully (if any did error
            # out, then the whole job should have been aborted and not
            # resubmitted for processing)
            logging.info("Op %s/%s: opcode %s already processed, skipping",
                         idx + 1, count, op_summary)
            continue
Michael Hanselmann's avatar
Michael Hanselmann committed
506
          try:
507
508
            logging.info("Op %s/%s: Starting opcode %s", idx + 1, count,
                         op_summary)
Michael Hanselmann's avatar
Michael Hanselmann committed
509
510
511

            queue.acquire()
            try:
512
513
              if op.status == constants.OP_STATUS_CANCELED:
                raise CancelJob()
514
              assert op.status == constants.OP_STATUS_QUEUED
Iustin Pop's avatar
Iustin Pop committed
515
              op.status = constants.OP_STATUS_WAITLOCK
Michael Hanselmann's avatar
Michael Hanselmann committed
516
              op.result = None
517
              op.start_timestamp = TimeStampNow()
518
519
              if idx == 0: # first opcode
                job.start_timestamp = op.start_timestamp
Michael Hanselmann's avatar
Michael Hanselmann committed
520
521
              queue.UpdateJobUnlocked(job)

Iustin Pop's avatar
Iustin Pop committed
522
              input_opcode = op.input
Michael Hanselmann's avatar
Michael Hanselmann committed
523
524
525
            finally:
              queue.release()

526
527
            # Make sure not to hold queue lock while calling ExecOpCode
            result = proc.ExecOpCode(input_opcode,
528
                                     _OpExecCallbacks(queue, job, op))
Michael Hanselmann's avatar
Michael Hanselmann committed
529
530
531
532
533

            queue.acquire()
            try:
              op.status = constants.OP_STATUS_SUCCESS
              op.result = result
534
              op.end_timestamp = TimeStampNow()
Michael Hanselmann's avatar
Michael Hanselmann committed
535
536
537
538
              queue.UpdateJobUnlocked(job)
            finally:
              queue.release()

539
540
            logging.info("Op %s/%s: Successfully finished opcode %s",
                         idx + 1, count, op_summary)
541
542
543
          except CancelJob:
            # Will be handled further up
            raise
Michael Hanselmann's avatar
Michael Hanselmann committed
544
545
546
547
548
          except Exception, err:
            queue.acquire()
            try:
              try:
                op.status = constants.OP_STATUS_ERROR
549
550
551
552
                if isinstance(err, errors.GenericError):
                  op.result = errors.EncodeException(err)
                else:
                  op.result = str(err)
553
                op.end_timestamp = TimeStampNow()
554
555
                logging.info("Op %s/%s: Error in opcode %s: %s",
                             idx + 1, count, op_summary, err)
Michael Hanselmann's avatar
Michael Hanselmann committed
556
557
558
559
560
561
              finally:
                queue.UpdateJobUnlocked(job)
            finally:
              queue.release()
            raise

562
563
564
565
566
567
      except CancelJob:
        queue.acquire()
        try:
          queue.CancelJobUnlocked(job)
        finally:
          queue.release()
Michael Hanselmann's avatar
Michael Hanselmann committed
568
569
570
571
      except errors.GenericError, err:
        logging.exception("Ganeti exception")
      except:
        logging.exception("Unhandled exception")
Michael Hanselmann's avatar
Michael Hanselmann committed
572
    finally:
Michael Hanselmann's avatar
Michael Hanselmann committed
573
574
      queue.acquire()
      try:
575
        try:
576
          job.lock_status = None
577
          job.end_timestamp = TimeStampNow()
578
579
580
581
          queue.UpdateJobUnlocked(job)
        finally:
          job_id = job.id
          status = job.CalcStatus()
Michael Hanselmann's avatar
Michael Hanselmann committed
582
583
      finally:
        queue.release()
584

585
      logging.info("Finished job %s, status = %s", job_id, status)
Michael Hanselmann's avatar
Michael Hanselmann committed
586
587
588


class _JobQueueWorkerPool(workerpool.WorkerPool):
589
590
591
  """Simple class implementing a job-processing workerpool.

  """
592
  def __init__(self, queue):
593
594
    super(_JobQueueWorkerPool, self).__init__("JobQueue",
                                              JOBQUEUE_THREADS,
Michael Hanselmann's avatar
Michael Hanselmann committed
595
                                              _JobQueueWorker)
596
    self.queue = queue
Michael Hanselmann's avatar
Michael Hanselmann committed
597
598


Iustin Pop's avatar
Iustin Pop committed
599
600
def _RequireOpenQueue(fn):
  """Decorator for "public" functions.
601

Iustin Pop's avatar
Iustin Pop committed
602
603
604
605
  This function should be used for all 'public' functions. That is,
  functions usually called from other classes. Note that this should
  be applied only to methods (not plain functions), since it expects
  that the decorated function is called with a first argument that has
606
  a '_queue_filelock' argument.
607

Iustin Pop's avatar
Iustin Pop committed
608
  @warning: Use this decorator only after utils.LockedMethod!
609

Iustin Pop's avatar
Iustin Pop committed
610
611
612
613
614
  Example::
    @utils.LockedMethod
    @_RequireOpenQueue
    def Example(self):
      pass
615

Iustin Pop's avatar
Iustin Pop committed
616
617
  """
  def wrapper(self, *args, **kwargs):
Iustin Pop's avatar
Iustin Pop committed
618
    # pylint: disable-msg=W0212
619
    assert self._queue_filelock is not None, "Queue should be open"
Iustin Pop's avatar
Iustin Pop committed
620
621
    return fn(self, *args, **kwargs)
  return wrapper
622
623


Iustin Pop's avatar
Iustin Pop committed
624
625
class JobQueue(object):
  """Queue used to manage the jobs.
626

Iustin Pop's avatar
Iustin Pop committed
627
628
629
630
  @cvar _RE_JOB_FILE: regex matching the valid job file names

  """
  _RE_JOB_FILE = re.compile(r"^job-(%s)$" % constants.JOB_ID_TEMPLATE)
631

Michael Hanselmann's avatar
Michael Hanselmann committed
632
  def __init__(self, context):
633
634
635
636
637
638
639
640
641
642
643
644
    """Constructor for JobQueue.

    The constructor will initialize the job queue object and then
    start loading the current jobs from disk, either for starting them
    (if they were queue) or for aborting them (if they were already
    running).

    @type context: GanetiContext
    @param context: the context object for access to the configuration
        data and other ganeti objects

    """
645
    self.context = context
646
    self._memcache = weakref.WeakValueDictionary()
647
    self._my_hostname = utils.HostInfo().name
648

Michael Hanselmann's avatar
Michael Hanselmann committed
649
650
651
652
653
    # Locking
    self._lock = threading.Lock()
    self.acquire = self._lock.acquire
    self.release = self._lock.release

654
655
656
    # Initialize the queue, and acquire the filelock.
    # This ensures no other process is working on the job queue.
    self._queue_filelock = jstore.InitAndVerifyQueue(must_lock=True)
657

658
659
660
661
    # Read serial file
    self._last_serial = jstore.ReadSerial()
    assert self._last_serial is not None, ("Serial file was modified between"
                                           " check in jstore and here")
662

663
    # Get initial list of nodes
664
    self._nodes = dict((n.name, n.primary_ip)
665
666
                       for n in self.context.cfg.GetAllNodesInfo().values()
                       if n.master_candidate)
667
668

    # Remove master node
669
    self._nodes.pop(self._my_hostname, None)
670
671
672

    # TODO: Check consistency across nodes

673
674
675
676
    self._queue_size = 0
    self._UpdateQueueSizeUnlocked()
    self._drained = self._IsQueueMarkedDrain()

Michael Hanselmann's avatar
Michael Hanselmann committed
677
    # Setup worker pool
678
    self._wpool = _JobQueueWorkerPool(self)
Michael Hanselmann's avatar
Michael Hanselmann committed
679
    try:
680
681
682
683
      # We need to lock here because WorkerPool.AddTask() may start a job while
      # we're still doing our work.
      self.acquire()
      try:
684
685
686
        logging.info("Inspecting job queue")

        all_job_ids = self._GetJobIDsUnlocked()
687
        jobs_count = len(all_job_ids)
688
689
690
        lastinfo = time.time()
        for idx, job_id in enumerate(all_job_ids):
          # Give an update every 1000 jobs or 10 seconds
691
692
          if (idx % 1000 == 0 or time.time() >= (lastinfo + 10.0) or
              idx == (jobs_count - 1)):
693
            logging.info("Job queue inspection: %d/%d (%0.1f %%)",
694
                         idx, jobs_count - 1, 100.0 * (idx + 1) / jobs_count)
695
696
697
698
            lastinfo = time.time()

          job = self._LoadJobUnlocked(job_id)

699
700
701
          # a failure in loading the job can cause 'None' to be returned
          if job is None:
            continue
702

703
          status = job.CalcStatus()
Michael Hanselmann's avatar
Michael Hanselmann committed
704

705
706
          if status in (constants.JOB_STATUS_QUEUED, ):
            self._wpool.AddTask(job)
Michael Hanselmann's avatar
Michael Hanselmann committed
707

708
          elif status in (constants.JOB_STATUS_RUNNING,
709
710
                          constants.JOB_STATUS_WAITLOCK,
                          constants.JOB_STATUS_CANCELING):
711
712
            logging.warning("Unfinished job %s found: %s", job.id, job)
            try:
713
714
              job.MarkUnfinishedOps(constants.OP_STATUS_ERROR,
                                    "Unclean master daemon shutdown")
715
716
            finally:
              self.UpdateJobUnlocked(job)
717
718

        logging.info("Job queue inspection finished")
719
720
721
722
723
      finally:
        self.release()
    except:
      self._wpool.TerminateWorkers()
      raise
Michael Hanselmann's avatar
Michael Hanselmann committed
724

725
726
  @utils.LockedMethod
  @_RequireOpenQueue
727
728
729
730
731
732
733
734
  def AddNode(self, node):
    """Register a new node with the queue.

    @type node: L{objects.Node}
    @param node: the node object to be added

    """
    node_name = node.name
735
    assert node_name != self._my_hostname
736

737
    # Clean queue directory on added node
738
    result = rpc.RpcRunner.call_jobqueue_purge(node_name)
739
    msg = result.fail_msg
740
741
742
    if msg:
      logging.warning("Cannot cleanup queue directory on node %s: %s",
                      node_name, msg)
743

744
745
746
747
748
749
    if not node.master_candidate:
      # remove if existing, ignoring errors
      self._nodes.pop(node_name, None)
      # and skip the replication of the job ids
      return

750
751
    # Upload the whole queue excluding archived jobs
    files = [self._GetJobPath(job_id) for job_id in self._GetJobIDsUnlocked()]
752

753
754
755
756
    # Upload current serial file
    files.append(constants.JOB_QUEUE_SERIAL_FILE)

    for file_name in files:
757
      # Read file content
758
      content = utils.ReadFile(file_name)
759

760
761
762
      result = rpc.RpcRunner.call_jobqueue_update([node_name],
                                                  [node.primary_ip],
                                                  file_name, content)
763
      msg = result[node_name].fail_msg
764
765
766
      if msg:
        logging.error("Failed to upload file %s to node %s: %s",
                      file_name, node_name, msg)
767

768
    self._nodes[node_name] = node.primary_ip
769
770
771
772

  @utils.LockedMethod
  @_RequireOpenQueue
  def RemoveNode(self, node_name):
773
774
775
776
777
778
    """Callback called when removing nodes from the cluster.

    @type node_name: str
    @param node_name: the name of the node to remove

    """
779
    self._nodes.pop(node_name, None)
780

781
782
  @staticmethod
  def _CheckRpcResult(result, nodes, failmsg):
783
784
785
786
    """Verifies the status of an RPC call.

    Since we aim to keep consistency should this node (the current
    master) fail, we will log errors if our rpc fail, and especially
Michael Hanselmann's avatar
Michael Hanselmann committed
787
    log the case when more than half of the nodes fails.
788
789
790
791
792
793
794
795

    @param result: the data as returned from the rpc call
    @type nodes: list
    @param nodes: the list of nodes we made the call to
    @type failmsg: str
    @param failmsg: the identifier to be used for logging

    """
796
797
798
799
    failed = []
    success = []

    for node in nodes:
800
      msg = result[node].fail_msg
801
      if msg:
802
        failed.append(node)
803
804
        logging.error("RPC call %s (%s) failed on node %s: %s",
                      result[node].call, failmsg, node, msg)
805
806
      else:
        success.append(node)
807
808
809
810
811
812

    # +1 for the master node
    if (len(success) + 1) < len(failed):
      # TODO: Handle failing nodes
      logging.error("More than half of the nodes failed")

813
814
815
  def _GetNodeIp(self):
    """Helper for returning the node name/ip list.

816
817
818
819
    @rtype: (list, list)
    @return: a tuple of two lists, the first one with the node
        names and the second one with the node addresses

820
821
822
823
824
    """
    name_list = self._nodes.keys()
    addr_list = [self._nodes[name] for name in name_list]
    return name_list, addr_list

825
  def _UpdateJobQueueFile(self, file_name, data, replicate):
826
827
    """Writes a file locally and then replicates it to all nodes.

828
829
830
831
832
833
834
    This function will replace the contents of a file on the local
    node and then replicate it to all the other nodes we have.

    @type file_name: str
    @param file_name: the path of the file to be replicated
    @type data: str
    @param data: the new contents of the file
835
836
    @type replicate: boolean
    @param replicate: whether to spread the changes to the remote nodes
837

838
839
840
    """
    utils.WriteFile(file_name, data=data)

841
842
843
844
    if replicate:
      names, addrs = self._GetNodeIp()
      result = rpc.RpcRunner.call_jobqueue_update(names, addrs, file_name, data)
      self._CheckRpcResult(result, self._nodes, "Updating %s" % file_name)
845

846
  def _RenameFilesUnlocked(self, rename):
847
848
849
850
851
    """Renames a file locally and then replicate the change.

    This function will rename a file in the local queue directory
    and then replicate this rename to all the other nodes we have.

852
853
    @type rename: list of (old, new)
    @param rename: List containing tuples mapping old to new names
854
855

    """
856
    # Rename them locally
857
858
    for old, new in rename:
      utils.RenameFile(old, new, mkdir=True)
859

860
861
862
863
    # ... and on all nodes
    names, addrs = self._GetNodeIp()
    result = rpc.RpcRunner.call_jobqueue_rename(names, addrs, rename)
    self._CheckRpcResult(result, self._nodes, "Renaming files (%r)" % rename)
864

865
866
  @staticmethod
  def _FormatJobID(job_id):
867
868
869
870
871
872
873
874
875
876
877
878
    """Convert a job ID to string format.

    Currently this just does C{str(job_id)} after performing some
    checks, but if we want to change the job id format this will
    abstract this change.

    @type job_id: int or long
    @param job_id: the numeric job id
    @rtype: str
    @return: the formatted job id

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
879
880
881
882
883
884
885
    if not isinstance(job_id, (int, long)):
      raise errors.ProgrammerError("Job ID '%s' not numeric" % job_id)
    if job_id < 0:
      raise errors.ProgrammerError("Job ID %s is negative" % job_id)

    return str(job_id)

886
887
888
889
890
891
892
893
894
895
896
897
  @classmethod
  def _GetArchiveDirectory(cls, job_id):
    """Returns the archive directory for a job.

    @type job_id: str
    @param job_id: Job identifier
    @rtype: str
    @return: Directory name

    """
    return str(int(job_id) / JOBS_PER_ARCHIVE_DIRECTORY)

Iustin Pop's avatar
Iustin Pop committed
898
  def _NewSerialsUnlocked(self, count):
899
900
901
902
    """Generates a new job identifier.

    Job identifiers are unique during the lifetime of a cluster.

Iustin Pop's avatar
Iustin Pop committed
903
904
    @type count: integer
    @param count: how many serials to return
905
906
    @rtype: str
    @return: a string representing the job identifier.
907
908

    """
Iustin Pop's avatar
Iustin Pop committed
909
    assert count > 0
910
    # New number
Iustin Pop's avatar
Iustin Pop committed
911
    serial = self._last_serial + count
912
913

    # Write to file
914
915
    self._UpdateJobQueueFile(constants.JOB_QUEUE_SERIAL_FILE,
                             "%s\n" % serial, True)
916

Iustin Pop's avatar
Iustin Pop committed
917
918
    result = [self._FormatJobID(v)
              for v in range(self._last_serial, serial + 1)]
919
920
921
    # Keep it only if we were able to write the file
    self._last_serial = serial

Iustin Pop's avatar
Iustin Pop committed
922
    return result
923

Michael Hanselmann's avatar
Michael Hanselmann committed
924
925
  @staticmethod
  def _GetJobPath(job_id):
926
927
928
929
930
931
932
933
    """Returns the job file for a given job id.

    @type job_id: str
    @param job_id: the job identifier
    @rtype: str
    @return: the path to the job file

    """
934
    return utils.PathJoin(constants.QUEUE_DIR, "job-%s" % job_id)
935

936
937
  @classmethod
  def _GetArchivedJobPath(cls, job_id):
938
939
940
941
942
943
944
945
    """Returns the archived job file for a give job id.

    @type job_id: str
    @param job_id: the job identifier
    @rtype: str
    @return: the path to the archived job file

    """
Iustin Pop's avatar
Iustin Pop committed
946
947
    return utils.PathJoin(constants.JOB_QUEUE_ARCHIVE_DIR,
                          cls._GetArchiveDirectory(job_id), "job-%s" % job_id)
948

Guido Trotter's avatar
Guido Trotter committed
949
  def _GetJobIDsUnlocked(self, sort=True):
950
951
    """Return all known job IDs.

Iustin Pop's avatar
Iustin Pop committed
952
953
954
955
    The method only looks at disk because it's a requirement that all
    jobs are present on disk (so in the _memcache we don't have any
    extra IDs).

Guido Trotter's avatar
Guido Trotter committed
956
957
    @type sort: boolean
    @param sort: perform sorting on the returned job ids
958
959
960
    @rtype: list
    @return: the list of job IDs

961
    """
Guido Trotter's avatar
Guido Trotter committed
962
    jlist = []
963
    for filename in utils.ListVisibleFiles(constants.QUEUE_DIR):
Guido Trotter's avatar
Guido Trotter committed
964
965
966
967
968
      m = self._RE_JOB_FILE.match(filename)
      if m:
        jlist.append(m.group(1))
    if sort:
      jlist = utils.NiceSort(jlist)
969
    return jlist
970
971

  def _LoadJobUnlocked(self, job_id):
972
973
974
975
976
977
978
979
980
981
982
    """Loads a job from the disk or memory.

    Given a job id, this will return the cached job object if
    existing, or try to load the job from the disk. If loading from
    disk, it will also add the job to the cache.

    @param job_id: the job id
    @rtype: L{_QueuedJob} or None
    @return: either None or the job object

    """
983
984
    job = self._memcache.get(job_id, None)
    if job:
985
      logging.debug("Found job %s in memcache", job_id)
986
      return job
Iustin Pop's avatar
Iustin Pop committed
987

988
989
990
991
992
993
994
995
996
997
998
999
1000
    try:
      job = self._LoadJobFromDisk(job_id)
    except errors.JobFileCorrupted:
      old_path = self._GetJobPath(job_id)
      new_path = self._GetArchivedJobPath(job_id)
      if old_path == new_path:
        # job already archived (future case)
        logging.exception("Can't parse job %s", job_id)
      else:
        # non-archived case
        logging.exception("Can't parse job %s, will archive.", job_id)
        self._RenameFilesUnlocked([(old_path, new_path)])
      return None
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016

    self._memcache[job_id] = job
    logging.debug("Added job %s to the cache", job_id)
    return job

  def _LoadJobFromDisk(self, job_id):
    """Load the given job file from disk.

    Given a job file, read, load and restore it in a _QueuedJob format.

    @type job_id: string
    @param job_id: job identifier
    @rtype: L{_QueuedJob} or None
    @return: either None or the job object

    """
1017
    filepath = self._GetJobPath(job_id)
1018
1019
    logging.debug("Loading job from %s", filepath)
    try:
1020
      raw_data = utils.ReadFile(filepath)
1021
    except EnvironmentError, err:
1022
1023
1024
      if err.errno in (errno.ENOENT, ):
        return None
      raise
1025

1026
    try:
1027
      data = serializer.LoadJson(raw_data)
1028
      job = _QueuedJob.Restore(self, data)
Iustin Pop's avatar
Iustin Pop committed
1029
    except Exception, err: # pylint: disable-msg=W0703
1030
      raise errors.JobFileCorrupted(err)
1031

Iustin Pop's avatar
Iustin Pop committed
1032
    return job
1033
1034

  def _GetJobsUnlocked(self, job_ids):
1035
1036
1037
1038
1039
1040
1041
1042
1043
    """Return a list of jobs based on their IDs.

    @type job_ids: list
    @param job_ids: either an empty list (meaning all jobs),
        or a list of job IDs
    @rtype: list
    @return: the list of job objects

    """
1044
1045
    if not job_ids:
      job_ids = self._GetJobIDsUnlocked()
1046

1047
    return [self._LoadJobUnlocked(job_id) for job_id in job_ids]
1048

1049
1050
1051
1052
1053
1054
1055
  @staticmethod
  def _IsQueueMarkedDrain():
    """Check if the queue is marked from drain.

    This currently uses the queue drain file, which makes it a
    per-node flag. In the future this can be moved to the config file.

1056
1057
1058
    @rtype: boolean
    @return: True of the job queue is marked for draining

1059
1060
1061
    """
    return os.path.exists(constants.JOB_QUEUE_DRAIN_FILE)

1062
1063
1064
1065
1066
1067
1068
1069
1070
  def _UpdateQueueSizeUnlocked(self):
    """Update the queue size.

    """
    self._queue_size = len(self._GetJobIDsUnlocked(sort=False))

  @utils.LockedMethod
  @_RequireOpenQueue
  def SetDrainFlag(self, drain_flag):
1071
1072
    """Sets the drain flag for the queue.

1073
    @type drain_flag: boolean
Michael Hanselmann's avatar
Michael Hanselmann committed
1074
    @param drain_flag: Whether to set or unset the drain flag
1075

1076
1077
1078
1079
1080
    """
    if drain_flag:
      utils.WriteFile(constants.JOB_QUEUE_DRAIN_FILE, data="", close=True)
    else:
      utils.RemoveFile(constants.JOB_QUEUE_DRAIN_FILE)
1081
1082
1083

    self._drained = drain_flag

1084
1085
    return True

1086
  @_RequireOpenQueue
Iustin Pop's avatar
Iustin Pop committed
1087
  def _SubmitJobUnlocked(self, job_id, ops):
Michael Hanselmann's avatar
Michael Hanselmann committed
1088
    """Create and store a new job.
1089

Michael Hanselmann's avatar
Michael Hanselmann committed
1090
1091
    This enters the job into our job queue and also puts it on the new
    queue, in order for it to be picked up by the queue processors.
1092

Iustin Pop's avatar
Iustin Pop committed
1093
    @type job_id: job ID
1094
    @param job_id: the job ID for the new job
1095
    @type ops: list
1096
    @param ops: The list of OpCodes that will become the new job.
1097
1098
1099
1100
    @rtype: L{_QueuedJob}
    @return: the job object to be queued
    @raise errors.JobQueueDrainError: if the job queue is marked for draining
    @raise errors.JobQueueFull: if the job queue has too many jobs in it
1101
1102

    """
1103
1104
1105
    # Ok when sharing the big job queue lock, as the drain file is created when
    # the lock is exclusive.
    if self._drained:
1106
      raise errors.JobQueueDrainError("Job queue is drained, refusing job")
Michael Hanselmann's avatar
Michael Hanselmann committed
1107

1108
    if self._queue_size >= constants.JOB_QUEUE_SIZE_HARD_LIMIT:
Michael Hanselmann's avatar
Michael Hanselmann committed
1109
1110
      raise errors.JobQueueFull()

1111
1112
1113
    job = _QueuedJob(self, job_id, ops)

    # Write to disk
Michael Hanselmann's avatar
Michael Hanselmann committed
1114
    self.UpdateJobUnlocked(job)
1115

1116
1117
    self._queue_size += 1

1118
    logging.debug("Adding new job %s to the cache", job_id)