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
|
//
// Copyright 2010 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef INCLUDED_UHD_TRANSPORT_BOUNDED_BUFFER_HPP
#define INCLUDED_UHD_TRANSPORT_BOUNDED_BUFFER_HPP
#include <uhd/config.hpp>
#include <boost/bind.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/circular_buffer.hpp>
#include <boost/thread/condition.hpp>
namespace uhd{ namespace transport{
/*!
* Imlement a templated bounded buffer:
* Used for passing elements between threads in a producer-consumer model.
* The bounded buffer implemented waits and timed waits with condition variables.
* The pop operation blocks on the bounded_buffer to become non empty.
* The push operation blocks on the bounded_buffer to become non full.
*/
template <typename elem_type> class bounded_buffer{
public:
typedef boost::shared_ptr<bounded_buffer<elem_type> > sptr;
/*!
* Make a new bounded buffer object.
* \param capacity the bounded_buffer capacity
*/
static sptr make(size_t capacity){
return sptr(new bounded_buffer(capacity));
}
/*!
* Push a new element into the bounded buffer.
* If the buffer is full prior to the push,
* make room by poping the oldest element.
* \param elem the new element to push
* \return true if the element fit without popping for space
*/
UHD_INLINE bool push_with_pop_on_full(const elem_type &elem){
boost::unique_lock<boost::mutex> lock(_mutex);
if(_buffer.full()){
_buffer.pop_back();
_buffer.push_front(elem);
lock.unlock();
_empty_cond.notify_one();
return false;
}
else{
_buffer.push_front(elem);
lock.unlock();
_empty_cond.notify_one();
return true;
}
}
/*!
* Push a new element into the bounded_buffer.
* Wait until the bounded_buffer becomes non-full.
* \param elem the new element to push
*/
UHD_INLINE void push_with_wait(const elem_type &elem){
boost::unique_lock<boost::mutex> lock(_mutex);
_full_cond.wait(lock, boost::bind(&bounded_buffer<elem_type>::not_full, this));
_buffer.push_front(elem);
lock.unlock();
_empty_cond.notify_one();
}
/*!
* Push a new element into the bounded_buffer.
* Wait until the bounded_buffer becomes non-full or timeout.
* \param elem the new element to push
* \param time the timeout time
* \return false when the operation times out
*/
template<typename time_type> UHD_INLINE
bool push_with_timed_wait(const elem_type &elem, const time_type &time){
boost::unique_lock<boost::mutex> lock(_mutex);
if (not _full_cond.timed_wait(lock, time, boost::bind(&bounded_buffer<elem_type>::not_full, this))) return false;
_buffer.push_front(elem);
lock.unlock();
_empty_cond.notify_one();
return true;
}
/*!
* Pop an element from the bounded_buffer.
* Wait until the bounded_buffer becomes non-empty.
* \param elem the element reference pop to
*/
UHD_INLINE void pop_with_wait(elem_type &elem){
boost::unique_lock<boost::mutex> lock(_mutex);
_empty_cond.wait(lock, boost::bind(&bounded_buffer<elem_type>::not_empty, this));
elem = _buffer.back(); _buffer.pop_back();
lock.unlock();
_full_cond.notify_one();
}
/*!
* Pop an element from the bounded_buffer.
* Wait until the bounded_buffer becomes non-empty or timeout.
* \param elem the element reference pop to
* \param time the timeout time
* \return false when the operation times out
*/
template<typename time_type> UHD_INLINE
bool pop_with_timed_wait(elem_type &elem, const time_type &time){
boost::unique_lock<boost::mutex> lock(_mutex);
if (not _empty_cond.timed_wait(lock, time, boost::bind(&bounded_buffer<elem_type>::not_empty, this))) return false;
elem = _buffer.back(); _buffer.pop_back();
lock.unlock();
_full_cond.notify_one();
return true;
}
/*!
* Clear all elements from the bounded_buffer.
*/
UHD_INLINE void clear(void){
boost::unique_lock<boost::mutex> lock(_mutex);
while (not_empty()) _buffer.pop_back();
lock.unlock();
_full_cond.notify_one();
}
private:
boost::mutex _mutex;
boost::condition _empty_cond, _full_cond;
boost::circular_buffer<elem_type> _buffer;
bool not_full(void) const{return not _buffer.full();}
bool not_empty(void) const{return not _buffer.empty();}
//private constructor
bounded_buffer(size_t capacity) : _buffer(capacity){}
};
}} //namespace
#endif /* INCLUDED_UHD_TRANSPORT_BOUNDED_BUFFER_HPP */
|
