aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/include/uhdlib/utils/atomic.hpp
blob: 98b1cfa7b83ca8c20e0b249d6d4cc15c619fab2b (plain)
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
//
// Copyright 2012-2013,2016-2017 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_UTILS_ATOMIC_HPP
#define INCLUDED_UHD_UTILS_ATOMIC_HPP

#include <uhd/config.hpp>
#include <uhd/types/time_spec.hpp>
#include <boost/thread/thread.hpp>
#include <atomic>
#include <chrono>

namespace uhd {

/*! DEPRECATED -- Will be removed in coming versions of UHD.
 *
 * Spin-wait on a condition with a timeout.
 * \param cond an atomic variable to compare
 * \param value compare to atomic for true/false
 * \param timeout the timeout in seconds
 * \return true for cond == value, false for timeout
 */
template <typename T>
UHD_INLINE bool spin_wait_with_timeout(
    std::atomic<T>& cond, const T value, const double timeout)
{
    if (cond == value)
        return true;
    const auto exit_time = std::chrono::high_resolution_clock::now()
                           + std::chrono::microseconds(int64_t(timeout * 1e6));
    while (cond != value) {
        if (std::chrono::high_resolution_clock::now() > exit_time) {
            return false;
        }
        boost::this_thread::interruption_point();
        boost::this_thread::yield();
    }
    return true;
}

/*! DEPRECATED -- Will be removed in coming versions of UHD.
 *
 * Claimer class to provide synchronization for multi-thread access.
 * Claiming enables buffer classes to be used with a buffer queue.
 */
class simple_claimer
{
public:
    simple_claimer(void)
    {
        this->release();
    }

    UHD_INLINE void release(void)
    {
        _locked = false;
    }

    UHD_INLINE bool claim_with_wait(const double timeout)
    {
        if (spin_wait_with_timeout(_locked, false, timeout)) {
            _locked = true;
            return true;
        }
        return false;
    }

private:
    std::atomic<bool> _locked;
};

} // namespace uhd

#endif /* INCLUDED_UHD_UTILS_ATOMIC_HPP */