Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 1 | """Mutual exclusion -- for use with module sched |
Guido van Rossum | e2e162e | 1991-04-21 19:32:43 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 3 | A mutex has two pieces of state -- a 'locked' bit and a queue. |
| 4 | When the mutex is not locked, the queue is empty. |
| 5 | Otherwise, the queue contains 0 or more (function, argument) pairs |
| 6 | representing functions (or methods) waiting to acquire the lock. |
| 7 | When the mutex is unlocked while the queue is not empty, |
| 8 | the first queue entry is removed and its function(argument) pair called, |
| 9 | implying it now has the lock. |
| 10 | |
| 11 | Of course, no multi-threading is implied -- hence the funny interface |
| 12 | for lock, where a function is called once the lock is aquired. |
| 13 | """ |
| 14 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame^] | 15 | from collections import deque |
| 16 | |
Guido van Rossum | ce08448 | 1991-12-26 13:06:29 +0000 | [diff] [blame] | 17 | class mutex: |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 18 | def __init__(self): |
| 19 | """Create a new mutex -- initially unlocked.""" |
| 20 | self.locked = 0 |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame^] | 21 | self.queue = deque() |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 22 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 23 | def test(self): |
| 24 | """Test the locked bit of the mutex.""" |
| 25 | return self.locked |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 26 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 27 | def testandset(self): |
| 28 | """Atomic test-and-set -- grab the lock if it is not set, |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 29 | return True if it succeeded.""" |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 30 | if not self.locked: |
| 31 | self.locked = 1 |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 32 | return True |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 33 | else: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 34 | return False |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 35 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 36 | def lock(self, function, argument): |
| 37 | """Lock a mutex, call the function with supplied argument |
| 38 | when it is acquired. If the mutex is already locked, place |
| 39 | function and argument in the queue.""" |
| 40 | if self.testandset(): |
| 41 | function(argument) |
| 42 | else: |
| 43 | self.queue.append((function, argument)) |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 44 | |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 45 | def unlock(self): |
| 46 | """Unlock a mutex. If the queue is not empty, call the next |
| 47 | function with its argument.""" |
| 48 | if self.queue: |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame^] | 49 | function, argument = self.queue.popleft() |
Tim Peters | 07e99cb | 2001-01-14 23:47:14 +0000 | [diff] [blame] | 50 | function(argument) |
| 51 | else: |
| 52 | self.locked = 0 |