Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 1 | # |
| 2 | # Module implementing queues |
| 3 | # |
| 4 | # multiprocessing/queues.py |
| 5 | # |
R. David Murray | 3fc969a | 2010-12-14 01:38:16 +0000 | [diff] [blame] | 6 | # Copyright (c) 2006-2008, R Oudkerk |
Richard Oudkerk | 3e268aa | 2012-04-30 12:13:55 +0100 | [diff] [blame] | 7 | # Licensed to PSF under a Contributor Agreement. |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 8 | # |
| 9 | |
Jesse Noller | 14f3ae2 | 2009-03-31 03:37:07 +0000 | [diff] [blame] | 10 | __all__ = ['Queue', 'SimpleQueue', 'JoinableQueue'] |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 11 | |
| 12 | import sys |
| 13 | import os |
| 14 | import threading |
| 15 | import collections |
| 16 | import time |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 17 | import weakref |
Antoine Pitrou | dc19c24 | 2011-07-16 01:51:58 +0200 | [diff] [blame] | 18 | import errno |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 19 | |
| 20 | from queue import Empty, Full |
| 21 | import _multiprocessing |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 22 | from multiprocessing.connection import Pipe |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 23 | from multiprocessing.synchronize import Lock, BoundedSemaphore, Semaphore, Condition |
| 24 | from multiprocessing.util import debug, info, Finalize, register_after_fork |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 25 | from multiprocessing.forking import assert_spawning, ForkingPickler |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 26 | |
| 27 | # |
| 28 | # Queue type using a pipe, buffer and thread |
| 29 | # |
| 30 | |
| 31 | class Queue(object): |
| 32 | |
| 33 | def __init__(self, maxsize=0): |
| 34 | if maxsize <= 0: |
| 35 | maxsize = _multiprocessing.SemLock.SEM_VALUE_MAX |
| 36 | self._maxsize = maxsize |
| 37 | self._reader, self._writer = Pipe(duplex=False) |
| 38 | self._rlock = Lock() |
| 39 | self._opid = os.getpid() |
| 40 | if sys.platform == 'win32': |
| 41 | self._wlock = None |
| 42 | else: |
| 43 | self._wlock = Lock() |
| 44 | self._sem = BoundedSemaphore(maxsize) |
Antoine Pitrou | dc19c24 | 2011-07-16 01:51:58 +0200 | [diff] [blame] | 45 | # For use by concurrent.futures |
| 46 | self._ignore_epipe = False |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 47 | |
| 48 | self._after_fork() |
| 49 | |
| 50 | if sys.platform != 'win32': |
| 51 | register_after_fork(self, Queue._after_fork) |
| 52 | |
| 53 | def __getstate__(self): |
| 54 | assert_spawning(self) |
Antoine Pitrou | fb96089 | 2011-07-20 02:01:39 +0200 | [diff] [blame] | 55 | return (self._ignore_epipe, self._maxsize, self._reader, self._writer, |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 56 | self._rlock, self._wlock, self._sem, self._opid) |
| 57 | |
| 58 | def __setstate__(self, state): |
Antoine Pitrou | fb96089 | 2011-07-20 02:01:39 +0200 | [diff] [blame] | 59 | (self._ignore_epipe, self._maxsize, self._reader, self._writer, |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 60 | self._rlock, self._wlock, self._sem, self._opid) = state |
| 61 | self._after_fork() |
| 62 | |
| 63 | def _after_fork(self): |
| 64 | debug('Queue._after_fork()') |
| 65 | self._notempty = threading.Condition(threading.Lock()) |
| 66 | self._buffer = collections.deque() |
| 67 | self._thread = None |
| 68 | self._jointhread = None |
| 69 | self._joincancelled = False |
| 70 | self._closed = False |
| 71 | self._close = None |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 72 | self._send_bytes = self._writer.send_bytes |
| 73 | self._recv_bytes = self._reader.recv_bytes |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 74 | self._poll = self._reader.poll |
| 75 | |
| 76 | def put(self, obj, block=True, timeout=None): |
| 77 | assert not self._closed |
| 78 | if not self._sem.acquire(block, timeout): |
| 79 | raise Full |
| 80 | |
| 81 | self._notempty.acquire() |
| 82 | try: |
| 83 | if self._thread is None: |
| 84 | self._start_thread() |
| 85 | self._buffer.append(obj) |
| 86 | self._notempty.notify() |
| 87 | finally: |
| 88 | self._notempty.release() |
| 89 | |
| 90 | def get(self, block=True, timeout=None): |
| 91 | if block and timeout is None: |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 92 | with self._rlock: |
| 93 | res = self._recv_bytes() |
| 94 | self._sem.release() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 95 | else: |
| 96 | if block: |
| 97 | deadline = time.time() + timeout |
| 98 | if not self._rlock.acquire(block, timeout): |
| 99 | raise Empty |
| 100 | try: |
Antoine Pitrou | a365113 | 2011-11-10 00:37:09 +0100 | [diff] [blame] | 101 | if block: |
| 102 | timeout = deadline - time.time() |
| 103 | if timeout < 0 or not self._poll(timeout): |
| 104 | raise Empty |
| 105 | elif not self._poll(): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 106 | raise Empty |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 107 | res = self._recv_bytes() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 108 | self._sem.release() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 109 | finally: |
| 110 | self._rlock.release() |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 111 | # unserialize the data after having released the lock |
| 112 | return ForkingPickler.loads(res) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 113 | |
| 114 | def qsize(self): |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 115 | # Raises NotImplementedError on Mac OSX because of broken sem_getvalue() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 116 | return self._maxsize - self._sem._semlock._get_value() |
| 117 | |
| 118 | def empty(self): |
| 119 | return not self._poll() |
| 120 | |
| 121 | def full(self): |
| 122 | return self._sem._semlock._is_zero() |
| 123 | |
| 124 | def get_nowait(self): |
| 125 | return self.get(False) |
| 126 | |
| 127 | def put_nowait(self, obj): |
| 128 | return self.put(obj, False) |
| 129 | |
| 130 | def close(self): |
| 131 | self._closed = True |
| 132 | self._reader.close() |
| 133 | if self._close: |
| 134 | self._close() |
| 135 | |
| 136 | def join_thread(self): |
| 137 | debug('Queue.join_thread()') |
| 138 | assert self._closed |
| 139 | if self._jointhread: |
| 140 | self._jointhread() |
| 141 | |
| 142 | def cancel_join_thread(self): |
| 143 | debug('Queue.cancel_join_thread()') |
| 144 | self._joincancelled = True |
| 145 | try: |
| 146 | self._jointhread.cancel() |
| 147 | except AttributeError: |
| 148 | pass |
| 149 | |
| 150 | def _start_thread(self): |
| 151 | debug('Queue._start_thread()') |
| 152 | |
| 153 | # Start thread which transfers data from buffer to pipe |
| 154 | self._buffer.clear() |
| 155 | self._thread = threading.Thread( |
| 156 | target=Queue._feed, |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 157 | args=(self._buffer, self._notempty, self._send_bytes, |
Antoine Pitrou | dc19c24 | 2011-07-16 01:51:58 +0200 | [diff] [blame] | 158 | self._wlock, self._writer.close, self._ignore_epipe), |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 159 | name='QueueFeederThread' |
| 160 | ) |
Benjamin Peterson | 7275370 | 2008-08-18 18:09:21 +0000 | [diff] [blame] | 161 | self._thread.daemon = True |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 162 | |
| 163 | debug('doing self._thread.start()') |
| 164 | self._thread.start() |
| 165 | debug('... done self._thread.start()') |
| 166 | |
| 167 | # On process exit we will wait for data to be flushed to pipe. |
| 168 | # |
| 169 | # However, if this process created the queue then all |
| 170 | # processes which use the queue will be descendants of this |
| 171 | # process. Therefore waiting for the queue to be flushed |
| 172 | # is pointless once all the child processes have been joined. |
| 173 | created_by_this_process = (self._opid == os.getpid()) |
| 174 | if not self._joincancelled and not created_by_this_process: |
| 175 | self._jointhread = Finalize( |
| 176 | self._thread, Queue._finalize_join, |
| 177 | [weakref.ref(self._thread)], |
| 178 | exitpriority=-5 |
| 179 | ) |
| 180 | |
| 181 | # Send sentinel to the thread queue object when garbage collected |
| 182 | self._close = Finalize( |
| 183 | self, Queue._finalize_close, |
| 184 | [self._buffer, self._notempty], |
| 185 | exitpriority=10 |
| 186 | ) |
| 187 | |
| 188 | @staticmethod |
| 189 | def _finalize_join(twr): |
| 190 | debug('joining queue thread') |
| 191 | thread = twr() |
| 192 | if thread is not None: |
| 193 | thread.join() |
| 194 | debug('... queue thread joined') |
| 195 | else: |
| 196 | debug('... queue thread already dead') |
| 197 | |
| 198 | @staticmethod |
| 199 | def _finalize_close(buffer, notempty): |
| 200 | debug('telling queue thread to quit') |
| 201 | notempty.acquire() |
| 202 | try: |
| 203 | buffer.append(_sentinel) |
| 204 | notempty.notify() |
| 205 | finally: |
| 206 | notempty.release() |
| 207 | |
| 208 | @staticmethod |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 209 | def _feed(buffer, notempty, send_bytes, writelock, close, ignore_epipe): |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 210 | debug('starting thread to feed data to pipe') |
| 211 | from .util import is_exiting |
| 212 | |
| 213 | nacquire = notempty.acquire |
| 214 | nrelease = notempty.release |
| 215 | nwait = notempty.wait |
| 216 | bpopleft = buffer.popleft |
| 217 | sentinel = _sentinel |
| 218 | if sys.platform != 'win32': |
| 219 | wacquire = writelock.acquire |
| 220 | wrelease = writelock.release |
| 221 | else: |
| 222 | wacquire = None |
| 223 | |
| 224 | try: |
| 225 | while 1: |
| 226 | nacquire() |
| 227 | try: |
| 228 | if not buffer: |
| 229 | nwait() |
| 230 | finally: |
| 231 | nrelease() |
| 232 | try: |
| 233 | while 1: |
| 234 | obj = bpopleft() |
| 235 | if obj is sentinel: |
| 236 | debug('feeder thread got sentinel -- exiting') |
| 237 | close() |
| 238 | return |
| 239 | |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 240 | # serialize the data before acquiring the lock |
| 241 | obj = ForkingPickler.dumps(obj) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 242 | if wacquire is None: |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 243 | send_bytes(obj) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 244 | else: |
| 245 | wacquire() |
| 246 | try: |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 247 | send_bytes(obj) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 248 | finally: |
| 249 | wrelease() |
| 250 | except IndexError: |
| 251 | pass |
| 252 | except Exception as e: |
Antoine Pitrou | dc19c24 | 2011-07-16 01:51:58 +0200 | [diff] [blame] | 253 | if ignore_epipe and getattr(e, 'errno', 0) == errno.EPIPE: |
| 254 | return |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 255 | # Since this runs in a daemon thread the resources it uses |
| 256 | # may be become unusable while the process is cleaning up. |
| 257 | # We ignore errors which happen after the process has |
| 258 | # started to cleanup. |
| 259 | try: |
| 260 | if is_exiting(): |
| 261 | info('error in queue thread: %s', e) |
| 262 | else: |
| 263 | import traceback |
| 264 | traceback.print_exc() |
| 265 | except Exception: |
| 266 | pass |
| 267 | |
| 268 | _sentinel = object() |
| 269 | |
| 270 | # |
| 271 | # A queue type which also supports join() and task_done() methods |
| 272 | # |
| 273 | # Note that if you do not call task_done() for each finished task then |
| 274 | # eventually the counter's semaphore may overflow causing Bad Things |
| 275 | # to happen. |
| 276 | # |
| 277 | |
| 278 | class JoinableQueue(Queue): |
| 279 | |
| 280 | def __init__(self, maxsize=0): |
| 281 | Queue.__init__(self, maxsize) |
| 282 | self._unfinished_tasks = Semaphore(0) |
| 283 | self._cond = Condition() |
| 284 | |
| 285 | def __getstate__(self): |
| 286 | return Queue.__getstate__(self) + (self._cond, self._unfinished_tasks) |
| 287 | |
| 288 | def __setstate__(self, state): |
| 289 | Queue.__setstate__(self, state[:-2]) |
| 290 | self._cond, self._unfinished_tasks = state[-2:] |
| 291 | |
Benjamin Peterson | 8719ad5 | 2009-09-11 22:24:02 +0000 | [diff] [blame] | 292 | def put(self, obj, block=True, timeout=None): |
| 293 | assert not self._closed |
| 294 | if not self._sem.acquire(block, timeout): |
| 295 | raise Full |
| 296 | |
| 297 | self._notempty.acquire() |
| 298 | self._cond.acquire() |
| 299 | try: |
| 300 | if self._thread is None: |
| 301 | self._start_thread() |
| 302 | self._buffer.append(obj) |
| 303 | self._unfinished_tasks.release() |
| 304 | self._notempty.notify() |
| 305 | finally: |
| 306 | self._cond.release() |
| 307 | self._notempty.release() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 308 | |
| 309 | def task_done(self): |
| 310 | self._cond.acquire() |
| 311 | try: |
| 312 | if not self._unfinished_tasks.acquire(False): |
| 313 | raise ValueError('task_done() called too many times') |
| 314 | if self._unfinished_tasks._semlock._is_zero(): |
| 315 | self._cond.notify_all() |
| 316 | finally: |
| 317 | self._cond.release() |
| 318 | |
| 319 | def join(self): |
| 320 | self._cond.acquire() |
| 321 | try: |
| 322 | if not self._unfinished_tasks._semlock._is_zero(): |
| 323 | self._cond.wait() |
| 324 | finally: |
| 325 | self._cond.release() |
| 326 | |
| 327 | # |
| 328 | # Simplified Queue type -- really just a locked pipe |
| 329 | # |
| 330 | |
| 331 | class SimpleQueue(object): |
| 332 | |
| 333 | def __init__(self): |
| 334 | self._reader, self._writer = Pipe(duplex=False) |
| 335 | self._rlock = Lock() |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 336 | self._poll = self._reader.poll |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 337 | if sys.platform == 'win32': |
| 338 | self._wlock = None |
| 339 | else: |
| 340 | self._wlock = Lock() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 341 | |
| 342 | def empty(self): |
Antoine Pitrou | bdb1cf1 | 2012-03-05 19:28:37 +0100 | [diff] [blame] | 343 | return not self._poll() |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 344 | |
| 345 | def __getstate__(self): |
| 346 | assert_spawning(self) |
| 347 | return (self._reader, self._writer, self._rlock, self._wlock) |
| 348 | |
| 349 | def __setstate__(self, state): |
| 350 | (self._reader, self._writer, self._rlock, self._wlock) = state |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 351 | |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 352 | def get(self): |
| 353 | with self._rlock: |
| 354 | res = self._reader.recv_bytes() |
| 355 | # unserialize the data after having released the lock |
| 356 | return ForkingPickler.loads(res) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 357 | |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 358 | def put(self, obj): |
| 359 | # serialize the data before acquiring the lock |
| 360 | obj = ForkingPickler.dumps(obj) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 361 | if self._wlock is None: |
| 362 | # writes to a message oriented win32 pipe are atomic |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 363 | self._writer.send_bytes(obj) |
Benjamin Peterson | e711caf | 2008-06-11 16:44:04 +0000 | [diff] [blame] | 364 | else: |
Charles-François Natali | 84e4316 | 2013-03-25 18:20:40 +0100 | [diff] [blame] | 365 | with self._wlock: |
| 366 | self._writer.send_bytes(obj) |