… | |
… | |
14 | |
14 | |
15 | $sig->up; |
15 | $sig->up; |
16 | |
16 | |
17 | =head1 DESCRIPTION |
17 | =head1 DESCRIPTION |
18 | |
18 | |
|
|
19 | This module implements counting semaphores. You can initialize a mutex |
|
|
20 | with any level of parallel users, that is, you can intialize a sempahore |
|
|
21 | that can be C<down>ed more than once until it blocks. There is no owner |
|
|
22 | associated with semaphores, so one coroutine can C<down> it while another |
|
|
23 | can C<up> it. |
|
|
24 | |
|
|
25 | Counting semaphores are typically used to coordinate access to |
|
|
26 | resources, with the semaphore count initialized to the number of free |
|
|
27 | resources. Coroutines then increment the count when resources are added |
|
|
28 | and decrement the count when resources are removed. |
|
|
29 | |
19 | =over 4 |
30 | =over 4 |
20 | |
31 | |
21 | =cut |
32 | =cut |
22 | |
33 | |
23 | package Coro::Semaphore; |
34 | package Coro::Semaphore; |
24 | |
35 | |
|
|
36 | no warnings; |
|
|
37 | |
25 | use Coro (); |
38 | use Coro (); |
26 | |
39 | |
27 | $VERSION = 0.07; |
40 | $VERSION = 0.5; |
28 | |
41 | |
29 | =item new [inital count, default zero] |
42 | =item new [inital count] |
30 | |
43 | |
31 | Creates a new sempahore object with the given initial lock count. The |
44 | Creates a new sempahore object with the given initial lock count. The |
32 | default lock count is 1, which means it is unlocked by default. |
45 | default lock count is 1, which means it is unlocked by default. Zero (or |
|
|
46 | negative values) are also allowed, in which case the semaphore is locked |
|
|
47 | by default. |
33 | |
48 | |
34 | =cut |
49 | =cut |
35 | |
50 | |
36 | sub new { |
51 | sub new { |
37 | bless [defined $_[1] ? $_[1] : 1], $_[0]; |
52 | bless [defined $_[1] ? $_[1] : 1], $_[0]; |
… | |
… | |
43 | waits until the semaphore is available if the counter is zero. |
58 | waits until the semaphore is available if the counter is zero. |
44 | |
59 | |
45 | =cut |
60 | =cut |
46 | |
61 | |
47 | sub down { |
62 | sub down { |
48 | my $self = shift; |
|
|
49 | while ($self->[0] <= 0) { |
63 | while ($_[0][0] <= 0) { |
50 | push @{$self->[1]}, $Coro::current; |
64 | push @{$_[0][1]}, $Coro::current; |
51 | Coro::schedule; |
65 | Coro::schedule; |
52 | } |
66 | } |
53 | --$self->[0]; |
67 | --$_[0][0]; |
54 | } |
68 | } |
55 | |
69 | |
56 | =item $sem->up |
70 | =item $sem->up |
57 | |
71 | |
58 | Unlock the semaphore again. |
72 | Unlock the semaphore again. |
59 | |
73 | |
60 | =cut |
74 | =cut |
61 | |
75 | |
62 | sub up { |
76 | sub up { |
63 | my $self = shift; |
|
|
64 | if (++$self->[0] > 0) { |
77 | if (++$_[0][0] > 0) { |
65 | (shift @{$self->[1]})->ready if @{$self->[1]}; |
78 | (shift @{$_[0][1]})->ready if @{$_[0][1]}; |
66 | } |
79 | } |
67 | } |
80 | } |
68 | |
81 | |
69 | =item $sem->try |
82 | =item $sem->try |
70 | |
83 | |
… | |
… | |
72 | otherwise return false and leave the semaphore unchanged. |
85 | otherwise return false and leave the semaphore unchanged. |
73 | |
86 | |
74 | =cut |
87 | =cut |
75 | |
88 | |
76 | sub try { |
89 | sub try { |
77 | my $self = shift; |
|
|
78 | if ($self->[0] > 0) { |
90 | if ($_[0][0] > 0) { |
79 | --$self->[0]; |
91 | --$_[0][0]; |
80 | return 1; |
92 | return 1; |
81 | } else { |
93 | } else { |
82 | return 0; |
94 | return 0; |
83 | } |
95 | } |
|
|
96 | } |
|
|
97 | |
|
|
98 | =item $sem->waiters |
|
|
99 | |
|
|
100 | In scalar context, returns the number of coroutines waiting for this |
|
|
101 | semaphore. |
|
|
102 | |
|
|
103 | =cut |
|
|
104 | |
|
|
105 | sub waiters { |
|
|
106 | @{$_[0][1]}; |
|
|
107 | } |
|
|
108 | |
|
|
109 | =item $guard = $sem->guard |
|
|
110 | |
|
|
111 | This method calls C<down> and then creates a guard object. When the guard |
|
|
112 | object is destroyed it automatically calls C<up>. |
|
|
113 | |
|
|
114 | =cut |
|
|
115 | |
|
|
116 | sub guard { |
|
|
117 | &down; |
|
|
118 | # double indirection because bless works on the referenced |
|
|
119 | # object, not (only) on the reference itself. |
|
|
120 | bless \\$_[0], Coro::Semaphore::Guard::; |
|
|
121 | } |
|
|
122 | |
|
|
123 | sub Coro::Semaphore::Guard::DESTROY { |
|
|
124 | &up(${${$_[0]}}); |
84 | } |
125 | } |
85 | |
126 | |
86 | 1; |
127 | 1; |
87 | |
128 | |
88 | =back |
129 | =back |