aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/lux/control/concurrency/semaphore.lux
blob: c69859138e8d4f891173b0a5d7b966596e91f511 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
(.module:
  [lux #*
   [abstract
    [monad (#+ do)]]
   [control
    ["." io (#+ IO)]
    ["." try (#+ Try)]
    ["." exception (#+ exception:)]]
   [data
    [text
     ["%" format (#+ format)]]
    [number
     ["n" nat]
     ["i" int]]
    [collection
     ["." queue (#+ Queue)]]]
   [type
    abstract
    ["." refinement]]
   ["." macro]]
  [//
   ["." atom (#+ Atom)]
   ["." promise (#+ Promise Resolver)]])

(type: State
  {#max-positions Nat
   #open-positions Int
   #waiting-list (Queue (Resolver Any))})

(abstract: #export Semaphore
  {#.doc "A tool for controlling access to resources by multiple concurrent processes."}

  (Atom State)

  (def: most-positions-possible
    (.nat (:: i.interval top)))

  (def: #export (semaphore initial-open-positions)
    (-> Nat Semaphore)
    (let [max-positions (n.min initial-open-positions
                               ..most-positions-possible)]
      (:abstraction (atom.atom {#max-positions max-positions
                                #open-positions (.int max-positions)
                                #waiting-list queue.empty}))))

  (def: #export (wait semaphore)
    (Ex [k] (-> Semaphore (Promise Any)))
    (let [semaphore (:representation semaphore)
          [signal sink] (: [(Promise Any) (Resolver Any)]
                           (promise.promise []))]
      (exec (promise.future
             (loop [_ []]
               (do io.monad
                 [state (atom.read semaphore)
                  #let [[ready? state'] (: [Bit State]
                                           (if (i.> +0 (get@ #open-positions state))
                                             [true (|> state
                                                       (update@ #open-positions dec))]
                                             [false (|> state
                                                        (update@ #open-positions dec)
                                                        (update@ #waiting-list (queue.push sink)))]))]
                  success? (atom.compare-and-swap state state' semaphore)]
                 (if success?
                   (if ready?
                     (sink [])
                     (wrap false))
                   (recur [])))))
        signal)))

  (exception: #export (semaphore-is-maxed-out {max-positions Nat})
    (exception.report
     ["Max Positions" (%.nat max-positions)]))

  (def: #export (signal semaphore)
    (Ex [k] (-> Semaphore (Promise (Try Int))))
    (let [semaphore (:representation semaphore)]
      (promise.future
       (loop [_ []]
         (do {@ io.monad}
           [state (atom.read semaphore)
            #let [[?sink state' maxed-out?] (: [(Maybe (Resolver Any)) State Bit]
                                               (case (queue.peek (get@ #waiting-list state))
                                                 #.None
                                                 (if (n.= (get@ #max-positions state)
                                                          (.nat (get@ #open-positions state)))
                                                   [#.None
                                                    state
                                                    true]
                                                   [#.None
                                                    (update@ #open-positions inc state)
                                                    false])
                                                 
                                                 (#.Some head)
                                                 [(#.Some head)
                                                  (|> state
                                                      (update@ #open-positions inc)
                                                      (update@ #waiting-list queue.pop))
                                                  false]))]]
           (if maxed-out?
             (wrap (exception.throw ..semaphore-is-maxed-out [(get@ #max-positions state)]))
             (do @
               [#let [open-positions (get@ #open-positions state')]
                success? (atom.compare-and-swap state state' semaphore)]
               (if success?
                 (do @
                   [_ (case ?sink
                        #.None
                        (wrap true)

                        (#.Some sink)
                        (sink []))]
                   (wrap (#try.Success open-positions)))
                 (recur [])))))))))
  )

(abstract: #export Mutex
  {#.doc "A mutual-exclusion lock that can only be acquired by one process at a time."}

  Semaphore

  (def: #export (mutex _)
    (-> Any Mutex)
    (:abstraction (semaphore 1)))

  (def: acquire
    (-> Mutex (Promise Any))
    (|>> :representation wait))

  (def: release
    (-> Mutex (Promise Any))
    (|>> :representation signal))

  (def: #export (synchronize mutex procedure)
    (All [a] (-> Mutex (IO (Promise a)) (Promise a)))
    (do promise.monad
      [_ (acquire mutex)
       output (io.run procedure)
       _ (release mutex)]
      (wrap output)))
  )

(def: #export limit (refinement.refinement (n.> 0)))
(type: #export Limit (:~ (refinement.type limit)))

(abstract: #export Barrier
  {#.doc "A barrier that blocks all processes from proceeding until a given number of processes are parked at the barrier."}

  {#limit Limit
   #count (Atom Nat)
   #start-turnstile Semaphore
   #end-turnstile Semaphore}

  (def: #export (barrier limit)
    (-> Limit Barrier)
    (:abstraction {#limit limit
                   #count (atom.atom 0)
                   #start-turnstile (semaphore 0)
                   #end-turnstile (semaphore 0)}))

  (def: (un-block times turnstile)
    (-> Nat Semaphore (Promise Any))
    (loop [step 0]
      (if (n.< times step)
        (do promise.monad
          [_ (..signal turnstile)]
          (recur (inc step)))
        (:: promise.monad wrap []))))

  (template [<phase> <update> <goal> <turnstile>]
    [(def: (<phase> (^:representation barrier))
       (-> Barrier (Promise Any))
       (do promise.monad
         [#let [limit (refinement.un-refine (get@ #limit barrier))
                goal <goal>
                count (io.run (atom.update <update> (get@ #count barrier)))
                reached? (n.= goal count)]]
         (if reached?
           (un-block limit (get@ <turnstile> barrier))
           (wait (get@ <turnstile> barrier)))))]

    [start inc limit #start-turnstile]
    [end   dec 0     #end-turnstile]
    )

  (def: #export (block barrier)
    (-> Barrier (Promise Any))
    (do promise.monad
      [_ (..start barrier)]
      (..end barrier)))
  )