aeron 0.2.0

Aeron client library - fast messaging over UDP on Rust
Documentation 
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

/*
 * Copyright 2020 UT OVERSEAS INC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use std::time::Duration;

use crate::concurrent::atomics::cpu_pause;
use crate::utils::types::Moment;

pub trait Strategy {
    fn idle_opt(&self, work_count: i32);
    fn idle(&self);
    fn reset(&self);
}

pub trait StrategyMut {
    fn idle_opt(&mut self, work_count: i32);
    fn idle(&mut self);
    fn reset(&mut self);
}

const BACK_OFF_STATE_NOT_IDLE: u8 = 0;
const BACK_OFF_STATE_SPINNING: u8 = 1;
const BACK_OFF_STATE_YIELDING: u8 = 2;
const BACK_OFF_STATE_PARKING: u8 = 3;

pub struct BackOffIdleStrategy {
    state: u8,
    spins: i32,
    max_spins: i32,
    yields: i32,
    max_yields: i32,
    park_period_ns: u64,
    min_park_period_ns: u64,
    max_park_period_ns: u64,
}

impl StrategyMut for BackOffIdleStrategy {
    fn idle_opt(&mut self, work_count: i32) {
        if work_count > 0 {
            self.reset();
        } else {
            self.idle();
        }
    }

    fn idle(&mut self) {
        match self.state {
            BACK_OFF_STATE_NOT_IDLE => {
                self.state = BACK_OFF_STATE_SPINNING;
                self.spins += 1;
            },
            BACK_OFF_STATE_SPINNING => {
                cpu_pause();
                self.spins += 1;
                if self.spins > self.max_spins {
                    self.state = BACK_OFF_STATE_YIELDING;
                    self.yields = 0;
                }
            },
            BACK_OFF_STATE_YIELDING => {
                self.yields += 1;
                if self.yields > self.max_yields {
                    self.state = BACK_OFF_STATE_PARKING;
                    self.park_period_ns = self.min_park_period_ns;
                } else {
                    std::thread::yield_now();
                }
            },
            BACK_OFF_STATE_PARKING => {},
            _ => {
                std::thread::sleep(Duration::from_nanos(self.park_period_ns));
                self.park_period_ns = std::cmp::min(self.park_period_ns * 2, self.max_park_period_ns);
            },
        }
    }

    fn reset(&mut self) {
        self.spins = 0;
        self.yields = 0;
        self.park_period_ns = self.min_park_period_ns;
        self.state = BACK_OFF_STATE_NOT_IDLE;
    }
}

#[derive(Default)]
pub struct BusySpinIdleStrategy {}

impl BusySpinIdleStrategy {
    fn pause() {
        cpu_pause();
    }
}

impl Strategy for BusySpinIdleStrategy {
    fn idle_opt(&self, work_count: i32) {
        if work_count > 0 {
            return;
        }
        Self::pause();
    }

    fn idle(&self) {
        Self::pause();
    }

    fn reset(&self) {}
}

pub struct NoOpIdleStrategy {}

impl Strategy for NoOpIdleStrategy {
    fn idle_opt(&self, _work_count: i32) {}

    fn idle(&self) {}

    fn reset(&self) {}
}

pub struct SleepingIdleStrategy {
    duration: Moment,
}

impl SleepingIdleStrategy {
    pub fn new(duration: Moment) -> Self {
        Self { duration }
    }
}

impl Strategy for SleepingIdleStrategy {
    fn idle_opt(&self, work_count: i32) {
        if 0 == work_count {
            std::thread::sleep(Duration::from_millis(self.duration));
        }
    }

    fn idle(&self) {
        std::thread::sleep(Duration::from_millis(self.duration));
    }

    fn reset(&self) {}
}

pub struct YieldingIdleStrategy {}

impl Strategy for YieldingIdleStrategy {
    fn idle_opt(&self, work_count: i32) {
        if 0 == work_count {
            return;
        }
        std::thread::yield_now();
    }

    fn idle(&self) {
        std::thread::yield_now();
    }

    fn reset(&self) {}
}