blob: 2348a2e0041d753dfbfa37f8e4c195c99ddec1f9 [file] [log] [blame]
Guido van Rossum54f22ed2000-02-04 15:10:34 +00001"""Mutual exclusion -- for use with module sched
Guido van Rossume2e162e1991-04-21 19:32:43 +00002
Guido van Rossum54f22ed2000-02-04 15:10:34 +00003A mutex has two pieces of state -- a 'locked' bit and a queue.
4When the mutex is not locked, the queue is empty.
5Otherwise, the queue contains 0 or more (function, argument) pairs
6representing functions (or methods) waiting to acquire the lock.
7When the mutex is unlocked while the queue is not empty,
8the first queue entry is removed and its function(argument) pair called,
9implying it now has the lock.
10
11Of course, no multi-threading is implied -- hence the funny interface
12for lock, where a function is called once the lock is aquired.
13"""
14
Guido van Rossumce084481991-12-26 13:06:29 +000015class mutex:
Tim Peters07e99cb2001-01-14 23:47:14 +000016 def __init__(self):
17 """Create a new mutex -- initially unlocked."""
18 self.locked = 0
19 self.queue = []
Guido van Rossum54f22ed2000-02-04 15:10:34 +000020
Tim Peters07e99cb2001-01-14 23:47:14 +000021 def test(self):
22 """Test the locked bit of the mutex."""
23 return self.locked
Guido van Rossum54f22ed2000-02-04 15:10:34 +000024
Tim Peters07e99cb2001-01-14 23:47:14 +000025 def testandset(self):
26 """Atomic test-and-set -- grab the lock if it is not set,
27 return true if it succeeded."""
28 if not self.locked:
29 self.locked = 1
30 return 1
31 else:
32 return 0
Guido van Rossum54f22ed2000-02-04 15:10:34 +000033
Tim Peters07e99cb2001-01-14 23:47:14 +000034 def lock(self, function, argument):
35 """Lock a mutex, call the function with supplied argument
36 when it is acquired. If the mutex is already locked, place
37 function and argument in the queue."""
38 if self.testandset():
39 function(argument)
40 else:
41 self.queue.append((function, argument))
Guido van Rossum54f22ed2000-02-04 15:10:34 +000042
Tim Peters07e99cb2001-01-14 23:47:14 +000043 def unlock(self):
44 """Unlock a mutex. If the queue is not empty, call the next
45 function with its argument."""
46 if self.queue:
47 function, argument = self.queue[0]
48 del self.queue[0]
49 function(argument)
50 else:
51 self.locked = 0