-
Notifications
You must be signed in to change notification settings - Fork 1
/
ring_queue.go
413 lines (360 loc) · 10.3 KB
/
ring_queue.go
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
// ©Hayabusa Cloud Co., Ltd. 2022. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package sox
import (
"errors"
"io"
"math"
"sync/atomic"
)
const (
defaultRingQueueCapacity = math.MaxInt16
)
// ItemProducer is the interface that Produce items and can be Close
type ItemProducer[ItemType any] interface {
// Produce produces items
Produce(item ItemType) error
// Close closed the ItemProducer
Close() error
}
// ItemConsumer is the interface that Consume items
type ItemConsumer[ItemType any] interface {
// Consume consumes items
Consume() (item ItemType, err error)
}
// NewRingQueue creates a ring queue with given options
// and returns the consumer and the producer of it
func NewRingQueue[ItemType any](
opts ...func(options *RingQueueOptions)) (
consumer ItemConsumer[ItemType],
producer ItemProducer[ItemType],
err error) {
o := &RingQueueOptions{
Capacity: defaultRingQueueCapacity,
ConcurrentProduce: true,
ConcurrentConsume: true,
Nonblocking: false,
}
for _, f := range opts {
f(o)
}
if o.Capacity < 1 || o.Capacity >= (1<<30) {
return nil, nil, errors.New("invalid ring queue capacity")
}
o.Capacity |= o.Capacity >> 1
o.Capacity |= o.Capacity >> 2
o.Capacity |= o.Capacity >> 4
o.Capacity |= o.Capacity >> 8
o.Capacity |= o.Capacity >> 16
if !o.ConcurrentProduce && !o.ConcurrentConsume {
ring := newRingQueue[ItemType](o)
return ring, ring, nil
} else if o.ConcurrentProduce && !o.ConcurrentConsume {
ring := newRingQueueConcurrentProduce[ItemType](o)
return ring, ring, nil
} else if !o.ConcurrentProduce && o.ConcurrentConsume {
ring := newRingQueueConcurrentConsume[ItemType](o)
return ring, ring, nil
}
ring := newRingQueueConcurrent[ItemType](o)
return ring, ring, nil
}
// RingQueueOptions holds optional parameters for RingQueue implementations
type RingQueueOptions struct {
// Capacity specifies the capacity of queue. The default Capacity is 32K
Capacity int
// ConcurrentProduce specifies whether the ItemProducer works concurrently or not
// It should be set as true, if there are multiple goroutines doing Produce operations
ConcurrentProduce bool
// ConcurrentConsume specifies whether the ItemConsumer works concurrently or not
// It should be set as true, if there are multiple goroutines doing Consumer operations
ConcurrentConsume bool
// Nonblocking specifies whether the Produce or Consume operations will NOT block
// even if it is temporarily unavailable or not
Nonblocking bool
}
type ringQueue[T any] struct {
_ noCopy
*RingQueueOptions
ring []T
capacity, head, tail uint32
closed bool
}
func newRingQueue[T any](opt *RingQueueOptions) *ringQueue[T] {
return &ringQueue[T]{
RingQueueOptions: opt,
ring: make([]T, opt.Capacity+1),
capacity: uint32(opt.Capacity),
head: 0,
tail: 0,
closed: false,
}
}
func (rq *ringQueue[T]) Produce(item T) error {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); sw.Once() {
if rq.closed {
return io.ErrClosedPipe
}
if (rq.tail+1)&rq.capacity == rq.head {
if rq.Nonblocking {
return ErrTemporarilyUnavailable
}
continue
}
break
}
rq.ring[rq.tail] = item
rq.tail = (rq.tail + 1) & rq.capacity
return nil
}
func (rq *ringQueue[T]) Consume() (item T, err error) {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); sw.Once() {
if rq.head == rq.tail {
if rq.closed {
return item, io.EOF
}
if rq.Nonblocking {
return item, ErrTemporarilyUnavailable
}
continue
}
break
}
item = rq.ring[rq.head]
rq.head = (rq.head + 1) & rq.capacity
return item, nil
}
func (rq *ringQueue[T]) Close() error {
rq.closed = true
return nil
}
const (
ringQueueStatusWriting = 1 << 31
ringQueueStatusClosed = 1 << 30
ringQueueTailStatusMask = ringQueueStatusWriting | ringQueueStatusClosed
ringQueueTailValueMask = (1 << 30) - 1
)
type ringQueueConcurrentProduce[T any] struct {
_ noCopy
*RingQueueOptions
ring []T
capacity, head uint32
*ringQueueConcurrentClose
}
func newRingQueueConcurrentProduce[T any](opt *RingQueueOptions) *ringQueueConcurrentProduce[T] {
return &ringQueueConcurrentProduce[T]{
RingQueueOptions: opt,
ring: make([]T, opt.Capacity+1),
capacity: uint32(opt.Capacity),
head: 0,
ringQueueConcurrentClose: newRingQueueConcurrentClose(),
}
}
func (rq *ringQueueConcurrentProduce[T]) Produce(item T) error {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); {
tail := rq.tail.Load()
if tail&ringQueueStatusWriting == ringQueueStatusWriting {
sw.Once()
continue
}
if tail&ringQueueStatusClosed == ringQueueStatusClosed {
return io.ErrClosedPipe
}
if ((tail&ringQueueTailValueMask)+1)&rq.capacity == rq.head {
if rq.Nonblocking {
break
}
sw.Once()
continue
}
newTailStatus, newTailVal := (tail|ringQueueStatusWriting)&ringQueueTailStatusMask, (tail+1)&rq.capacity
if swapped := rq.tail.CompareAndSwap(tail, newTailStatus|newTailVal); !swapped {
sw.OnceWithLevel(SpinWaitLevelPreempting)
continue
}
rq.ring[tail&ringQueueTailValueMask] = item
newTailStatus &= ringQueueTailStatusMask ^ ringQueueStatusWriting
rq.tail.Store(newTailStatus | newTailVal)
return nil
}
return ErrTemporarilyUnavailable
}
func (rq *ringQueueConcurrentProduce[T]) Consume() (item T, err error) {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); sw.Once() {
tail := rq.tail.Load()
if tail&ringQueueStatusWriting == ringQueueStatusWriting {
continue
}
tailStatus, tailVal := tail&ringQueueTailStatusMask, tail&ringQueueTailValueMask
if rq.head == tailVal {
if tailStatus&ringQueueStatusClosed == ringQueueStatusClosed {
return item, io.EOF
}
if rq.Nonblocking {
return item, ErrTemporarilyUnavailable
}
continue
}
item = rq.ring[rq.head]
rq.head = (rq.head + 1) & rq.capacity
return item, nil
}
return
}
type ringQueueConcurrentConsume[T any] struct {
_ noCopy
*RingQueueOptions
ring []T
capacity uint32
head atomic.Uint32
tail uint32
closed bool
}
func newRingQueueConcurrentConsume[T any](opt *RingQueueOptions) *ringQueueConcurrentConsume[T] {
return &ringQueueConcurrentConsume[T]{
RingQueueOptions: opt,
ring: make([]T, opt.Capacity+1),
capacity: uint32(opt.Capacity),
head: atomic.Uint32{},
tail: 0,
closed: false,
}
}
func (rq *ringQueueConcurrentConsume[T]) Produce(item T) error {
if rq.closed {
return io.ErrClosedPipe
}
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); sw.Once() {
if (rq.tail+1)&rq.capacity == rq.head.Load()&rq.capacity {
if rq.Nonblocking {
break
}
continue
}
rq.ring[rq.tail] = item
rq.tail = (rq.tail + 1) & rq.capacity
return nil
}
return ErrTemporarilyUnavailable
}
func (rq *ringQueueConcurrentConsume[T]) Consume() (item T, err error) {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); sw.Once() {
head := rq.head.Load()
if head == rq.tail {
if rq.closed {
return item, io.EOF
}
if rq.Nonblocking {
return item, ErrTemporarilyUnavailable
}
continue
}
item = rq.ring[head]
if swapped := rq.head.CompareAndSwap(head, (head+1)&rq.capacity); !swapped {
continue
}
return item, nil
}
return
}
func (rq *ringQueueConcurrentConsume[T]) Close() error {
rq.closed = true
return nil
}
type ringQueueConcurrent[T any] struct {
_ noCopy
*RingQueueOptions
ring []T
capacity uint32
head atomic.Uint32
*ringQueueConcurrentClose
}
func newRingQueueConcurrent[T any](opt *RingQueueOptions) *ringQueueConcurrent[T] {
return &ringQueueConcurrent[T]{
RingQueueOptions: opt,
ring: make([]T, opt.Capacity+1),
capacity: uint32(opt.Capacity),
head: atomic.Uint32{},
ringQueueConcurrentClose: newRingQueueConcurrentClose(),
}
}
func (rq *ringQueueConcurrent[T]) Produce(item T) error {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); {
tail := rq.tail.Load()
if tail&ringQueueStatusWriting == ringQueueStatusWriting {
sw.Once()
continue
}
if tail&ringQueueStatusClosed == ringQueueStatusClosed {
return io.ErrClosedPipe
}
if (tail+1)&rq.capacity == rq.head.Load() {
if rq.Nonblocking {
break
}
sw.Once()
continue
}
newTailStatus, newTailVal := (tail|ringQueueStatusWriting)&ringQueueTailStatusMask, (tail+1)&rq.capacity
if swapped := rq.tail.CompareAndSwap(tail, newTailStatus|newTailVal); !swapped {
sw.OnceWithLevel(SpinWaitLevelPreempting)
continue
}
rq.ring[tail&ringQueueTailValueMask] = item
newTailStatus &= ringQueueTailStatusMask ^ ringQueueStatusWriting
rq.tail.Store(newTailStatus | newTailVal)
return nil
}
return ErrTemporarilyUnavailable
}
func (rq *ringQueueConcurrent[T]) Consume() (item T, err error) {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); {
head, tail := rq.head.Load(), rq.tail.Load()
if head == tail&ringQueueTailValueMask {
if tail&ringQueueStatusClosed == ringQueueStatusClosed {
return item, io.EOF
}
if rq.Nonblocking {
return item, ErrTemporarilyUnavailable
}
sw.Once()
continue
}
if tail&ringQueueStatusWriting == ringQueueStatusWriting {
sw.Once()
continue
}
item = rq.ring[head]
if swapped := rq.head.CompareAndSwap(head, (head+1)&rq.capacity); !swapped {
sw.OnceWithLevel(SpinWaitLevelPreempting)
continue
}
return item, nil
}
return
}
type ringQueueConcurrentClose struct {
tail atomic.Uint32
}
func newRingQueueConcurrentClose() *ringQueueConcurrentClose {
return &ringQueueConcurrentClose{tail: atomic.Uint32{}}
}
func (rq *ringQueueConcurrentClose) Close() error {
for sw := NewSpinWaitWithLevel(SpinWaitLevelPending); !sw.Closed(); {
tail := rq.tail.Load()
if tail&ringQueueStatusClosed == ringQueueStatusClosed {
return nil
}
if tail&ringQueueStatusWriting == ringQueueStatusWriting {
sw.Once()
continue
}
if swapped := rq.tail.CompareAndSwap(tail, tail|ringQueueStatusClosed); !swapped {
sw.OnceWithLevel(SpinWaitLevelPreempting)
continue
}
break
}
return nil
}