mutex.py 1.69 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
"""Mutual exclusion -- for use with module sched

A mutex has two pieces of state -- a 'locked' bit and a queue.
When the mutex is not locked, the queue is empty.
Otherwise, the queue contains 0 or more (function, argument) pairs
representing functions (or methods) waiting to acquire the lock.
When the mutex is unlocked while the queue is not empty,
the first queue entry is removed and its function(argument) pair called,
implying it now has the lock.

Of course, no multi-threading is implied -- hence the funny interface
for lock, where a function is called once the lock is aquired.
"""
Guido van Rossum's avatar
Guido van Rossum committed
14

Guido van Rossum's avatar
Guido van Rossum committed
15
class mutex:
Tim Peters's avatar
Tim Peters committed
16 17 18 19
    def __init__(self):
        """Create a new mutex -- initially unlocked."""
        self.locked = 0
        self.queue = []
20

Tim Peters's avatar
Tim Peters committed
21 22 23
    def test(self):
        """Test the locked bit of the mutex."""
        return self.locked
24

Tim Peters's avatar
Tim Peters committed
25 26 27 28 29 30 31 32
    def testandset(self):
        """Atomic test-and-set -- grab the lock if it is not set,
        return true if it succeeded."""
        if not self.locked:
            self.locked = 1
            return 1
        else:
            return 0
33

Tim Peters's avatar
Tim Peters committed
34 35 36 37 38 39 40 41
    def lock(self, function, argument):
        """Lock a mutex, call the function with supplied argument
        when it is acquired.  If the mutex is already locked, place
        function and argument in the queue."""
        if self.testandset():
            function(argument)
        else:
            self.queue.append((function, argument))
42

Tim Peters's avatar
Tim Peters committed
43 44 45 46 47 48 49 50 51
    def unlock(self):
        """Unlock a mutex.  If the queue is not empty, call the next
        function with its argument."""
        if self.queue:
            function, argument = self.queue[0]
            del self.queue[0]
            function(argument)
        else:
            self.locked = 0