workerpool.py 9.86 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
52
53
54
    self.pool = pool
    self._current_task = None

  def ShouldTerminate(self):
55
56
57
    """Returns whether this worker should terminate.

    Should only be called from within L{RunTask}.
58
59

    """
60
61
62
63
64
65
    self.pool._lock.acquire()
    try:
      assert self._HasRunningTaskUnlocked()
      return self.pool._ShouldWorkerTerminateUnlocked(self)
    finally:
      self.pool._lock.release()
66

67
68
69
70
71
72
  def _HasRunningTaskUnlocked(self):
    """Returns whether this worker is currently running a task.

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

73
74
75
76
77
78
79
80
  def run(self):
    """Main thread function.

    Waits for new tasks to show up in the queue.

    """
    pool = self.pool

81
    assert self._current_task is None
82
83
84

    while True:
      try:
85
        # Wait on lock to be told either to terminate or to do a task
86
87
        pool._lock.acquire()
        try:
88
          task = pool._WaitForTaskUnlocked(self)
89

90
91
92
          if task is _TERMINATE:
            # Told to terminate
            break
93

94
95
96
          if task is None:
            # Spurious notification, ignore
            continue
97

98
          self._current_task = task
99

100
          assert self._HasRunningTaskUnlocked()
101
102
103
104
105
        finally:
          pool._lock.release()

        # Run the actual task
        try:
106
          logging.debug("Starting task %r", self._current_task)
107
          self.RunTask(*self._current_task)
108
          logging.debug("Done with task %r", self._current_task)
Iustin Pop's avatar
Iustin Pop committed
109
        except: # pylint: disable-msg=W0702
110
          logging.exception("Caught unhandled exception")
111
112

        assert self._HasRunningTaskUnlocked()
113
114
115
116
      finally:
        # Notify pool
        pool._lock.acquire()
        try:
117
118
          if self._current_task:
            self._current_task = None
119
            pool._worker_to_pool.notifyAll()
120
121
122
        finally:
          pool._lock.release()

123
124
      assert not self._HasRunningTaskUnlocked()

125
    logging.debug("Terminates")
126

127
128
129
  def RunTask(self, *args):
    """Function called to start a task.

130
131
    This needs to be implemented by child classes.

132
133
134
135
136
137
138
139
140
    """
    raise NotImplementedError()


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

  This class is thread-safe.

141
142
143
  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.
144
145

  """
146
  def __init__(self, name, num_workers, worker_class):
147
148
    """Constructor for worker pool.

149
150
151
152
    @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}
153
154
155

    """
    # Some of these variables are accessed by BaseWorker
156
157
158
159
    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)
160
    self._worker_class = worker_class
161
    self._name = name
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    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
177
178
179
180
181
182
183
  def _WaitWhileQuiescingUnlocked(self):
    """Wait until the worker pool has finished quiescing.

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

184
185
186
187
188
189
190
191
  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()

192
  def AddTask(self, args):
193
194
    """Adds a task to the queue.

195
    @type args: sequence
196
    @param args: arguments passed to L{BaseWorker.RunTask}
197
198
199
200

    """
    self._lock.acquire()
    try:
Guido Trotter's avatar
Guido Trotter committed
201
      self._WaitWhileQuiescingUnlocked()
202
      self._AddTaskUnlocked(args)
203
204
205
    finally:
      self._lock.release()

Guido Trotter's avatar
Guido Trotter committed
206
207
208
209
210
211
212
  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}

    """
213
214
215
    assert compat.all(isinstance(task, (tuple, list)) for task in tasks), \
      "Each task must be a sequence"

Guido Trotter's avatar
Guido Trotter committed
216
217
218
219
    self._lock.acquire()
    try:
      self._WaitWhileQuiescingUnlocked()

220
221
      for args in tasks:
        self._AddTaskUnlocked(args)
Guido Trotter's avatar
Guido Trotter committed
222
223
224
    finally:
      self._lock.release()

225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
  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()

258
259
260
261
262
263
264
265
266
267
268
  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
269
      if worker._HasRunningTaskUnlocked(): # pylint: disable-msg=W0212
270
271
272
273
274
275
276
277
278
279
280
281
282
        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():
283
        self._worker_to_pool.wait()
284
285
286
287
288

    finally:
      self._quiescing = False

      # Make sure AddTasks continues in case it was waiting
289
      self._pool_to_pool.notifyAll()
290
291
292
293

      self._lock.release()

  def _NewWorkerIdUnlocked(self):
294
295
296
    """Return an identifier for a new worker.

    """
297
    self._last_worker_id += 1
298
299

    return "%s%d" % (self._name, self._last_worker_id)
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327

  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
328
      self._pool_to_worker.notifyAll()
329
330
331
332
333

      # Join all terminating workers
      self._lock.release()
      try:
        for worker in termworkers:
334
          logging.debug("Waiting for thread %s", worker.getName())
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
          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
352
      for _ in range(num_workers - current_count):
353
354
355
356
357
358
359
        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.

360
    @param num_workers: the new number of workers
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386

    """
    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")