about summary refs log tree commit diff stats
path: root/071channel.mu
blob: 3cff3b7cad63b68b4d496175f9ee1d9a8859404b (plain) (blame)
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# Mu synchronizes using channels rather than locks, like Erlang and Go.
#
# The two ends of a channel will usually belong to different routines, but
# each end should only be used by a single one. Don't try to read from or
# write to it from multiple routines at once.
#
# The key property of channels is that writing to a full channel or reading
# from an empty one will put the current routine in 'waiting' state until the
# operation can be completed.

scenario channel [
  run [
    1:address:shared:channel <- new-channel 3/capacity
    1:address:shared:channel <- write 1:address:shared:channel, 34
    2:character, 1:address:shared:channel <- read 1:address:shared:channel
  ]
  memory-should-contain [
    2 <- 34
  ]
]

container channel [
  # To avoid locking, writer and reader will never write to the same location.
  # So channels will include fields in pairs, one for the writer and one for the
  # reader.
  first-full:number  # for write
  first-free:number  # for read
  # A circular buffer contains values from index first-full up to (but not
  # including) index first-empty. The reader always modifies it at first-full,
  # while the writer always modifies it at first-empty.
  data:address:shared:array:character
]

recipe new-channel capacity:number -> result:address:shared:channel [
  local-scope
  load-ingredients
  result <- new channel:type
  # result.first-full = 0
  full:address:number <- get-address *result, first-full:offset
  *full <- copy 0
  # result.first-free = 0
  free:address:number <- get-address *result, first-free:offset
  *free <- copy 0
  # result.data = new location[ingredient+1]
  capacity <- add capacity, 1  # unused slot for 'full?' below
  dest:address:address:shared:array:character <- get-address *result, data:offset
  *dest <- new character:type, capacity
]

recipe write chan:address:shared:channel, val:character -> chan:address:shared:channel [
  local-scope
  load-ingredients
  {
    # block if chan is full
    full:boolean <- channel-full? chan
    break-unless full
    full-address:address:number <- get-address *chan, first-full:offset
    wait-for-location *full-address
  }
  # store val
  circular-buffer:address:shared:array:character <- get *chan, data:offset
  free:address:number <- get-address *chan, first-free:offset
  dest:address:character <- index-address *circular-buffer, *free
  *dest <- copy val
  # mark its slot as filled
  *free <- add *free, 1
  {
    # wrap free around to 0 if necessary
    len:number <- length *circular-buffer
    at-end?:boolean <- greater-or-equal *free, len
    break-unless at-end?
    *free <- copy 0
  }
]

recipe read chan:address:shared:channel -> result:character, chan:address:shared:channel [
  local-scope
  load-ingredients
  {
    # block if chan is empty
    empty?:boolean <- channel-empty? chan
    break-unless empty?
    free-address:address:number <- get-address *chan, first-free:offset
    wait-for-location *free-address
  }
  # read result
  full:address:number <- get-address *chan, first-full:offset
  circular-buffer:address:shared:array:character <- get *chan, data:offset
  result <- index *circular-buffer, *full
  # mark its slot as empty
  *full <- add *full, 1
  {
    # wrap full around to 0 if necessary
    len:number <- length *circular-buffer
    at-end?:boolean <- greater-or-equal *full, len
    break-unless at-end?
    *full <- copy 0
  }
]

recipe clear-channel chan:address:shared:channel -> chan:address:shared:channel [
  local-scope
  load-ingredients
  {
    empty?:boolean <- channel-empty? chan
    break-if empty?
    _, chan <- read chan
  }
]

scenario channel-initialization [
  run [
    1:address:shared:channel <- new-channel 3/capacity
    2:number <- get *1:address:shared:channel, first-full:offset
    3:number <- get *1:address:shared:channel, first-free:offset
  ]
  memory-should-contain [
    2 <- 0  # first-full
    3 <- 0  # first-free
  ]
]

scenario channel-write-increments-free [
  run [
    1:address:shared:channel <- new-channel 3/capacity
    1:address:shared:channel <- write 1:address:shared:channel, 34
    2:number <- get *1:address:shared:channel, first-full:offset
    3:number <- get *1:address:shared:channel, first-free:offset
  ]
  memory-should-contain [
    2 <- 0  # first-full
    3 <- 1  # first-free
  ]
]

scenario channel-read-increments-full [
  run [
    1:address:shared:channel <- new-channel 3/capacity
    1:address:shared:channel <- write 1:address:shared:channel, 34
    _, 1:address:shared:channel <- read 1:address:shared:channel
    2:number <- get *1:address:shared:channel, first-full:offset
    3:number <- get *1:address:shared:channel, first-free:offset
  ]
  memory-should-contain [
    2 <- 1  # first-full
    3 <- 1  # first-free
  ]
]

scenario channel-wrap [
  run [
    # channel with just 1 slot
    1:address:shared:channel <- new-channel 1/capacity
    # write and read a value
    1:address:shared:channel <- write 1:address:shared:channel, 34
    _, 1:address:shared:channel <- read 1:address:shared:channel
    # first-free will now be 1
    2:number <- get *1:address:shared:channel, first-free:offset
    3:number <- get *1:address:shared:channel, first-free:offset
    # write second value, verify that first-free wraps
    1:address:shared:channel <- write 1:address:shared:channel, 34
    4:number <- get *1:address:shared:channel, first-free:offset
    # read second value, verify that first-full wraps
    _, 1:address:shared:channel <- read 1:address:shared:channel
    5:number <- get *1:address:shared:channel, first-full:offset
  ]
  memory-should-contain [
    2 <- 1  # first-free after first write
    3 <- 1  # first-full after first read
    4 <- 0  # first-free after second write, wrapped
    5 <- 0  # first-full after second read, wrapped
  ]
]

## helpers

# An empty channel has first-empty and first-full both at the same value.
recipe channel-empty? chan:address:shared:channel -> result:boolean [
  local-scope
  load-ingredients
  # return chan.first-full == chan.first-free
  full:number <- get *chan, first-full:offset
  free:number <- get *chan, first-free:offset
  result <- equal full, free
]

# A full channel has first-empty just before first-full, wasting one slot.
# (Other alternatives: https://en.wikipedia.org/wiki/Circular_buffer#Full_.2F_Empty_Buffer_Distinction)
recipe channel-full? chan:address:shared:channel -> result:boolean [
  local-scope
  load-ingredients
  # tmp = chan.first-free + 1
  tmp:number <- get *chan, first-free:offset
  tmp <- add tmp, 1
  {
    # if tmp == chan.capacity, tmp = 0
    len:number <- channel-capacity chan
    at-end?:boolean <- greater-or-equal tmp, len
    break-unless at-end?
    tmp <- copy 0
  }
  # return chan.first-full == tmp
  full:number <- get *chan, first-full:offset
  result <- equal full, tmp
]

recipe channel-capacity chan:address:shared:channel -> result:number [
  local-scope
  load-ingredients
  q:address:shared:array:character <- get *chan, data:offset
  result <- length *q
]

scenario channel-new-empty-not-full [
  run [
    1:address:shared:channel <- new-channel 3/capacity
    2:boolean <- channel-empty? 1:address:shared:channel
    3:boolean <- channel-full? 1:address:shared:channel
  ]
  memory-should-contain [
    2 <- 1  # empty?
    3 <- 0  # full?
  ]
]

scenario channel-write-not-empty [
  run [
    1:address:shared:channel <- new-channel 3/capacity
    1:address:shared:channel <- write 1:address:shared:channel, 34
    2:boolean <- channel-empty? 1:address:shared:channel
    3:boolean <- channel-full? 1:address:shared:channel
  ]
  memory-should-contain [
    2 <- 0  # empty?
    3 <- 0  # full?
  ]
]

scenario channel-write-full [
  run [
    1:address:shared:channel <- new-channel 1/capacity
    1:address:shared:channel <- write 1:address:shared:channel, 34
    2:boolean <- channel-empty? 1:address:shared:channel
    3:boolean <- channel-full? 1:address:shared:channel
  ]
  memory-should-contain [
    2 <- 0  # empty?
    3 <- 1  # full?
  ]
]

scenario channel-read-not-full [
  run [
    1:address:shared:channel <- new-channel 1/capacity
    1:address:shared:channel <- write 1:address:shared:channel, 34
    _, 1:address:shared:channel <- read 1:address:shared:channel
    2:boolean <- channel-empty? 1:address:shared:channel
    3:boolean <- channel-full? 1:address:shared:channel
  ]
  memory-should-contain [
    2 <- 1  # empty?
    3 <- 0  # full?
  ]
]

# helper for channels of characters in particular
recipe buffer-lines in:address:shared:channel, out:address:shared:channel -> out:address:shared:channel, in:address:shared:channel [
  local-scope
  load-ingredients
  # repeat forever
  {
    line:address:shared:buffer <- new-buffer 30
    # read characters from 'in' until newline, copy into line
    {
      +next-character
      c:character, in <- read in
      # drop a character on backspace
      {
        # special-case: if it's a backspace
        backspace?:boolean <- equal c, 8
        break-unless backspace?
        # drop previous character
        {
          buffer-length:address:number <- get-address *line, length:offset
          buffer-empty?:boolean <- equal *buffer-length, 0
          break-if buffer-empty?
          *buffer-length <- subtract *buffer-length, 1
        }
        # and don't append this one
        loop +next-character:label
      }
      # append anything else
      line <- append line, c
      line-done?:boolean <- equal c, 10/newline
      break-if line-done?
      # stop buffering on eof (currently only generated by fake console)
      eof?:boolean <- equal c, 0/eof
      break-if eof?
      loop
    }
    # copy line into 'out'
    i:number <- copy 0
    line-contents:address:shared:array:character <- get *line, data:offset
    max:number <- get *line, length:offset
    {
      done?:boolean <- greater-or-equal i, max
      break-if done?
      c:character <- index *line-contents, i
      out <- write out, c
      i <- add i, 1
      loop
    }
    loop
  }
]

scenario buffer-lines-blocks-until-newline [
  run [
    1:address:shared:channel/stdin <- new-channel 10/capacity
    2:address:shared:channel/buffered-stdin <- new-channel 10/capacity
    3:boolean <- channel-empty? 2:address:shared:channel/buffered-stdin
    assert 3:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty after init]
    # buffer stdin into buffered-stdin, try to read from buffered-stdin
    4:number/buffer-routine <- start-running buffer-lines, 1:address:shared:channel/stdin, 2:address:shared:channel/buffered-stdin
    wait-for-routine 4:number/buffer-routine
    5:boolean <- channel-empty? 2:address:shared:channel/buffered-stdin
    assert 5:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty after buffer-lines bring-up]
    # write 'a'
    1:address:shared:channel <- write 1:address:shared:channel, 97/a
    restart 4:number/buffer-routine
    wait-for-routine 4:number/buffer-routine
    6:boolean <- channel-empty? 2:address:shared:channel/buffered-stdin
    assert 6:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty after writing 'a']
    # write 'b'
    1:address:shared:channel <- write 1:address:shared:channel, 98/b
    restart 4:number/buffer-routine
    wait-for-routine 4:number/buffer-routine
    7:boolean <- channel-empty? 2:address:shared:channel/buffered-stdin
    assert 7:boolean, [
F buffer-lines-blocks-until-newline: channel should be empty after writing 'b']
    # write newline
    1:address:shared:channel <- write 1:address:shared:channel, 10/newline
    restart 4:number/buffer-routine
    wait-for-routine 4:number/buffer-routine
    8:boolean <- channel-empty? 2:address:shared:channel/buffered-stdin
    9:boolean/completed? <- not 8:boolean
    assert 9:boolean/completed?, [
F buffer-lines-blocks-until-newline: channel should contain data after writing newline]
    trace 1, [test], [reached end]
  ]
  trace-should-contain [
    test: reached end
  ]
]