blob: 33509c762e1b4cdb6d21ae9df59a0aa5acb0f1d8 [file] [log] [blame]
Guido van Rossume2e162e1991-04-21 19:32:43 +00001# Mutual exclusion -- for use with module sched
2
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#
Guido van Rossumce084481991-12-26 13:06:29 +000014class mutex:
Guido van Rossume2e162e1991-04-21 19:32:43 +000015 #
16 # Create a new mutex -- initially unlocked
17 #
Guido van Rossum7bc817d1993-12-17 15:25:27 +000018 def __init__(self):
Guido van Rossume2e162e1991-04-21 19:32:43 +000019 self.locked = 0
20 self.queue = []
Guido van Rossume2e162e1991-04-21 19:32:43 +000021 #
22 # Test the locked bit of the mutex
23 #
24 def test(self):
25 return self.locked
26 #
27 # Atomic test-and-set -- grab the lock if it is not set,
28 # return true if it succeeded
29 #
30 def testandset(self):
31 if not self.locked:
32 self.locked = 1
33 return 1
34 else:
35 return 0
36 #
37 # Lock a mutex, call the function with supplied argument
38 # when it is acquired.
39 # If the mutex is already locked, place function and argument
40 # in the queue.
41 #
Guido van Rossum89a78691992-12-14 12:57:56 +000042 def lock(self, function, argument):
Guido van Rossume2e162e1991-04-21 19:32:43 +000043 if self.testandset():
44 function(argument)
45 else:
Guido van Rossumb7f48e31996-10-08 14:06:17 +000046 self.queue.append((function, argument))
Guido van Rossume2e162e1991-04-21 19:32:43 +000047 #
48 # Unlock a mutex. If the queue is not empty, call the next
49 # function with its argument.
50 #
51 def unlock(self):
52 if self.queue:
53 function, argument = self.queue[0]
54 del self.queue[0]
55 function(argument)
56 else:
57 self.locked = 0
58 #