forked from schets/multiqueue
/
multiqueue.rs
1125 lines (1002 loc) · 35.1 KB
/
multiqueue.rs
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use std::cell::Cell;
use std::collections::VecDeque;
use std::fmt;
use std::marker::PhantomData;
use std::mem;
use std::ptr;
use std::sync::atomic::Ordering::*;
use std::sync::atomic::{fence, AtomicUsize};
use std::sync::mpsc::{RecvError, SendError, TryRecvError, TrySendError};
use std::sync::Arc;
use std::thread::yield_now;
use crate::alloc;
use crate::atomicsignal::LoadedSignal;
use crate::countedindex::{
get_valid_wrap, is_tagged, rm_tag, CountedIndex, Index, INITIAL_QUEUE_FLAG,
};
use crate::memory::{MemToken, MemoryManager};
use crate::wait::*;
use crate::read_cursor::{ReadCursor, Reader};
extern crate atomic_utilities;
extern crate futures;
extern crate parking_lot;
extern crate smallvec;
use self::futures::task::{current, Task};
use self::futures::{Async, AsyncSink, Poll, Sink, StartSend, Stream};
use self::atomic_utilities::artificial_dep::{dependently_mut, DepOrd};
/// This is basically acting as a static bool
/// so the queue can act as a normal mpmc in other circumstances
pub trait QueueRW<T> {
fn inc_ref(_: &AtomicUsize);
fn dec_ref(_: &AtomicUsize);
fn check_ref(_: &AtomicUsize) -> bool;
fn do_drop() -> bool;
unsafe fn get_val(_: &mut T) -> T;
fn forget_val(_: T);
unsafe fn drop_in_place(_: &mut T);
}
#[derive(Clone)]
pub struct BCast<T> {
mk: PhantomData<T>,
}
impl<T: Clone> QueueRW<T> for BCast<T> {
// TODO: Skip refcount when type is copyable or clone is safe on junk data
#[inline(always)]
fn inc_ref(r: &AtomicUsize) {
r.fetch_add(1, atomic_utilities::fence_rmw::RMWOrder);
atomic_utilities::fence_rmw::fence_rmw();
}
// TODO: Skip refcount when type is copyable or clone is safe on junk data
#[inline(always)]
fn dec_ref(r: &AtomicUsize) {
r.fetch_sub(1, Relaxed);
}
#[inline(always)]
fn check_ref(r: &AtomicUsize) -> bool {
r.load(Relaxed) == 0
}
#[inline(always)]
fn do_drop() -> bool {
true
}
#[inline(always)]
unsafe fn get_val(val: &mut T) -> T {
val.clone()
}
#[inline(always)]
fn forget_val(_v: T) {}
#[inline(always)]
unsafe fn drop_in_place(_v: &mut T) {}
}
#[derive(Clone)]
pub struct MPMC<T> {
mk: PhantomData<T>,
}
impl<T> QueueRW<T> for MPMC<T> {
#[inline(always)]
fn inc_ref(_r: &AtomicUsize) {}
#[inline(always)]
fn dec_ref(_r: &AtomicUsize) {}
#[inline(always)]
fn check_ref(_r: &AtomicUsize) -> bool {
true
}
#[inline(always)]
fn do_drop() -> bool {
false
}
#[inline(always)]
unsafe fn get_val(val: &mut T) -> T {
ptr::read(val)
}
#[inline(always)]
fn forget_val(val: T) {
mem::forget(val);
}
#[inline(always)]
unsafe fn drop_in_place(val: &mut T) {
ptr::drop_in_place(val);
}
}
#[derive(Clone, Copy)]
enum QueueState {
Uni,
Multi,
}
/// This holds entries in the queue
struct QueueEntry<T> {
val: T,
wraps: AtomicUsize,
}
/// This holds the refcount object
struct RefCnt {
refcnt: AtomicUsize,
_buffer: [u8; 64],
}
/// A bounded queue that supports multiple reader and writers
/// and supports effecient methods for single consumers and producers
#[repr(C)]
pub struct MultiQueue<RW: QueueRW<T>, T> {
d1: [u8; 64],
// Writer data
head: CountedIndex,
tail_cache: AtomicUsize,
writers: AtomicUsize,
d2: [u8; 64],
// Shared Data
// The data and the wraps flag are in the same location
// to reduce the # of distinct cache lines read when getting an item
// The tail itself is rarely modified, making it a suitable candidate
// to be in the shared space
tail: ReadCursor,
data: *mut QueueEntry<T>,
refs: *mut RefCnt,
capacity: isize,
pub waiter: Arc<Wait>,
needs_notify: bool,
mk: PhantomData<RW>,
d3: [u8; 64],
pub manager: MemoryManager,
d4: [u8; 64],
}
pub struct InnerSend<RW: QueueRW<T>, T> {
queue: Arc<MultiQueue<RW, T>>,
token: *const MemToken,
state: Cell<QueueState>,
}
pub struct InnerRecv<RW: QueueRW<T>, T> {
queue: Arc<MultiQueue<RW, T>>,
reader: Reader,
token: *const MemToken,
alive: bool,
}
/// This is a sender that can transparently act as a futures stream
pub struct FutInnerSend<RW: QueueRW<T>, T> {
writer: InnerSend<RW, T>,
wait: Arc<FutWait>,
prod_wait: Arc<FutWait>,
}
/// This is a receiver that can transparently act as a futures stream
pub struct FutInnerRecv<RW: QueueRW<T>, T> {
reader: InnerRecv<RW, T>,
wait: Arc<FutWait>,
prod_wait: Arc<FutWait>,
}
pub struct FutInnerUniRecv<RW: QueueRW<T>, R, F: FnMut(&T) -> R, T> {
reader: InnerRecv<RW, T>,
wait: Arc<FutWait>,
prod_wait: Arc<FutWait>,
pub op: F,
}
struct FutWait {
spins_first: usize,
spins_yield: usize,
parked: parking_lot::Mutex<VecDeque<Task>>,
}
impl<RW: QueueRW<T>, T> MultiQueue<RW, T> {
pub fn create_tx_rx(_capacity: Index) -> (InnerSend<RW, T>, InnerRecv<RW, T>) {
MultiQueue::create_tx_rx_with(_capacity, BlockingWait::new())
}
pub fn create_tx_rx_with<W: Wait + 'static>(
capacity: Index,
wait: W,
) -> (InnerSend<RW, T>, InnerRecv<RW, T>) {
MultiQueue::new_internal(capacity, Arc::new(wait))
}
fn new_internal(_capacity: Index, wait: Arc<Wait>) -> (InnerSend<RW, T>, InnerRecv<RW, T>) {
let capacity = get_valid_wrap(_capacity);
let queuedat: *mut QueueEntry<T> = alloc::allocate(capacity as usize);
let refdat: *mut RefCnt = alloc::allocate(capacity as usize);
unsafe {
for i in 0..capacity as isize {
let elem: &QueueEntry<T> = &*queuedat.offset(i);
elem.wraps.store(INITIAL_QUEUE_FLAG, Relaxed);
let refd: &RefCnt = &*refdat.offset(i);
refd.refcnt.store(0, Relaxed);
}
}
let (cursor, reader) = ReadCursor::new(capacity);
let needs_notify = wait.needs_notify();
let queue = MultiQueue {
d1: unsafe { mem::uninitialized() },
head: CountedIndex::new(capacity),
tail_cache: AtomicUsize::new(0),
writers: AtomicUsize::new(1),
d2: unsafe { mem::uninitialized() },
tail: cursor,
data: queuedat,
refs: refdat,
capacity: capacity as isize,
waiter: wait,
needs_notify,
mk: PhantomData,
d3: unsafe { mem::uninitialized() },
manager: MemoryManager::new(),
d4: unsafe { mem::uninitialized() },
};
let qarc = Arc::new(queue);
let mwriter = InnerSend {
queue: qarc.clone(),
state: Cell::new(QueueState::Uni),
token: qarc.manager.get_token(),
};
let mreader = InnerRecv {
queue: qarc.clone(),
reader,
token: qarc.manager.get_token(),
alive: true,
};
(mwriter, mreader)
}
pub fn try_send_multi(&self, val: T) -> Result<(), TrySendError<T>> {
let mut transaction = self.head.load_transaction(Relaxed);
unsafe {
loop {
let (chead, wrap_valid_tag) = transaction.get();
let tail_cache = self.tail_cache.load(Relaxed);
if transaction.matches_previous(tail_cache) {
let new_tail = self.reload_tail_multi(tail_cache, wrap_valid_tag);
if transaction.matches_previous(new_tail) {
return Err(TrySendError::Full(val));
}
}
let write_cell = &mut *self.data.offset(chead);
let ref_cell = &*self.refs.offset(chead);
if !RW::check_ref(&ref_cell.refcnt) {
return Err(TrySendError::Full(val));
}
fence(Acquire);
match transaction.commit(1, Relaxed) {
Some(new_transaction) => transaction = new_transaction,
None => {
let current_tag = write_cell.wraps.load(Relaxed);
// This will delay the dropping of the exsisting item until
// after the write is done. This will have a marginal effect on
// throughput in most cases but will really help latency.
// Hopefully the compiler is smart enough to get rid of this
// when there's no drop
let _possible_drop = if RW::do_drop() && !is_tagged(current_tag) {
Some(ptr::read(&write_cell.val))
} else {
None
};
ptr::write(&mut write_cell.val, val);
write_cell.wraps.store(wrap_valid_tag, Release);
return Ok(());
}
}
}
}
}
pub fn try_send_single(&self, val: T) -> Result<(), TrySendError<T>> {
let transaction = self.head.load_transaction(Relaxed);
let (chead, wrap_valid_tag) = transaction.get();
unsafe {
let tail_cache = self.tail_cache.load(Relaxed);
if transaction.matches_previous(tail_cache) {
let new_tail = self.reload_tail_single(wrap_valid_tag);
if transaction.matches_previous(new_tail) {
return Err(TrySendError::Full(val));
}
}
let write_cell = &mut *self.data.offset(chead);
let ref_cell = &*self.refs.offset(chead);
if !RW::check_ref(&ref_cell.refcnt) {
return Err(TrySendError::Full(val));
}
fence(Acquire);
transaction.commit_direct(1, Relaxed);
let current_tag = write_cell.wraps.load(Relaxed);
let _possible_drop = if RW::do_drop() && !is_tagged(current_tag) {
Some(ptr::read(&write_cell.val))
} else {
None
};
ptr::write(&mut write_cell.val, val);
write_cell.wraps.store(wrap_valid_tag, Release);
Ok(())
}
}
pub fn try_recv(&self, reader: &Reader) -> Result<T, (*const AtomicUsize, TryRecvError)> {
let mut ctail_attempt = reader.load_attempt(Relaxed);
let is_single = reader.is_single();
unsafe {
loop {
let (ctail, wrap_valid_tag) = ctail_attempt.get();
let read_cell = &mut *self.data.offset(ctail);
// For any curious readers, this gnarly if block catchs a race between
// advancing the write index and unsubscribing from the queue. in short,
// Since unsubscribe happens after the read_cell is written, there's a race
// between the first and second if statements. Hence, a second check is required
// after the writer load so ensure that the the wrap_valid_tag is still wrong so
// we had actually seen a race. Doing it this way removes fences on the fast path
let seen_tag = read_cell.wraps.load(DepOrd);
if rm_tag(seen_tag) != wrap_valid_tag {
if self.writers.load(Relaxed) == 0 {
fence(Acquire);
if rm_tag(read_cell.wraps.load(Acquire)) != wrap_valid_tag {
return Err((ptr::null(), TryRecvError::Disconnected));
}
}
return Err((&read_cell.wraps, TryRecvError::Empty));
}
let ref_cell = &*self.refs.offset(ctail);
if !is_single {
RW::inc_ref(&ref_cell.refcnt);
if reader.load_count(Relaxed) != wrap_valid_tag {
RW::dec_ref(&ref_cell.refcnt);
ctail_attempt = ctail_attempt.reload();
continue;
}
}
let rval = dependently_mut(seen_tag, &mut read_cell.val, |rc| RW::get_val(rc));
fence(Release);
if !is_single {
RW::dec_ref(&ref_cell.refcnt);
}
match ctail_attempt.commit_attempt(1, Relaxed) {
Some(new_attempt) => {
ctail_attempt = new_attempt;
RW::forget_val(rval);
}
None => return Ok(rval),
}
}
}
}
pub fn try_recv_view<R, F: FnOnce(&T) -> R>(
&self,
op: F,
reader: &Reader,
) -> Result<R, (F, *const AtomicUsize, TryRecvError)> {
let ctail_attempt = reader.load_attempt(Relaxed);
unsafe {
let (ctail, wrap_valid_tag) = ctail_attempt.get();
let read_cell = &mut *self.data.offset(ctail);
let seen_tag = rm_tag(read_cell.wraps.load(DepOrd));
if seen_tag != wrap_valid_tag {
if self.writers.load(Relaxed) == 0 {
fence(Acquire);
if rm_tag(read_cell.wraps.load(Acquire)) != wrap_valid_tag {
return Err((op, ptr::null(), TryRecvError::Disconnected));
}
}
return Err((op, &read_cell.wraps, TryRecvError::Empty));
}
dependently_mut(seen_tag, &mut read_cell.val, |rv_ref| {
let rval = op(rv_ref);
RW::drop_in_place(rv_ref);
ctail_attempt.commit_direct(1, Release);
Ok(rval)
})
}
}
fn reload_tail_multi(&self, tail_cache: usize, count: usize) -> usize {
if let Some(max_diff_from_head) = self.tail.get_max_diff(count) {
let current_tail = CountedIndex::get_previous(count, max_diff_from_head);
if tail_cache == current_tail {
return current_tail;
}
match self
.tail_cache
.compare_exchange(tail_cache, current_tail, AcqRel, Relaxed)
{
Ok(_) => current_tail,
Err(val) => val,
}
} else {
self.tail_cache.load(Acquire)
}
}
fn reload_tail_single(&self, count: usize) -> usize {
let max_diff_from_head = self.tail.get_max_diff(count).expect(
"The write head got ran over by consumers in single writer mode. This \
process is borked!",
);
let current_tail = CountedIndex::get_previous(count, max_diff_from_head);
self.tail_cache.store(current_tail, Relaxed);
current_tail
}
}
impl<RW: QueueRW<T>, T> InnerSend<RW, T> {
#[inline(always)]
pub fn try_send(&self, val: T) -> Result<(), TrySendError<T>> {
let signal = self.queue.manager.signal.load(Relaxed);
if signal.has_action() {
let disconnected = self.handle_signals(signal);
if disconnected {
return Err(TrySendError::Full(val));
}
}
let val = match self.state.get() {
QueueState::Uni => self.queue.try_send_single(val),
QueueState::Multi => {
if self.queue.writers.load(Relaxed) == 1 {
fence(Acquire);
self.state.set(QueueState::Uni);
self.queue.try_send_single(val)
} else {
self.queue.try_send_multi(val)
}
}
};
// Putting this in the send functions
// greatly confuses the compiler and literally halfs
// the performance of the queue. I suspect the compiler
// always sets up a stack from regardless of the condition
// and that hurts optimizations around it.
if val.is_ok() && self.queue.needs_notify {
self.queue.waiter.notify();
}
val
}
/// Removes the writer as a producer to the queue
pub fn unsubscribe(self) {}
#[cold]
fn handle_signals(&self, signal: LoadedSignal) -> bool {
if signal.get_epoch() {
self.queue.manager.update_token(self.token);
}
signal.get_reader()
}
}
impl<RW: QueueRW<T>, T> InnerRecv<RW, T> {
#[inline(always)]
pub fn try_recv(&self) -> Result<T, TryRecvError> {
self.examine_signals();
match self.queue.try_recv(&self.reader) {
Ok(v) => Ok(v),
Err((_, e)) => Err(e),
}
}
pub fn recv(&self) -> Result<T, RecvError> {
self.examine_signals();
loop {
match self.queue.try_recv(&self.reader) {
Ok(v) => return Ok(v),
Err((_, TryRecvError::Disconnected)) => return Err(RecvError),
Err((pt, TryRecvError::Empty)) => {
let count = self.reader.load_count(Relaxed);
unsafe {
self.queue.waiter.wait(count, &*pt, &self.queue.writers);
}
}
}
}
}
pub fn is_single(&self) -> bool {
self.reader.get_consumers() == 1
}
#[inline(always)]
pub fn try_recv_view<R, F: FnOnce(&T) -> R>(&self, op: F) -> Result<R, (F, TryRecvError)> {
self.examine_signals();
match self.queue.try_recv_view(op, &self.reader) {
Ok(v) => Ok(v),
Err((op, _, e)) => Err((op, e)),
}
}
pub fn recv_view<R, F: FnOnce(&T) -> R>(&self, mut op: F) -> Result<R, (F, RecvError)> {
self.examine_signals();
loop {
match self.queue.try_recv_view(op, &self.reader) {
Ok(v) => return Ok(v),
Err((o, _, TryRecvError::Disconnected)) => return Err((o, RecvError)),
Err((o, pt, TryRecvError::Empty)) => {
op = o;
let count = self.reader.load_count(Relaxed);
unsafe {
self.queue.waiter.wait(count, &*pt, &self.queue.writers);
}
}
}
}
}
pub fn add_stream(&self) -> InnerRecv<RW, T> {
InnerRecv {
queue: self.queue.clone(),
reader: self
.queue
.tail
.add_stream(&self.reader, &self.queue.manager),
token: self.queue.manager.get_token(),
alive: true,
}
}
#[inline(always)]
fn examine_signals(&self) {
let signal = self.queue.manager.signal.load(Relaxed);
if signal.has_action() {
self.handle_signals(signal);
}
}
#[cold]
fn handle_signals(&self, signal: LoadedSignal) {
if signal.get_epoch() {
self.queue.manager.update_token(self.token);
}
}
pub fn unsubscribe(self) -> bool {
self.reader.get_consumers() == 1
}
/// Runs the passed function after unsubscribing the reader from the queue
unsafe fn do_unsubscribe_with<F: FnOnce()>(&mut self, f: F) {
if self.alive {
self.alive = false;
if self.reader.remove_consumer() == 1 {
if self
.queue
.tail
.remove_reader(&self.reader, &self.queue.manager)
{
self.queue.manager.signal.set_reader(SeqCst);
}
self.queue.manager.remove_token(self.token);
}
fence(SeqCst);
f()
}
}
}
impl<RW: QueueRW<T>, T> FutInnerSend<RW, T> {
/// Identical to InnerSend::try_send()
pub fn try_send(&self, val: T) -> Result<(), TrySendError<T>> {
self.writer.try_send(val)
}
/// Identical to InnerSend::unsubscribe()
pub fn unsubscribe(self) {
self.writer.unsubscribe()
}
}
type IntoSingleResult<RW, R, F, T> = Result<FutInnerUniRecv<RW, R, F, T>, (F, FutInnerRecv<RW, T>)>;
impl<RW: QueueRW<T>, T> FutInnerRecv<RW, T> {
/// Identical to InnerRecv::try_recv()
#[inline(always)]
pub fn try_recv(&self) -> Result<T, TryRecvError> {
self.reader.try_recv()
}
#[inline(always)]
pub fn recv(&self) -> Result<T, RecvError> {
self.reader.recv()
}
/// Creates a new stream and returns a FutInnerRecv on that stream
pub fn add_stream(&self) -> FutInnerRecv<RW, T> {
let rx = self.reader.add_stream();
FutInnerRecv {
reader: rx,
wait: self.wait.clone(),
prod_wait: self.prod_wait.clone(),
}
}
/// Attempts to transform this receiver into a FutInnerUniRecv
/// calling the passed function on the input data.
pub fn into_single<R, F: FnMut(&T) -> R>(self, op: F) -> IntoSingleResult<RW, R, F, T> {
let new_mreader;
let new_pwait = self.prod_wait.clone();
let new_wait = self.wait.clone();
{
new_mreader = self.reader.clone();
drop(self);
}
if new_mreader.is_single() {
Ok(FutInnerUniRecv {
reader: new_mreader,
wait: new_wait,
prod_wait: new_pwait,
op,
})
} else {
Err((
op,
FutInnerRecv {
reader: new_mreader,
wait: new_wait,
prod_wait: new_pwait,
},
))
}
}
/// Identical to InnerRecv::unsubscribe()
pub fn unsubscribe(self) -> bool {
self.reader.reader.get_consumers() == 1
}
}
/// This struct acts as a UniInnerRecv except operating as a futures Stream on incoming data
///
/// Since this operates in an iterator-like manner on the data stream, it holds the function
/// it calls and to use a different function must transform itself into a different
/// FutInnerUniRecv using transform_operation
impl<RW: QueueRW<T>, R, F: FnMut(&T) -> R, T> FutInnerUniRecv<RW, R, F, T> {
/// Identical to UniInnerRecv::try_recv, uses operation held by FutInnerUniRecv
#[inline(always)]
pub fn try_recv(&mut self) -> Result<R, TryRecvError> {
let opref = &mut self.op;
let rval = self.reader.try_recv_view(|tr| opref(tr));
self.prod_wait.notify_all();
rval.map_err(|x| x.1)
}
/// Identical to UniInnerRecv::recv, uses operation held by FutInnerUniRecv
#[inline(always)]
pub fn recv(&mut self) -> Result<R, RecvError> {
let opref = &mut self.op;
let rval = self.reader.recv_view(|tr| opref(tr));
self.prod_wait.notify_all();
rval.map_err(|x| x.1)
}
/// Adds another stream to the queue with a FutInnerUniRecv using the passed function
pub fn add_stream_with<Q, FQ: FnMut(&T) -> Q>(&self, op: FQ) -> FutInnerUniRecv<RW, Q, FQ, T> {
let rx = self.reader.add_stream();
FutInnerUniRecv {
reader: rx,
wait: self.wait.clone(),
prod_wait: self.prod_wait.clone(),
op,
}
}
/// Identical to InnerRecv::unsubscribe()
pub fn unsubscribe(self) -> bool {
self.reader.reader.get_consumers() == 1
}
pub fn into_multi(self) -> FutInnerRecv<RW, T> {
let new_reader = self.reader.add_stream();
FutInnerRecv {
reader: new_reader,
wait: self.wait.clone(),
prod_wait: self.prod_wait.clone(),
}
}
}
//////// Fut stream/sink implementations
impl<RW: QueueRW<T>, T> Sink for FutInnerSend<RW, T> {
type SinkItem = T;
type SinkError = SendError<T>;
/// Essentially try_send except parks if the queue is full
fn start_send(&mut self, msg: T) -> StartSend<T, SendError<T>> {
match self
.prod_wait
.send_or_park(|m| self.writer.try_send(m), msg)
{
Ok(_) => {
// see InnerSend::try_recv for why this isn't in the queue
if self.writer.queue.needs_notify {
self.writer.queue.waiter.notify();
}
Ok(AsyncSink::Ready)
}
Err(TrySendError::Full(msg)) => Ok(AsyncSink::NotReady(msg)),
Err(TrySendError::Disconnected(msg)) => Err(SendError(msg)),
}
}
#[inline(always)]
fn poll_complete(&mut self) -> Poll<(), SendError<T>> {
Ok(Async::Ready(()))
}
}
impl<RW: QueueRW<T>, T> Stream for FutInnerRecv<RW, T> {
type Item = T;
type Error = ();
/// Essentially the same as recv
#[inline]
fn poll(&mut self) -> Poll<Option<T>, ()> {
self.reader.examine_signals();
loop {
match self.reader.queue.try_recv(&self.reader.reader) {
Ok(msg) => {
self.prod_wait.notify_all();
return Ok(Async::Ready(Some(msg)));
}
Err((_, TryRecvError::Disconnected)) => return Ok(Async::Ready(None)),
Err((pt, _)) => {
let count = self.reader.reader.load_count(Relaxed);
if unsafe { self.wait.fut_wait(count, &*pt, &self.reader.queue.writers) } {
return Ok(Async::NotReady);
}
}
}
}
}
}
impl<RW: QueueRW<T>, R, F: for<'r> FnMut(&T) -> R, T> Stream for FutInnerUniRecv<RW, R, F, T> {
type Item = R;
type Error = ();
#[inline]
fn poll(&mut self) -> Poll<Option<R>, ()> {
self.reader.examine_signals();
loop {
let opref = &mut self.op;
match self.reader.queue.try_recv_view(opref, &self.reader.reader) {
Ok(msg) => {
self.prod_wait.notify_all();
return Ok(Async::Ready(Some(msg)));
}
Err((_, _, TryRecvError::Disconnected)) => return Ok(Async::Ready(None)),
Err((_, pt, _)) => {
let count = self.reader.reader.load_count(Relaxed);
if unsafe { self.wait.fut_wait(count, &*pt, &self.reader.queue.writers) } {
return Ok(Async::NotReady);
}
}
}
}
}
}
//////// FutWait
impl FutWait {
pub fn new() -> FutWait {
FutWait::with_spins(DEFAULT_TRY_SPINS, DEFAULT_YIELD_SPINS)
}
pub fn with_spins(spins_first: usize, spins_yield: usize) -> FutWait {
FutWait {
spins_first,
spins_yield,
parked: parking_lot::Mutex::new(VecDeque::new()),
}
}
pub fn fut_wait(&self, seq: usize, at: &AtomicUsize, wc: &AtomicUsize) -> bool {
if self.spin(seq, at, wc) && self.park(seq, at, wc) {
::std::thread::sleep(::std::time::Duration::from_millis(100));
true
} else {
false
}
}
pub fn spin(&self, seq: usize, at: &AtomicUsize, wc: &AtomicUsize) -> bool {
for _ in 0..self.spins_first {
if check(seq, at, wc) {
return false;
}
}
for _ in 0..self.spins_yield {
yield_now();
if check(seq, at, wc) {
return false;
}
}
true
}
pub fn park(&self, seq: usize, at: &AtomicUsize, wc: &AtomicUsize) -> bool {
let mut parked = self.parked.lock();
if check(seq, at, wc) {
return false;
}
parked.push_back(current());
true
}
fn send_or_park<T, F: Fn(T) -> Result<(), TrySendError<T>>>(
&self,
f: F,
mut val: T,
) -> Result<(), TrySendError<T>> {
for _ in 0..self.spins_first {
match f(val) {
Err(TrySendError::Full(v)) => val = v,
v => return v,
}
}
for _ in 0..self.spins_yield {
yield_now();
match f(val) {
Err(TrySendError::Full(v)) => val = v,
v => return v,
}
}
let mut parked = self.parked.lock();
match f(val) {
Err(TrySendError::Full(v)) => {
parked.push_back(current());
Err(TrySendError::Full(v))
}
v => v,
}
}
fn notify_all(&self) {
let mut parked = self.parked.lock();
for val in parked.drain(..) {
val.notify();
}
}
}
impl Wait for FutWait {
#[cold]
fn wait(&self, _seq: usize, _w_pos: &AtomicUsize, _wc: &AtomicUsize) {
panic!("Somehow normal wait got called in futures queue");
}
fn notify(&self) {
let mut parked = self.parked.lock();
if parked.len() > 0 {
if parked.len() > 8 {
for val in parked.drain(..) {
val.notify();
}
} else {
let mut inline_v = smallvec::SmallVec::<[Task; 9]>::new();
inline_v.extend(parked.drain(..));
drop(parked);
for val in inline_v.drain() {
val.notify();
}
}
}
}
fn needs_notify(&self) -> bool {
true
}
}
//////// Clone implementations
impl<RW: QueueRW<T>, T> Clone for InnerSend<RW, T> {
fn clone(&self) -> InnerSend<RW, T> {
self.state.set(QueueState::Multi);
let rval = InnerSend {
queue: self.queue.clone(),
state: Cell::new(QueueState::Multi),
token: self.queue.manager.get_token(),
};
self.queue.writers.fetch_add(1, SeqCst);
rval
}
}
impl<RW: QueueRW<T>, T> Clone for InnerRecv<RW, T> {
fn clone(&self) -> InnerRecv<RW, T> {
self.reader.dup_consumer();
InnerRecv {
queue: self.queue.clone(),
reader: self.reader.clone(),
token: self.queue.manager.get_token(),
alive: true,
}
}
}
impl<RW: QueueRW<T>, T> Clone for FutInnerSend<RW, T> {
fn clone(&self) -> FutInnerSend<RW, T> {
FutInnerSend {
writer: self.writer.clone(),
wait: self.wait.clone(),
prod_wait: self.prod_wait.clone(),
}
}
}
impl<RW: QueueRW<T>, T> Clone for FutInnerRecv<RW, T> {
fn clone(&self) -> FutInnerRecv<RW, T> {
FutInnerRecv {
reader: self.reader.clone(),
wait: self.wait.clone(),
prod_wait: self.prod_wait.clone(),
}
}
}
impl Clone for FutWait {
fn clone(&self) -> FutWait {
FutWait::with_spins(self.spins_first, self.spins_yield)
}
}
//////// Drop implementations
impl<RW: QueueRW<T>, T> Drop for InnerSend<RW, T> {
fn drop(&mut self) {
self.queue.writers.fetch_sub(1, SeqCst);
fence(SeqCst);
self.queue.manager.remove_token(self.token);
self.queue.waiter.notify();
}
}
impl<RW: QueueRW<T>, T> Drop for InnerRecv<RW, T> {
fn drop(&mut self) {
unsafe { self.do_unsubscribe_with(|| ()) }
}
}