File: spinlock.h

package info (click to toggle)
libatomic-queue 0.0%2Bgit20220518.83774a2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,352 kB
  • sloc: cpp: 1,620; javascript: 353; makefile: 131; python: 82; ansic: 74; sh: 59
file content (203 lines) | stat: -rw-r--r-- 6,098 bytes parent folder | download | duplicates (8)
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
/* -*- mode: c++; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 4 -*- */
#ifndef ATOMIC_QUEUE_SPIN_LOCK_H_INCLUDED
#define ATOMIC_QUEUE_SPIN_LOCK_H_INCLUDED

// Copyright (c) 2019 Maxim Egorushkin. MIT License. See the full licence in file LICENSE.

#include "defs.h"

#include <atomic>
#include <cstdlib>
#include <mutex>

#include <pthread.h>

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

namespace atomic_queue {

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

class Spinlock {
    pthread_spinlock_t s_;

public:
    using scoped_lock = std::lock_guard<Spinlock>;

    Spinlock() noexcept {
        if(ATOMIC_QUEUE_UNLIKELY(::pthread_spin_init(&s_, 0)))
            std::abort();
    }

    Spinlock(Spinlock const&) = delete;
    Spinlock& operator=(Spinlock const&) = delete;

    ~Spinlock() noexcept {
        ::pthread_spin_destroy(&s_);
    }

    void lock() noexcept {
        if(ATOMIC_QUEUE_UNLIKELY(::pthread_spin_lock(&s_)))
            std::abort();
    }

    void unlock() noexcept {
        if(ATOMIC_QUEUE_UNLIKELY(::pthread_spin_unlock(&s_)))
            std::abort();
    }
};

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

class TicketSpinlock {
    alignas(CACHE_LINE_SIZE) std::atomic<unsigned> ticket_{0};
    alignas(CACHE_LINE_SIZE) std::atomic<unsigned> next_{0};

public:
    class LockGuard {
        TicketSpinlock* const m_;
        unsigned const ticket_;
    public:
        LockGuard(TicketSpinlock& m) noexcept
            : m_(&m)
            , ticket_(m.lock())
        {}

        LockGuard(LockGuard const&) = delete;
        LockGuard& operator=(LockGuard const&) = delete;

        ~LockGuard() noexcept {
            m_->unlock(ticket_);
        }
    };

    using scoped_lock = LockGuard;

    TicketSpinlock() noexcept = default;
    TicketSpinlock(TicketSpinlock const&) = delete;
    TicketSpinlock& operator=(TicketSpinlock const&) = delete;

    ATOMIC_QUEUE_NOINLINE unsigned lock() noexcept {
        auto ticket = ticket_.fetch_add(1, std::memory_order_relaxed);
        for(;;) {
            auto position = ticket - next_.load(std::memory_order_acquire);
            if(ATOMIC_QUEUE_LIKELY(!position))
                break;
            do
                spin_loop_pause();
            while(--position);
        }
        return ticket;
    }

    void unlock() noexcept {
        unlock(next_.load(std::memory_order_relaxed) + 1);
    }

    void unlock(unsigned ticket) noexcept {
        next_.store(ticket + 1, std::memory_order_release);
    }
};

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

class UnfairSpinlock {
    std::atomic<unsigned> lock_{0};

public:
    using scoped_lock = std::lock_guard<UnfairSpinlock>;

    UnfairSpinlock(UnfairSpinlock const&) = delete;
    UnfairSpinlock& operator=(UnfairSpinlock const&) = delete;

    void lock() noexcept {
        for(;;) {
            if(!lock_.load(std::memory_order_relaxed) && !lock_.exchange(1, std::memory_order_acquire))
                return;
            spin_loop_pause();
        }
    }

    void unlock() noexcept {
        lock_.store(0, std::memory_order_release);
    }
};

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// class SpinlockHle {
//     int lock_ = 0;

// #ifdef __gcc__
//     static constexpr int HLE_ACQUIRE = __ATOMIC_HLE_ACQUIRE;
//     static constexpr int HLE_RELEASE = __ATOMIC_HLE_RELEASE;
// #else
//     static constexpr int HLE_ACQUIRE = 0;
//     static constexpr int HLE_RELEASE = 0;
// #endif

// public:
//     using scoped_lock = std::lock_guard<Spinlock>;

//     SpinlockHle(SpinlockHle const&) = delete;
//     SpinlockHle& operator=(SpinlockHle const&) = delete;

//     void lock() noexcept {
//         for(int expected = 0;
//             !__atomic_compare_exchange_n(&lock_, &expected, 1, false, __ATOMIC_ACQUIRE | HLE_ACQUIRE, __ATOMIC_RELAXED);
//             expected = 0)
//             spin_loop_pause();
//     }

//     void unlock() noexcept {
//         __atomic_store_n(&lock_, 0, __ATOMIC_RELEASE | HLE_RELEASE);
//     }
// };

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// class AdaptiveMutex {
//     pthread_mutex_t m_;

// public:
//     using scoped_lock = std::lock_guard<AdaptiveMutex>;

//     AdaptiveMutex() noexcept {
//         pthread_mutexattr_t a;
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutexattr_init(&a)))
//             std::abort();
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutexattr_settype(&a, PTHREAD_MUTEX_ADAPTIVE_NP)))
//             std::abort();
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutex_init(&m_, &a)))
//             std::abort();
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutexattr_destroy(&a)))
//             std::abort();
//         m_.__data.__spins = 32767;
//     }

//     AdaptiveMutex(AdaptiveMutex const&) = delete;
//     AdaptiveMutex& operator=(AdaptiveMutex const&) = delete;

//     ~AdaptiveMutex() noexcept {
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutex_destroy(&m_)))
//             std::abort();
//     }

//     void lock() noexcept {
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutex_lock(&m_)))
//             std::abort();
//     }

//     void unlock() noexcept {
//         if(ATOMIC_QUEUE_UNLIKELY(::pthread_mutex_unlock(&m_)))
//             std::abort();
//     }
// };

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

} // namespace atomic_queue

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#endif // ATOMIC_QUEUE_SPIN_LOCK_H_INCLUDED