aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/actors/core/cpu_state.h
blob: b8030149a7f463dac21d84fac3905037720e4ee9 (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
#pragma once

#include "defs.h"

#include <library/cpp/actors/util/futex.h>

namespace NActors {

    class alignas(64) TCpuState {
        // Atomic cachelign-aligned 64-bit state, see description below
        TAtomic State = 0;
        char Padding[64 - sizeof(TAtomic)];

        // Bits 0-31: Currently executing pool
        //  - value less than MaxPools means cpu is executing corresponding pool (fast-worker is executing or waiting for slow-workers)
        //  - one of Cpu* values in case of idle cpu
        //  - used as futex by blocked fast-worker
        static constexpr ui64 CurrentBits = 32;
        static constexpr ui64 CurrentMask = ui64((1ull << CurrentBits) - 1);

        // Bits 32-63: Assigned pool
        //  - value is set by balancer
        //  - NOT used as futex
        //  - Not balanced
        static constexpr ui64 AssignedOffs = 32;
        static constexpr ui64 AssignedMask = ~CurrentMask;

    public:
        TCpuState() {
            Y_UNUSED(Padding);
        }

        void Load(TPoolId& assigned, TPoolId& current) const {
            TAtomicBase state = AtomicLoad(&State);
            assigned = (state & AssignedMask) >> AssignedOffs;
            current = state & CurrentMask;
        }

        TPoolId CurrentPool() const {
            return TPoolId(AtomicLoad(&State) & CurrentMask);
        }

        void SwitchPool(TPoolId pool) {
            while (true) {
                TAtomicBase state = AtomicLoad(&State);
                if (AtomicCas(&State, (state & ~CurrentMask) | pool, state)) {
                    return;
                }
            }
        }

        TPoolId AssignedPool() const {
            return TPoolId((AtomicLoad(&State) & AssignedMask) >> AssignedOffs);
        }

        // Assigns new pool to cpu and wakes it up if cpu is idle
        void AssignPool(TPoolId pool) {
            while (true) {
                TAtomicBase state = AtomicLoad(&State);
                TPoolId current(state & CurrentMask);
                if (Y_UNLIKELY(current == CpuStopped)) {
                    return; // it would be better to shutdown instead of balancing
                }
                // Idle cpu must be woken up after balancing to handle pending tokens (if any) in assigned/schedulable pool(s)
                if (current == CpuSpinning) {
                    if (AtomicCas(&State, (ui64(pool) << AssignedOffs) | pool, state)) {
                        return; // successfully woken up
                    }
                } else if (current == CpuBlocked) {
                    if (AtomicCas(&State, (ui64(pool) << AssignedOffs) | pool, state)) {
                        FutexWake();
                        return; // successfully woken up
                    }
                } else {
                    if (AtomicCas(&State, (ui64(pool) << AssignedOffs) | (state & ~AssignedMask), state)) {
                        return; // wakeup is not required
                    }
                }
            }
        }

        void Stop() {
            while (true) {
                TAtomicBase state = AtomicLoad(&State);
                if (AtomicCas(&State, (state & ~CurrentMask) | CpuStopped, state)) {
                    FutexWake();
                    return; // successfully stopped
                }
            }
        }

        // Start waiting, returns false in case of actorsystem shutdown
        bool StartSpinning() {
            while (true) {
                TAtomicBase state = AtomicLoad(&State);
                TPoolId current(state & CurrentMask);
                if (Y_UNLIKELY(current == CpuStopped)) {
                    return false;
                }
                Y_VERIFY_DEBUG(current < MaxPools, "unexpected already waiting state of cpu (%d)", (int)current);
                if (AtomicCas(&State, (state & ~CurrentMask) | CpuSpinning, state)) { // successfully marked as spinning
                    return true;
                }
            }
        }

        bool StartBlocking() {
            while (true) {
                TAtomicBase state = AtomicLoad(&State);
                TPoolId current(state & CurrentMask);
                if (current == CpuSpinning) {
                    if (AtomicCas(&State, (state & ~CurrentMask) | CpuBlocked, state)) {
                        return false; // successful switch
                    }
                } else {
                    return true; // wakeup
                }
            }
        }

        bool Block(ui64 timeoutNs, TPoolId& result) {
#ifdef _linux_
            timespec timeout;
            timeout.tv_sec = timeoutNs / 1'000'000'000;
            timeout.tv_nsec = timeoutNs % 1'000'000'000;
            SysFutex(Futex(), FUTEX_WAIT_PRIVATE, CpuBlocked, &timeout, nullptr, 0);
#else
            NanoSleep(timeoutNs); // non-linux wake is not supported, cpu will go idle on wake after blocked state
#endif
            TAtomicBase state = AtomicLoad(&State);
            TPoolId current(state & CurrentMask);
            if (current == CpuBlocked) {
                return false; // timeout
            } else {
                result = current;
                return true; // wakeup
            }
        }

        enum EWakeResult {
            Woken, // successfully woken up
            NotIdle, // cpu is already not idle
            Forbidden, // cpu is assigned to another pool
            Stopped, // cpu is shutdown
        };

        EWakeResult WakeWithoutToken(TPoolId pool) {
            while (true) {
                TAtomicBase state = RelaxedLoad(&State);
                TPoolId current(state & CurrentMask);
                TPoolId assigned((state & AssignedMask) >> AssignedOffs);
                if (assigned == CpuShared || assigned == pool) {
                    if (current == CpuSpinning) {
                        if (AtomicCas(&State, (state & ~CurrentMask) | pool, state)) {
                            return Woken;
                        }
                    } else if (current == CpuBlocked) {
                        if (AtomicCas(&State, (state & ~CurrentMask) | pool, state)) {
                            FutexWake();
                            return Woken;
                        }
                    } else if (current == CpuStopped) {
                        return Stopped;
                    } else {
                        return NotIdle;
                    }
                } else {
                    return Forbidden;
                }
            }
        }

        EWakeResult WakeWithTokenAcquired(TPoolId token) {
            while (true) {
                TAtomicBase state = RelaxedLoad(&State);
                TPoolId current(state & CurrentMask);
                // NOTE: We ignore assigned value because we already have token, so
                // NOTE: not assigned pool may be run here. This will be fixed
                // NOTE: after we finish with current activation
                if (current == CpuSpinning) {
                    if (AtomicCas(&State, (state & ~CurrentMask) | token, state)) {
                        return Woken;
                    }
                } else if (current == CpuBlocked) {
                    if (AtomicCas(&State, (state & ~CurrentMask) | token, state)) {
                        FutexWake();
                        return Woken;
                    }
                } else if (current == CpuStopped) {
                    return Stopped;
                } else {
                    return NotIdle;
                }
            }
        }

        bool IsPoolReassigned(TPoolId current) const {
            TAtomicBase state = AtomicLoad(&State);
            TPoolId assigned((state & AssignedMask) >> AssignedOffs);
            return assigned != current;
        }

    private:
        void* Futex() {
            return (void*)&State; // little endian assumed
        }

        void FutexWake() {
#ifdef _linux_
            SysFutex(Futex(), FUTEX_WAKE_PRIVATE, 1, nullptr, nullptr, 0);
#endif
        }
    };

}