workerpool.py 10.5 KB
Newer Older
1
2
3
#
#

4
# Copyright (C) 2008, 2009, 2010 Google Inc.
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#
# 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.


"""Base classes for worker pools.

"""

import collections
import logging
import threading

30
31
from ganeti import compat

32

33
34
35
_TERMINATE = object()


36
37
38
39
40
41
class BaseWorker(threading.Thread, object):
  """Base worker class for worker pools.

  Users of a worker pool must override RunTask in a subclass.

  """
Iustin Pop's avatar
Iustin Pop committed
42
  # pylint: disable-msg=W0212
43
44
45
  def __init__(self, pool, worker_id):
    """Constructor for BaseWorker thread.

46
47
    @param pool: the parent worker pool
    @param worker_id: identifier for this worker
48
49

    """
50
    super(BaseWorker, self).__init__(name=worker_id)
51
    self.pool = pool
52
    self._worker_id = worker_id
53
54
    self._current_task = None

55
56
    assert self.getName() == worker_id

57
  def ShouldTerminate(self):
58
59
60
    """Returns whether this worker should terminate.

    Should only be called from within L{RunTask}.
61
62

    """
63
64
65
66
67
68
    self.pool._lock.acquire()
    try:
      assert self._HasRunningTaskUnlocked()
      return self.pool._ShouldWorkerTerminateUnlocked(self)
    finally:
      self.pool._lock.release()
69

70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
  def SetTaskName(self, taskname):
    """Sets the name of the current task.

    Should only be called from within L{RunTask}.

    @type taskname: string
    @param taskname: Task's name

    """
    if taskname:
      name = "%s/%s" % (self._worker_id, taskname)
    else:
      name = self._worker_id

    # Set thread name
    self.setName(name)

87
88
89
90
91
92
  def _HasRunningTaskUnlocked(self):
    """Returns whether this worker is currently running a task.

    """
    return (self._current_task is not None)

93
94
95
96
97
98
99
100
101
  def run(self):
    """Main thread function.

    Waits for new tasks to show up in the queue.

    """
    pool = self.pool

    while True:
102
      assert self._current_task is None
103
      try:
104
        # Wait on lock to be told either to terminate or to do a task
105
106
        pool._lock.acquire()
        try:
107
          task = pool._WaitForTaskUnlocked(self)
108

109
110
111
          if task is _TERMINATE:
            # Told to terminate
            break
112

113
114
115
          if task is None:
            # Spurious notification, ignore
            continue
116

117
          self._current_task = task
118

119
120
121
          # No longer needed, dispose of reference
          del task

122
          assert self._HasRunningTaskUnlocked()
123

124
125
126
127
128
        finally:
          pool._lock.release()

        # Run the actual task
        try:
129
          logging.debug("Starting task %r", self._current_task)
130
131
132
133
134
          assert self.getName() == self._worker_id
          try:
            self.RunTask(*self._current_task)
          finally:
            self.SetTaskName(None)
135
          logging.debug("Done with task %r", self._current_task)
Iustin Pop's avatar
Iustin Pop committed
136
        except: # pylint: disable-msg=W0702
137
          logging.exception("Caught unhandled exception")
138
139

        assert self._HasRunningTaskUnlocked()
140
141
142
143
      finally:
        # Notify pool
        pool._lock.acquire()
        try:
144
145
          if self._current_task:
            self._current_task = None
146
            pool._worker_to_pool.notifyAll()
147
148
149
        finally:
          pool._lock.release()

150
151
      assert not self._HasRunningTaskUnlocked()

152
    logging.debug("Terminates")
153

154
155
156
  def RunTask(self, *args):
    """Function called to start a task.

157
158
    This needs to be implemented by child classes.

159
160
161
162
163
164
165
166
167
    """
    raise NotImplementedError()


class WorkerPool(object):
  """Worker pool with a queue.

  This class is thread-safe.

168
169
170
  Tasks are guaranteed to be started in the order in which they're
  added to the pool. Due to the nature of threading, they're not
  guaranteed to finish in the same order.
171
172

  """
173
  def __init__(self, name, num_workers, worker_class):
174
175
    """Constructor for worker pool.

176
177
178
179
    @param num_workers: number of workers to be started
        (dynamic resizing is not yet implemented)
    @param worker_class: the class to be instantiated for workers;
        should derive from L{BaseWorker}
180
181
182

    """
    # Some of these variables are accessed by BaseWorker
183
184
185
186
    self._lock = threading.Lock()
    self._pool_to_pool = threading.Condition(self._lock)
    self._pool_to_worker = threading.Condition(self._lock)
    self._worker_to_pool = threading.Condition(self._lock)
187
    self._worker_class = worker_class
188
    self._name = name
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
    self._last_worker_id = 0
    self._workers = []
    self._quiescing = False

    # Terminating workers
    self._termworkers = []

    # Queued tasks
    self._tasks = collections.deque()

    # Start workers
    self.Resize(num_workers)

  # TODO: Implement dynamic resizing?

Guido Trotter's avatar
Guido Trotter committed
204
205
206
207
208
209
210
  def _WaitWhileQuiescingUnlocked(self):
    """Wait until the worker pool has finished quiescing.

    """
    while self._quiescing:
      self._pool_to_pool.wait()

211
212
213
214
215
216
217
218
  def _AddTaskUnlocked(self, args):
    assert isinstance(args, (tuple, list)), "Arguments must be a sequence"

    self._tasks.append(args)

    # Notify a waiting worker
    self._pool_to_worker.notify()

219
  def AddTask(self, args):
220
221
    """Adds a task to the queue.

222
    @type args: sequence
223
    @param args: arguments passed to L{BaseWorker.RunTask}
224
225
226
227

    """
    self._lock.acquire()
    try:
Guido Trotter's avatar
Guido Trotter committed
228
      self._WaitWhileQuiescingUnlocked()
229
      self._AddTaskUnlocked(args)
230
231
232
    finally:
      self._lock.release()

Guido Trotter's avatar
Guido Trotter committed
233
234
235
236
237
238
239
  def AddManyTasks(self, tasks):
    """Add a list of tasks to the queue.

    @type tasks: list of tuples
    @param tasks: list of args passed to L{BaseWorker.RunTask}

    """
240
241
242
    assert compat.all(isinstance(task, (tuple, list)) for task in tasks), \
      "Each task must be a sequence"

Guido Trotter's avatar
Guido Trotter committed
243
244
245
246
    self._lock.acquire()
    try:
      self._WaitWhileQuiescingUnlocked()

247
248
      for args in tasks:
        self._AddTaskUnlocked(args)
Guido Trotter's avatar
Guido Trotter committed
249
250
251
    finally:
      self._lock.release()

252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
  def _WaitForTaskUnlocked(self, worker):
    """Waits for a task for a worker.

    @type worker: L{BaseWorker}
    @param worker: Worker thread

    """
    if self._ShouldWorkerTerminateUnlocked(worker):
      return _TERMINATE

    # We only wait if there's no task for us.
    if not self._tasks:
      logging.debug("Waiting for tasks")

      # wait() releases the lock and sleeps until notified
      self._pool_to_worker.wait()

      logging.debug("Notified while waiting")

      # Were we woken up in order to terminate?
      if self._ShouldWorkerTerminateUnlocked(worker):
        return _TERMINATE

      if not self._tasks:
        # Spurious notification, ignore
        return None

    # Get task from queue and tell pool about it
    try:
      return self._tasks.popleft()
    finally:
      self._worker_to_pool.notifyAll()

285
286
287
288
289
290
291
292
293
294
295
  def _ShouldWorkerTerminateUnlocked(self, worker):
    """Returns whether a worker should terminate.

    """
    return (worker in self._termworkers)

  def _HasRunningTasksUnlocked(self):
    """Checks whether there's a task running in a worker.

    """
    for worker in self._workers + self._termworkers:
Iustin Pop's avatar
Iustin Pop committed
296
      if worker._HasRunningTaskUnlocked(): # pylint: disable-msg=W0212
297
298
299
300
301
302
303
304
305
306
307
308
309
        return True
    return False

  def Quiesce(self):
    """Waits until the task queue is empty.

    """
    self._lock.acquire()
    try:
      self._quiescing = True

      # Wait while there are tasks pending or running
      while self._tasks or self._HasRunningTasksUnlocked():
310
        self._worker_to_pool.wait()
311
312
313
314
315

    finally:
      self._quiescing = False

      # Make sure AddTasks continues in case it was waiting
316
      self._pool_to_pool.notifyAll()
317
318
319
320

      self._lock.release()

  def _NewWorkerIdUnlocked(self):
321
322
323
    """Return an identifier for a new worker.

    """
324
    self._last_worker_id += 1
325
326

    return "%s%d" % (self._name, self._last_worker_id)
327
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

  def _ResizeUnlocked(self, num_workers):
    """Changes the number of workers.

    """
    assert num_workers >= 0, "num_workers must be >= 0"

    logging.debug("Resizing to %s workers", num_workers)

    current_count = len(self._workers)

    if current_count == num_workers:
      # Nothing to do
      pass

    elif current_count > num_workers:
      if num_workers == 0:
        # Create copy of list to iterate over while lock isn't held.
        termworkers = self._workers[:]
        del self._workers[:]
      else:
        # TODO: Implement partial downsizing
        raise NotImplementedError()
        #termworkers = ...

      self._termworkers += termworkers

      # Notify workers that something has changed
355
      self._pool_to_worker.notifyAll()
356
357
358
359
360

      # Join all terminating workers
      self._lock.release()
      try:
        for worker in termworkers:
361
          logging.debug("Waiting for thread %s", worker.getName())
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
          worker.join()
      finally:
        self._lock.acquire()

      # Remove terminated threads. This could be done in a more efficient way
      # (del self._termworkers[:]), but checking worker.isAlive() makes sure we
      # don't leave zombie threads around.
      for worker in termworkers:
        assert worker in self._termworkers, ("Worker not in list of"
                                             " terminating workers")
        if not worker.isAlive():
          self._termworkers.remove(worker)

      assert not self._termworkers, "Zombie worker detected"

    elif current_count < num_workers:
      # Create (num_workers - current_count) new workers
379
      for _ in range(num_workers - current_count):
380
381
382
383
384
385
386
        worker = self._worker_class(self, self._NewWorkerIdUnlocked())
        self._workers.append(worker)
        worker.start()

  def Resize(self, num_workers):
    """Changes the number of workers in the pool.

387
    @param num_workers: the new number of workers
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413

    """
    self._lock.acquire()
    try:
      return self._ResizeUnlocked(num_workers)
    finally:
      self._lock.release()

  def TerminateWorkers(self):
    """Terminate all worker threads.

    Unstarted tasks will be ignored.

    """
    logging.debug("Terminating all workers")

    self._lock.acquire()
    try:
      self._ResizeUnlocked(0)

      if self._tasks:
        logging.debug("There are %s tasks left", len(self._tasks))
    finally:
      self._lock.release()

    logging.debug("All workers terminated")