Statistics
| Branch: | Tag: | Revision:

root / gnuradio-core / src / python / gnuradio / gr / gr_threading_23.py @ 7fce7e3b

History | View | Annotate | Download (21.4 kB)

1 5d69a524 jcorgan
"""Thread module emulating a subset of Java's threading model."""
2 5d69a524 jcorgan
3 5d69a524 jcorgan
# This started life as the threading.py module of Python 2.3
4 5d69a524 jcorgan
# It's been patched to fix a problem with join, where a KeyboardInterrupt
5 5d69a524 jcorgan
# caused a lock to be left in the acquired state.
6 5d69a524 jcorgan
7 5d69a524 jcorgan
import sys as _sys
8 5d69a524 jcorgan
9 5d69a524 jcorgan
try:
10 5d69a524 jcorgan
    import thread
11 5d69a524 jcorgan
except ImportError:
12 5d69a524 jcorgan
    del _sys.modules[__name__]
13 5d69a524 jcorgan
    raise
14 5d69a524 jcorgan
15 5d69a524 jcorgan
from StringIO import StringIO as _StringIO
16 5d69a524 jcorgan
from time import time as _time, sleep as _sleep
17 5d69a524 jcorgan
from traceback import print_exc as _print_exc
18 5d69a524 jcorgan
19 5d69a524 jcorgan
# Rename some stuff so "from threading import *" is safe
20 5d69a524 jcorgan
__all__ = ['activeCount', 'Condition', 'currentThread', 'enumerate', 'Event',
21 5d69a524 jcorgan
           'Lock', 'RLock', 'Semaphore', 'BoundedSemaphore', 'Thread',
22 5d69a524 jcorgan
           'Timer', 'setprofile', 'settrace']
23 5d69a524 jcorgan
24 5d69a524 jcorgan
_start_new_thread = thread.start_new_thread
25 5d69a524 jcorgan
_allocate_lock = thread.allocate_lock
26 5d69a524 jcorgan
_get_ident = thread.get_ident
27 5d69a524 jcorgan
ThreadError = thread.error
28 5d69a524 jcorgan
del thread
29 5d69a524 jcorgan
30 5d69a524 jcorgan
31 5d69a524 jcorgan
# Debug support (adapted from ihooks.py).
32 5d69a524 jcorgan
# All the major classes here derive from _Verbose.  We force that to
33 5d69a524 jcorgan
# be a new-style class so that all the major classes here are new-style.
34 5d69a524 jcorgan
# This helps debugging (type(instance) is more revealing for instances
35 5d69a524 jcorgan
# of new-style classes).
36 5d69a524 jcorgan
37 5d69a524 jcorgan
_VERBOSE = False
38 5d69a524 jcorgan
39 5d69a524 jcorgan
if __debug__:
40 5d69a524 jcorgan
41 5d69a524 jcorgan
    class _Verbose(object):
42 5d69a524 jcorgan
43 5d69a524 jcorgan
        def __init__(self, verbose=None):
44 5d69a524 jcorgan
            if verbose is None:
45 5d69a524 jcorgan
                verbose = _VERBOSE
46 5d69a524 jcorgan
            self.__verbose = verbose
47 5d69a524 jcorgan
48 5d69a524 jcorgan
        def _note(self, format, *args):
49 5d69a524 jcorgan
            if self.__verbose:
50 5d69a524 jcorgan
                format = format % args
51 5d69a524 jcorgan
                format = "%s: %s\n" % (
52 5d69a524 jcorgan
                    currentThread().getName(), format)
53 5d69a524 jcorgan
                _sys.stderr.write(format)
54 5d69a524 jcorgan
55 5d69a524 jcorgan
else:
56 5d69a524 jcorgan
    # Disable this when using "python -O"
57 5d69a524 jcorgan
    class _Verbose(object):
58 5d69a524 jcorgan
        def __init__(self, verbose=None):
59 5d69a524 jcorgan
            pass
60 5d69a524 jcorgan
        def _note(self, *args):
61 5d69a524 jcorgan
            pass
62 5d69a524 jcorgan
63 5d69a524 jcorgan
# Support for profile and trace hooks
64 5d69a524 jcorgan
65 5d69a524 jcorgan
_profile_hook = None
66 5d69a524 jcorgan
_trace_hook = None
67 5d69a524 jcorgan
68 5d69a524 jcorgan
def setprofile(func):
69 5d69a524 jcorgan
    global _profile_hook
70 5d69a524 jcorgan
    _profile_hook = func
71 5d69a524 jcorgan
72 5d69a524 jcorgan
def settrace(func):
73 5d69a524 jcorgan
    global _trace_hook
74 5d69a524 jcorgan
    _trace_hook = func
75 5d69a524 jcorgan
76 5d69a524 jcorgan
# Synchronization classes
77 5d69a524 jcorgan
78 5d69a524 jcorgan
Lock = _allocate_lock
79 5d69a524 jcorgan
80 5d69a524 jcorgan
def RLock(*args, **kwargs):
81 5d69a524 jcorgan
    return _RLock(*args, **kwargs)
82 5d69a524 jcorgan
83 5d69a524 jcorgan
class _RLock(_Verbose):
84 5d69a524 jcorgan
85 5d69a524 jcorgan
    def __init__(self, verbose=None):
86 5d69a524 jcorgan
        _Verbose.__init__(self, verbose)
87 5d69a524 jcorgan
        self.__block = _allocate_lock()
88 5d69a524 jcorgan
        self.__owner = None
89 5d69a524 jcorgan
        self.__count = 0
90 5d69a524 jcorgan
91 5d69a524 jcorgan
    def __repr__(self):
92 5d69a524 jcorgan
        return "<%s(%s, %d)>" % (
93 5d69a524 jcorgan
                self.__class__.__name__,
94 5d69a524 jcorgan
                self.__owner and self.__owner.getName(),
95 5d69a524 jcorgan
                self.__count)
96 5d69a524 jcorgan
97 5d69a524 jcorgan
    def acquire(self, blocking=1):
98 5d69a524 jcorgan
        me = currentThread()
99 5d69a524 jcorgan
        if self.__owner is me:
100 5d69a524 jcorgan
            self.__count = self.__count + 1
101 5d69a524 jcorgan
            if __debug__:
102 5d69a524 jcorgan
                self._note("%s.acquire(%s): recursive success", self, blocking)
103 5d69a524 jcorgan
            return 1
104 5d69a524 jcorgan
        rc = self.__block.acquire(blocking)
105 5d69a524 jcorgan
        if rc:
106 5d69a524 jcorgan
            self.__owner = me
107 5d69a524 jcorgan
            self.__count = 1
108 5d69a524 jcorgan
            if __debug__:
109 5d69a524 jcorgan
                self._note("%s.acquire(%s): initial succes", self, blocking)
110 5d69a524 jcorgan
        else:
111 5d69a524 jcorgan
            if __debug__:
112 5d69a524 jcorgan
                self._note("%s.acquire(%s): failure", self, blocking)
113 5d69a524 jcorgan
        return rc
114 5d69a524 jcorgan
115 5d69a524 jcorgan
    def release(self):
116 5d69a524 jcorgan
        me = currentThread()
117 5d69a524 jcorgan
        assert self.__owner is me, "release() of un-acquire()d lock"
118 5d69a524 jcorgan
        self.__count = count = self.__count - 1
119 5d69a524 jcorgan
        if not count:
120 5d69a524 jcorgan
            self.__owner = None
121 5d69a524 jcorgan
            self.__block.release()
122 5d69a524 jcorgan
            if __debug__:
123 5d69a524 jcorgan
                self._note("%s.release(): final release", self)
124 5d69a524 jcorgan
        else:
125 5d69a524 jcorgan
            if __debug__:
126 5d69a524 jcorgan
                self._note("%s.release(): non-final release", self)
127 5d69a524 jcorgan
128 5d69a524 jcorgan
    # Internal methods used by condition variables
129 5d69a524 jcorgan
130 5d69a524 jcorgan
    def _acquire_restore(self, (count, owner)):
131 5d69a524 jcorgan
        self.__block.acquire()
132 5d69a524 jcorgan
        self.__count = count
133 5d69a524 jcorgan
        self.__owner = owner
134 5d69a524 jcorgan
        if __debug__:
135 5d69a524 jcorgan
            self._note("%s._acquire_restore()", self)
136 5d69a524 jcorgan
137 5d69a524 jcorgan
    def _release_save(self):
138 5d69a524 jcorgan
        if __debug__:
139 5d69a524 jcorgan
            self._note("%s._release_save()", self)
140 5d69a524 jcorgan
        count = self.__count
141 5d69a524 jcorgan
        self.__count = 0
142 5d69a524 jcorgan
        owner = self.__owner
143 5d69a524 jcorgan
        self.__owner = None
144 5d69a524 jcorgan
        self.__block.release()
145 5d69a524 jcorgan
        return (count, owner)
146 5d69a524 jcorgan
147 5d69a524 jcorgan
    def _is_owned(self):
148 5d69a524 jcorgan
        return self.__owner is currentThread()
149 5d69a524 jcorgan
150 5d69a524 jcorgan
151 5d69a524 jcorgan
def Condition(*args, **kwargs):
152 5d69a524 jcorgan
    return _Condition(*args, **kwargs)
153 5d69a524 jcorgan
154 5d69a524 jcorgan
class _Condition(_Verbose):
155 5d69a524 jcorgan
156 5d69a524 jcorgan
    def __init__(self, lock=None, verbose=None):
157 5d69a524 jcorgan
        _Verbose.__init__(self, verbose)
158 5d69a524 jcorgan
        if lock is None:
159 5d69a524 jcorgan
            lock = RLock()
160 5d69a524 jcorgan
        self.__lock = lock
161 5d69a524 jcorgan
        # Export the lock's acquire() and release() methods
162 5d69a524 jcorgan
        self.acquire = lock.acquire
163 5d69a524 jcorgan
        self.release = lock.release
164 5d69a524 jcorgan
        # If the lock defines _release_save() and/or _acquire_restore(),
165 5d69a524 jcorgan
        # these override the default implementations (which just call
166 5d69a524 jcorgan
        # release() and acquire() on the lock).  Ditto for _is_owned().
167 5d69a524 jcorgan
        try:
168 5d69a524 jcorgan
            self._release_save = lock._release_save
169 5d69a524 jcorgan
        except AttributeError:
170 5d69a524 jcorgan
            pass
171 5d69a524 jcorgan
        try:
172 5d69a524 jcorgan
            self._acquire_restore = lock._acquire_restore
173 5d69a524 jcorgan
        except AttributeError:
174 5d69a524 jcorgan
            pass
175 5d69a524 jcorgan
        try:
176 5d69a524 jcorgan
            self._is_owned = lock._is_owned
177 5d69a524 jcorgan
        except AttributeError:
178 5d69a524 jcorgan
            pass
179 5d69a524 jcorgan
        self.__waiters = []
180 5d69a524 jcorgan
181 5d69a524 jcorgan
    def __repr__(self):
182 5d69a524 jcorgan
        return "<Condition(%s, %d)>" % (self.__lock, len(self.__waiters))
183 5d69a524 jcorgan
184 5d69a524 jcorgan
    def _release_save(self):
185 5d69a524 jcorgan
        self.__lock.release()           # No state to save
186 5d69a524 jcorgan
187 5d69a524 jcorgan
    def _acquire_restore(self, x):
188 5d69a524 jcorgan
        self.__lock.acquire()           # Ignore saved state
189 5d69a524 jcorgan
190 5d69a524 jcorgan
    def _is_owned(self):
191 5d69a524 jcorgan
        # Return True if lock is owned by currentThread.
192 5d69a524 jcorgan
        # This method is called only if __lock doesn't have _is_owned().
193 5d69a524 jcorgan
        if self.__lock.acquire(0):
194 5d69a524 jcorgan
            self.__lock.release()
195 5d69a524 jcorgan
            return False
196 5d69a524 jcorgan
        else:
197 5d69a524 jcorgan
            return True
198 5d69a524 jcorgan
199 5d69a524 jcorgan
    def wait(self, timeout=None):
200 5d69a524 jcorgan
        currentThread() # for side-effect
201 5d69a524 jcorgan
        assert self._is_owned(), "wait() of un-acquire()d lock"
202 5d69a524 jcorgan
        waiter = _allocate_lock()
203 5d69a524 jcorgan
        waiter.acquire()
204 5d69a524 jcorgan
        self.__waiters.append(waiter)
205 5d69a524 jcorgan
        saved_state = self._release_save()
206 5d69a524 jcorgan
        try:    # restore state no matter what (e.g., KeyboardInterrupt)
207 5d69a524 jcorgan
            if timeout is None:
208 5d69a524 jcorgan
                waiter.acquire()
209 5d69a524 jcorgan
                if __debug__:
210 5d69a524 jcorgan
                    self._note("%s.wait(): got it", self)
211 5d69a524 jcorgan
            else:
212 5d69a524 jcorgan
                # Balancing act:  We can't afford a pure busy loop, so we
213 5d69a524 jcorgan
                # have to sleep; but if we sleep the whole timeout time,
214 5d69a524 jcorgan
                # we'll be unresponsive.  The scheme here sleeps very
215 5d69a524 jcorgan
                # little at first, longer as time goes on, but never longer
216 5d69a524 jcorgan
                # than 20 times per second (or the timeout time remaining).
217 5d69a524 jcorgan
                endtime = _time() + timeout
218 5d69a524 jcorgan
                delay = 0.0005 # 500 us -> initial delay of 1 ms
219 5d69a524 jcorgan
                while True:
220 5d69a524 jcorgan
                    gotit = waiter.acquire(0)
221 5d69a524 jcorgan
                    if gotit:
222 5d69a524 jcorgan
                        break
223 5d69a524 jcorgan
                    remaining = endtime - _time()
224 5d69a524 jcorgan
                    if remaining <= 0:
225 5d69a524 jcorgan
                        break
226 5d69a524 jcorgan
                    delay = min(delay * 2, remaining, .05)
227 5d69a524 jcorgan
                    _sleep(delay)
228 5d69a524 jcorgan
                if not gotit:
229 5d69a524 jcorgan
                    if __debug__:
230 5d69a524 jcorgan
                        self._note("%s.wait(%s): timed out", self, timeout)
231 5d69a524 jcorgan
                    try:
232 5d69a524 jcorgan
                        self.__waiters.remove(waiter)
233 5d69a524 jcorgan
                    except ValueError:
234 5d69a524 jcorgan
                        pass
235 5d69a524 jcorgan
                else:
236 5d69a524 jcorgan
                    if __debug__:
237 5d69a524 jcorgan
                        self._note("%s.wait(%s): got it", self, timeout)
238 5d69a524 jcorgan
        finally:
239 5d69a524 jcorgan
            self._acquire_restore(saved_state)
240 5d69a524 jcorgan
241 5d69a524 jcorgan
    def notify(self, n=1):
242 5d69a524 jcorgan
        currentThread() # for side-effect
243 5d69a524 jcorgan
        assert self._is_owned(), "notify() of un-acquire()d lock"
244 5d69a524 jcorgan
        __waiters = self.__waiters
245 5d69a524 jcorgan
        waiters = __waiters[:n]
246 5d69a524 jcorgan
        if not waiters:
247 5d69a524 jcorgan
            if __debug__:
248 5d69a524 jcorgan
                self._note("%s.notify(): no waiters", self)
249 5d69a524 jcorgan
            return
250 5d69a524 jcorgan
        self._note("%s.notify(): notifying %d waiter%s", self, n,
251 5d69a524 jcorgan
                   n!=1 and "s" or "")
252 5d69a524 jcorgan
        for waiter in waiters:
253 5d69a524 jcorgan
            waiter.release()
254 5d69a524 jcorgan
            try:
255 5d69a524 jcorgan
                __waiters.remove(waiter)
256 5d69a524 jcorgan
            except ValueError:
257 5d69a524 jcorgan
                pass
258 5d69a524 jcorgan
259 5d69a524 jcorgan
    def notifyAll(self):
260 5d69a524 jcorgan
        self.notify(len(self.__waiters))
261 5d69a524 jcorgan
262 5d69a524 jcorgan
263 5d69a524 jcorgan
def Semaphore(*args, **kwargs):
264 5d69a524 jcorgan
    return _Semaphore(*args, **kwargs)
265 5d69a524 jcorgan
266 5d69a524 jcorgan
class _Semaphore(_Verbose):
267 5d69a524 jcorgan
268 5d69a524 jcorgan
    # After Tim Peters' semaphore class, but not quite the same (no maximum)
269 5d69a524 jcorgan
270 5d69a524 jcorgan
    def __init__(self, value=1, verbose=None):
271 5d69a524 jcorgan
        assert value >= 0, "Semaphore initial value must be >= 0"
272 5d69a524 jcorgan
        _Verbose.__init__(self, verbose)
273 5d69a524 jcorgan
        self.__cond = Condition(Lock())
274 5d69a524 jcorgan
        self.__value = value
275 5d69a524 jcorgan
276 5d69a524 jcorgan
    def acquire(self, blocking=1):
277 5d69a524 jcorgan
        rc = False
278 5d69a524 jcorgan
        self.__cond.acquire()
279 5d69a524 jcorgan
        while self.__value == 0:
280 5d69a524 jcorgan
            if not blocking:
281 5d69a524 jcorgan
                break
282 5d69a524 jcorgan
            if __debug__:
283 5d69a524 jcorgan
                self._note("%s.acquire(%s): blocked waiting, value=%s",
284 5d69a524 jcorgan
                           self, blocking, self.__value)
285 5d69a524 jcorgan
            self.__cond.wait()
286 5d69a524 jcorgan
        else:
287 5d69a524 jcorgan
            self.__value = self.__value - 1
288 5d69a524 jcorgan
            if __debug__:
289 5d69a524 jcorgan
                self._note("%s.acquire: success, value=%s",
290 5d69a524 jcorgan
                           self, self.__value)
291 5d69a524 jcorgan
            rc = True
292 5d69a524 jcorgan
        self.__cond.release()
293 5d69a524 jcorgan
        return rc
294 5d69a524 jcorgan
295 5d69a524 jcorgan
    def release(self):
296 5d69a524 jcorgan
        self.__cond.acquire()
297 5d69a524 jcorgan
        self.__value = self.__value + 1
298 5d69a524 jcorgan
        if __debug__:
299 5d69a524 jcorgan
            self._note("%s.release: success, value=%s",
300 5d69a524 jcorgan
                       self, self.__value)
301 5d69a524 jcorgan
        self.__cond.notify()
302 5d69a524 jcorgan
        self.__cond.release()
303 5d69a524 jcorgan
304 5d69a524 jcorgan
305 5d69a524 jcorgan
def BoundedSemaphore(*args, **kwargs):
306 5d69a524 jcorgan
    return _BoundedSemaphore(*args, **kwargs)
307 5d69a524 jcorgan
308 5d69a524 jcorgan
class _BoundedSemaphore(_Semaphore):
309 5d69a524 jcorgan
    """Semaphore that checks that # releases is <= # acquires"""
310 5d69a524 jcorgan
    def __init__(self, value=1, verbose=None):
311 5d69a524 jcorgan
        _Semaphore.__init__(self, value, verbose)
312 5d69a524 jcorgan
        self._initial_value = value
313 5d69a524 jcorgan
314 5d69a524 jcorgan
    def release(self):
315 5d69a524 jcorgan
        if self._Semaphore__value >= self._initial_value:
316 5d69a524 jcorgan
            raise ValueError, "Semaphore released too many times"
317 5d69a524 jcorgan
        return _Semaphore.release(self)
318 5d69a524 jcorgan
319 5d69a524 jcorgan
320 5d69a524 jcorgan
def Event(*args, **kwargs):
321 5d69a524 jcorgan
    return _Event(*args, **kwargs)
322 5d69a524 jcorgan
323 5d69a524 jcorgan
class _Event(_Verbose):
324 5d69a524 jcorgan
325 5d69a524 jcorgan
    # After Tim Peters' event class (without is_posted())
326 5d69a524 jcorgan
327 5d69a524 jcorgan
    def __init__(self, verbose=None):
328 5d69a524 jcorgan
        _Verbose.__init__(self, verbose)
329 5d69a524 jcorgan
        self.__cond = Condition(Lock())
330 5d69a524 jcorgan
        self.__flag = False
331 5d69a524 jcorgan
332 5d69a524 jcorgan
    def isSet(self):
333 5d69a524 jcorgan
        return self.__flag
334 5d69a524 jcorgan
335 5d69a524 jcorgan
    def set(self):
336 5d69a524 jcorgan
        self.__cond.acquire()
337 5d69a524 jcorgan
        try:
338 5d69a524 jcorgan
            self.__flag = True
339 5d69a524 jcorgan
            self.__cond.notifyAll()
340 5d69a524 jcorgan
        finally:
341 5d69a524 jcorgan
            self.__cond.release()
342 5d69a524 jcorgan
343 5d69a524 jcorgan
    def clear(self):
344 5d69a524 jcorgan
        self.__cond.acquire()
345 5d69a524 jcorgan
        try:
346 5d69a524 jcorgan
            self.__flag = False
347 5d69a524 jcorgan
        finally:
348 5d69a524 jcorgan
            self.__cond.release()
349 5d69a524 jcorgan
350 5d69a524 jcorgan
    def wait(self, timeout=None):
351 5d69a524 jcorgan
        self.__cond.acquire()
352 5d69a524 jcorgan
        try:
353 5d69a524 jcorgan
            if not self.__flag:
354 5d69a524 jcorgan
                self.__cond.wait(timeout)
355 5d69a524 jcorgan
        finally:
356 5d69a524 jcorgan
            self.__cond.release()
357 5d69a524 jcorgan
358 5d69a524 jcorgan
# Helper to generate new thread names
359 5d69a524 jcorgan
_counter = 0
360 5d69a524 jcorgan
def _newname(template="Thread-%d"):
361 5d69a524 jcorgan
    global _counter
362 5d69a524 jcorgan
    _counter = _counter + 1
363 5d69a524 jcorgan
    return template % _counter
364 5d69a524 jcorgan
365 5d69a524 jcorgan
# Active thread administration
366 5d69a524 jcorgan
_active_limbo_lock = _allocate_lock()
367 5d69a524 jcorgan
_active = {}
368 5d69a524 jcorgan
_limbo = {}
369 5d69a524 jcorgan
370 5d69a524 jcorgan
371 5d69a524 jcorgan
# Main class for threads
372 5d69a524 jcorgan
373 5d69a524 jcorgan
class Thread(_Verbose):
374 5d69a524 jcorgan
375 5d69a524 jcorgan
    __initialized = False
376 5d69a524 jcorgan
377 5d69a524 jcorgan
    def __init__(self, group=None, target=None, name=None,
378 5d69a524 jcorgan
                 args=(), kwargs={}, verbose=None):
379 5d69a524 jcorgan
        assert group is None, "group argument must be None for now"
380 5d69a524 jcorgan
        _Verbose.__init__(self, verbose)
381 5d69a524 jcorgan
        self.__target = target
382 5d69a524 jcorgan
        self.__name = str(name or _newname())
383 5d69a524 jcorgan
        self.__args = args
384 5d69a524 jcorgan
        self.__kwargs = kwargs
385 5d69a524 jcorgan
        self.__daemonic = self._set_daemon()
386 5d69a524 jcorgan
        self.__started = False
387 5d69a524 jcorgan
        self.__stopped = False
388 5d69a524 jcorgan
        self.__block = Condition(Lock())
389 5d69a524 jcorgan
        self.__initialized = True
390 5d69a524 jcorgan
391 5d69a524 jcorgan
    def _set_daemon(self):
392 5d69a524 jcorgan
        # Overridden in _MainThread and _DummyThread
393 5d69a524 jcorgan
        return currentThread().isDaemon()
394 5d69a524 jcorgan
395 5d69a524 jcorgan
    def __repr__(self):
396 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() was not called"
397 5d69a524 jcorgan
        status = "initial"
398 5d69a524 jcorgan
        if self.__started:
399 5d69a524 jcorgan
            status = "started"
400 5d69a524 jcorgan
        if self.__stopped:
401 5d69a524 jcorgan
            status = "stopped"
402 5d69a524 jcorgan
        if self.__daemonic:
403 5d69a524 jcorgan
            status = status + " daemon"
404 5d69a524 jcorgan
        return "<%s(%s, %s)>" % (self.__class__.__name__, self.__name, status)
405 5d69a524 jcorgan
406 5d69a524 jcorgan
    def start(self):
407 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
408 5d69a524 jcorgan
        assert not self.__started, "thread already started"
409 5d69a524 jcorgan
        if __debug__:
410 5d69a524 jcorgan
            self._note("%s.start(): starting thread", self)
411 5d69a524 jcorgan
        _active_limbo_lock.acquire()
412 5d69a524 jcorgan
        _limbo[self] = self
413 5d69a524 jcorgan
        _active_limbo_lock.release()
414 5d69a524 jcorgan
        _start_new_thread(self.__bootstrap, ())
415 5d69a524 jcorgan
        self.__started = True
416 5d69a524 jcorgan
        _sleep(0.000001)    # 1 usec, to let the thread run (Solaris hack)
417 5d69a524 jcorgan
418 5d69a524 jcorgan
    def run(self):
419 5d69a524 jcorgan
        if self.__target:
420 5d69a524 jcorgan
            self.__target(*self.__args, **self.__kwargs)
421 5d69a524 jcorgan
422 5d69a524 jcorgan
    def __bootstrap(self):
423 5d69a524 jcorgan
        try:
424 5d69a524 jcorgan
            self.__started = True
425 5d69a524 jcorgan
            _active_limbo_lock.acquire()
426 5d69a524 jcorgan
            _active[_get_ident()] = self
427 5d69a524 jcorgan
            del _limbo[self]
428 5d69a524 jcorgan
            _active_limbo_lock.release()
429 5d69a524 jcorgan
            if __debug__:
430 5d69a524 jcorgan
                self._note("%s.__bootstrap(): thread started", self)
431 5d69a524 jcorgan
432 5d69a524 jcorgan
            if _trace_hook:
433 5d69a524 jcorgan
                self._note("%s.__bootstrap(): registering trace hook", self)
434 5d69a524 jcorgan
                _sys.settrace(_trace_hook)
435 5d69a524 jcorgan
            if _profile_hook:
436 5d69a524 jcorgan
                self._note("%s.__bootstrap(): registering profile hook", self)
437 5d69a524 jcorgan
                _sys.setprofile(_profile_hook)
438 5d69a524 jcorgan
439 5d69a524 jcorgan
            try:
440 5d69a524 jcorgan
                self.run()
441 5d69a524 jcorgan
            except SystemExit:
442 5d69a524 jcorgan
                if __debug__:
443 5d69a524 jcorgan
                    self._note("%s.__bootstrap(): raised SystemExit", self)
444 5d69a524 jcorgan
            except:
445 5d69a524 jcorgan
                if __debug__:
446 5d69a524 jcorgan
                    self._note("%s.__bootstrap(): unhandled exception", self)
447 5d69a524 jcorgan
                s = _StringIO()
448 5d69a524 jcorgan
                _print_exc(file=s)
449 5d69a524 jcorgan
                _sys.stderr.write("Exception in thread %s:\n%s\n" %
450 5d69a524 jcorgan
                                 (self.getName(), s.getvalue()))
451 5d69a524 jcorgan
            else:
452 5d69a524 jcorgan
                if __debug__:
453 5d69a524 jcorgan
                    self._note("%s.__bootstrap(): normal return", self)
454 5d69a524 jcorgan
        finally:
455 5d69a524 jcorgan
            self.__stop()
456 5d69a524 jcorgan
            try:
457 5d69a524 jcorgan
                self.__delete()
458 5d69a524 jcorgan
            except:
459 5d69a524 jcorgan
                pass
460 5d69a524 jcorgan
461 5d69a524 jcorgan
    def __stop(self):
462 5d69a524 jcorgan
        self.__block.acquire()
463 5d69a524 jcorgan
        self.__stopped = True
464 5d69a524 jcorgan
        self.__block.notifyAll()
465 5d69a524 jcorgan
        self.__block.release()
466 5d69a524 jcorgan
467 5d69a524 jcorgan
    def __delete(self):
468 5d69a524 jcorgan
        _active_limbo_lock.acquire()
469 5d69a524 jcorgan
        del _active[_get_ident()]
470 5d69a524 jcorgan
        _active_limbo_lock.release()
471 5d69a524 jcorgan
472 5d69a524 jcorgan
    def join(self, timeout=None):
473 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
474 5d69a524 jcorgan
        assert self.__started, "cannot join thread before it is started"
475 5d69a524 jcorgan
        assert self is not currentThread(), "cannot join current thread"
476 5d69a524 jcorgan
        if __debug__:
477 5d69a524 jcorgan
            if not self.__stopped:
478 5d69a524 jcorgan
                self._note("%s.join(): waiting until thread stops", self)
479 5d69a524 jcorgan
        self.__block.acquire()
480 5d69a524 jcorgan
        try:
481 5d69a524 jcorgan
            if timeout is None:
482 5d69a524 jcorgan
                while not self.__stopped:
483 5d69a524 jcorgan
                    self.__block.wait()
484 5d69a524 jcorgan
                if __debug__:
485 5d69a524 jcorgan
                    self._note("%s.join(): thread stopped", self)
486 5d69a524 jcorgan
            else:
487 5d69a524 jcorgan
                deadline = _time() + timeout
488 5d69a524 jcorgan
                while not self.__stopped:
489 5d69a524 jcorgan
                    delay = deadline - _time()
490 5d69a524 jcorgan
                    if delay <= 0:
491 5d69a524 jcorgan
                        if __debug__:
492 5d69a524 jcorgan
                            self._note("%s.join(): timed out", self)
493 5d69a524 jcorgan
                        break
494 5d69a524 jcorgan
                    self.__block.wait(delay)
495 5d69a524 jcorgan
                else:
496 5d69a524 jcorgan
                    if __debug__:
497 5d69a524 jcorgan
                        self._note("%s.join(): thread stopped", self)
498 5d69a524 jcorgan
        finally:
499 5d69a524 jcorgan
            self.__block.release()
500 5d69a524 jcorgan
501 5d69a524 jcorgan
    def getName(self):
502 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
503 5d69a524 jcorgan
        return self.__name
504 5d69a524 jcorgan
505 5d69a524 jcorgan
    def setName(self, name):
506 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
507 5d69a524 jcorgan
        self.__name = str(name)
508 5d69a524 jcorgan
509 5d69a524 jcorgan
    def isAlive(self):
510 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
511 5d69a524 jcorgan
        return self.__started and not self.__stopped
512 5d69a524 jcorgan
513 5d69a524 jcorgan
    def isDaemon(self):
514 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
515 5d69a524 jcorgan
        return self.__daemonic
516 5d69a524 jcorgan
517 5d69a524 jcorgan
    def setDaemon(self, daemonic):
518 5d69a524 jcorgan
        assert self.__initialized, "Thread.__init__() not called"
519 5d69a524 jcorgan
        assert not self.__started, "cannot set daemon status of active thread"
520 5d69a524 jcorgan
        self.__daemonic = daemonic
521 5d69a524 jcorgan
522 5d69a524 jcorgan
# The timer class was contributed by Itamar Shtull-Trauring
523 5d69a524 jcorgan
524 5d69a524 jcorgan
def Timer(*args, **kwargs):
525 5d69a524 jcorgan
    return _Timer(*args, **kwargs)
526 5d69a524 jcorgan
527 5d69a524 jcorgan
class _Timer(Thread):
528 5d69a524 jcorgan
    """Call a function after a specified number of seconds:
529 5d69a524 jcorgan
530 5d69a524 jcorgan
    t = Timer(30.0, f, args=[], kwargs={})
531 5d69a524 jcorgan
    t.start()
532 5d69a524 jcorgan
    t.cancel() # stop the timer's action if it's still waiting
533 5d69a524 jcorgan
    """
534 5d69a524 jcorgan
535 5d69a524 jcorgan
    def __init__(self, interval, function, args=[], kwargs={}):
536 5d69a524 jcorgan
        Thread.__init__(self)
537 5d69a524 jcorgan
        self.interval = interval
538 5d69a524 jcorgan
        self.function = function
539 5d69a524 jcorgan
        self.args = args
540 5d69a524 jcorgan
        self.kwargs = kwargs
541 5d69a524 jcorgan
        self.finished = Event()
542 5d69a524 jcorgan
543 5d69a524 jcorgan
    def cancel(self):
544 5d69a524 jcorgan
        """Stop the timer if it hasn't finished yet"""
545 5d69a524 jcorgan
        self.finished.set()
546 5d69a524 jcorgan
547 5d69a524 jcorgan
    def run(self):
548 5d69a524 jcorgan
        self.finished.wait(self.interval)
549 5d69a524 jcorgan
        if not self.finished.isSet():
550 5d69a524 jcorgan
            self.function(*self.args, **self.kwargs)
551 5d69a524 jcorgan
        self.finished.set()
552 5d69a524 jcorgan
553 5d69a524 jcorgan
# Special thread class to represent the main thread
554 5d69a524 jcorgan
# This is garbage collected through an exit handler
555 5d69a524 jcorgan
556 5d69a524 jcorgan
class _MainThread(Thread):
557 5d69a524 jcorgan
558 5d69a524 jcorgan
    def __init__(self):
559 5d69a524 jcorgan
        Thread.__init__(self, name="MainThread")
560 5d69a524 jcorgan
        self._Thread__started = True
561 5d69a524 jcorgan
        _active_limbo_lock.acquire()
562 5d69a524 jcorgan
        _active[_get_ident()] = self
563 5d69a524 jcorgan
        _active_limbo_lock.release()
564 5d69a524 jcorgan
        import atexit
565 5d69a524 jcorgan
        atexit.register(self.__exitfunc)
566 5d69a524 jcorgan
567 5d69a524 jcorgan
    def _set_daemon(self):
568 5d69a524 jcorgan
        return False
569 5d69a524 jcorgan
570 5d69a524 jcorgan
    def __exitfunc(self):
571 5d69a524 jcorgan
        self._Thread__stop()
572 5d69a524 jcorgan
        t = _pickSomeNonDaemonThread()
573 5d69a524 jcorgan
        if t:
574 5d69a524 jcorgan
            if __debug__:
575 5d69a524 jcorgan
                self._note("%s: waiting for other threads", self)
576 5d69a524 jcorgan
        while t:
577 5d69a524 jcorgan
            t.join()
578 5d69a524 jcorgan
            t = _pickSomeNonDaemonThread()
579 5d69a524 jcorgan
        if __debug__:
580 5d69a524 jcorgan
            self._note("%s: exiting", self)
581 5d69a524 jcorgan
        self._Thread__delete()
582 5d69a524 jcorgan
583 5d69a524 jcorgan
def _pickSomeNonDaemonThread():
584 5d69a524 jcorgan
    for t in enumerate():
585 5d69a524 jcorgan
        if not t.isDaemon() and t.isAlive():
586 5d69a524 jcorgan
            return t
587 5d69a524 jcorgan
    return None
588 5d69a524 jcorgan
589 5d69a524 jcorgan
590 5d69a524 jcorgan
# Dummy thread class to represent threads not started here.
591 5d69a524 jcorgan
# These aren't garbage collected when they die,
592 5d69a524 jcorgan
# nor can they be waited for.
593 5d69a524 jcorgan
# Their purpose is to return *something* from currentThread().
594 5d69a524 jcorgan
# They are marked as daemon threads so we won't wait for them
595 5d69a524 jcorgan
# when we exit (conform previous semantics).
596 5d69a524 jcorgan
597 5d69a524 jcorgan
class _DummyThread(Thread):
598 5d69a524 jcorgan
599 5d69a524 jcorgan
    def __init__(self):
600 5d69a524 jcorgan
        Thread.__init__(self, name=_newname("Dummy-%d"))
601 5d69a524 jcorgan
        self._Thread__started = True
602 5d69a524 jcorgan
        _active_limbo_lock.acquire()
603 5d69a524 jcorgan
        _active[_get_ident()] = self
604 5d69a524 jcorgan
        _active_limbo_lock.release()
605 5d69a524 jcorgan
606 5d69a524 jcorgan
    def _set_daemon(self):
607 5d69a524 jcorgan
        return True
608 5d69a524 jcorgan
609 5d69a524 jcorgan
    def join(self, timeout=None):
610 5d69a524 jcorgan
        assert False, "cannot join a dummy thread"
611 5d69a524 jcorgan
612 5d69a524 jcorgan
613 5d69a524 jcorgan
# Global API functions
614 5d69a524 jcorgan
615 5d69a524 jcorgan
def currentThread():
616 5d69a524 jcorgan
    try:
617 5d69a524 jcorgan
        return _active[_get_ident()]
618 5d69a524 jcorgan
    except KeyError:
619 5d69a524 jcorgan
        ##print "currentThread(): no current thread for", _get_ident()
620 5d69a524 jcorgan
        return _DummyThread()
621 5d69a524 jcorgan
622 5d69a524 jcorgan
def activeCount():
623 5d69a524 jcorgan
    _active_limbo_lock.acquire()
624 5d69a524 jcorgan
    count = len(_active) + len(_limbo)
625 5d69a524 jcorgan
    _active_limbo_lock.release()
626 5d69a524 jcorgan
    return count
627 5d69a524 jcorgan
628 5d69a524 jcorgan
def enumerate():
629 5d69a524 jcorgan
    _active_limbo_lock.acquire()
630 5d69a524 jcorgan
    active = _active.values() + _limbo.values()
631 5d69a524 jcorgan
    _active_limbo_lock.release()
632 5d69a524 jcorgan
    return active
633 5d69a524 jcorgan
634 5d69a524 jcorgan
# Create the main thread object
635 5d69a524 jcorgan
636 5d69a524 jcorgan
_MainThread()
637 5d69a524 jcorgan
638 5d69a524 jcorgan
639 5d69a524 jcorgan
# Self-test code
640 5d69a524 jcorgan
641 5d69a524 jcorgan
def _test():
642 5d69a524 jcorgan
643 5d69a524 jcorgan
    class BoundedQueue(_Verbose):
644 5d69a524 jcorgan
645 5d69a524 jcorgan
        def __init__(self, limit):
646 5d69a524 jcorgan
            _Verbose.__init__(self)
647 5d69a524 jcorgan
            self.mon = RLock()
648 5d69a524 jcorgan
            self.rc = Condition(self.mon)
649 5d69a524 jcorgan
            self.wc = Condition(self.mon)
650 5d69a524 jcorgan
            self.limit = limit
651 5d69a524 jcorgan
            self.queue = []
652 5d69a524 jcorgan
653 5d69a524 jcorgan
        def put(self, item):
654 5d69a524 jcorgan
            self.mon.acquire()
655 5d69a524 jcorgan
            while len(self.queue) >= self.limit:
656 5d69a524 jcorgan
                self._note("put(%s): queue full", item)
657 5d69a524 jcorgan
                self.wc.wait()
658 5d69a524 jcorgan
            self.queue.append(item)
659 5d69a524 jcorgan
            self._note("put(%s): appended, length now %d",
660 5d69a524 jcorgan
                       item, len(self.queue))
661 5d69a524 jcorgan
            self.rc.notify()
662 5d69a524 jcorgan
            self.mon.release()
663 5d69a524 jcorgan
664 5d69a524 jcorgan
        def get(self):
665 5d69a524 jcorgan
            self.mon.acquire()
666 5d69a524 jcorgan
            while not self.queue:
667 5d69a524 jcorgan
                self._note("get(): queue empty")
668 5d69a524 jcorgan
                self.rc.wait()
669 5d69a524 jcorgan
            item = self.queue.pop(0)
670 5d69a524 jcorgan
            self._note("get(): got %s, %d left", item, len(self.queue))
671 5d69a524 jcorgan
            self.wc.notify()
672 5d69a524 jcorgan
            self.mon.release()
673 5d69a524 jcorgan
            return item
674 5d69a524 jcorgan
675 5d69a524 jcorgan
    class ProducerThread(Thread):
676 5d69a524 jcorgan
677 5d69a524 jcorgan
        def __init__(self, queue, quota):
678 5d69a524 jcorgan
            Thread.__init__(self, name="Producer")
679 5d69a524 jcorgan
            self.queue = queue
680 5d69a524 jcorgan
            self.quota = quota
681 5d69a524 jcorgan
682 5d69a524 jcorgan
        def run(self):
683 5d69a524 jcorgan
            from random import random
684 5d69a524 jcorgan
            counter = 0
685 5d69a524 jcorgan
            while counter < self.quota:
686 5d69a524 jcorgan
                counter = counter + 1
687 5d69a524 jcorgan
                self.queue.put("%s.%d" % (self.getName(), counter))
688 5d69a524 jcorgan
                _sleep(random() * 0.00001)
689 5d69a524 jcorgan
690 5d69a524 jcorgan
691 5d69a524 jcorgan
    class ConsumerThread(Thread):
692 5d69a524 jcorgan
693 5d69a524 jcorgan
        def __init__(self, queue, count):
694 5d69a524 jcorgan
            Thread.__init__(self, name="Consumer")
695 5d69a524 jcorgan
            self.queue = queue
696 5d69a524 jcorgan
            self.count = count
697 5d69a524 jcorgan
698 5d69a524 jcorgan
        def run(self):
699 5d69a524 jcorgan
            while self.count > 0:
700 5d69a524 jcorgan
                item = self.queue.get()
701 5d69a524 jcorgan
                print item
702 5d69a524 jcorgan
                self.count = self.count - 1
703 5d69a524 jcorgan
704 5d69a524 jcorgan
    NP = 3
705 5d69a524 jcorgan
    QL = 4
706 5d69a524 jcorgan
    NI = 5
707 5d69a524 jcorgan
708 5d69a524 jcorgan
    Q = BoundedQueue(QL)
709 5d69a524 jcorgan
    P = []
710 5d69a524 jcorgan
    for i in range(NP):
711 5d69a524 jcorgan
        t = ProducerThread(Q, NI)
712 5d69a524 jcorgan
        t.setName("Producer-%d" % (i+1))
713 5d69a524 jcorgan
        P.append(t)
714 5d69a524 jcorgan
    C = ConsumerThread(Q, NI*NP)
715 5d69a524 jcorgan
    for t in P:
716 5d69a524 jcorgan
        t.start()
717 5d69a524 jcorgan
        _sleep(0.000001)
718 5d69a524 jcorgan
    C.start()
719 5d69a524 jcorgan
    for t in P:
720 5d69a524 jcorgan
        t.join()
721 5d69a524 jcorgan
    C.join()
722 5d69a524 jcorgan
723 5d69a524 jcorgan
if __name__ == '__main__':
724 5d69a524 jcorgan
    _test()