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
|
/*
* Copyright 2019 Xilinx 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
*
* http://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.
*/
#ifndef DEEPHI_NOCOPY_BOUNDED_QUEUE_HPP_
#define DEEPHI_NOCOPY_BOUNDED_QUEUE_HPP_
#include <condition_variable>
#include <deque>
#include <memory>
#include <mutex>
namespace vitis {
namespace ai {
/**
* A thread safe, bounded queue that stores std::unique_ptr.
* This saves the work to copy object at push/pop.
*/
template <typename T>
class NoCopyBoundedQueue {
public:
explicit NoCopyBoundedQueue(std::size_t capacity) : capacity_(capacity) {}
/**
* Return the maxium size of the queue.
*/
std::size_t capacity() const { return this->capacity_; }
/**
* Move the value to the end of this queue.
* This is blocking.
*/
void push(std::unique_ptr<T> new_value) {
std::unique_lock<std::mutex> lock(this->mtx_);
this->cond_not_full_.wait(
lock, [this]() { return this->internal_size() < this->capacity_; });
this->internal_push(std::move(new_value));
this->cond_not_empty_.notify_one();
}
/**
* Move the value to the end of this queue.
* This will fail and return false if blocked for more than rel_time.
*/
bool push(std::unique_ptr<T> new_value,
const std::chrono::milliseconds& rel_time) {
std::unique_lock<std::mutex> lock(this->mtx_);
if (this->cond_not_full_.wait_for(lock, rel_time, [this]() {
return this->internal_size() < this->capacity_;
}) == false) {
return false;
}
this->internal_push(std::move(new_value));
this->cond_not_empty_.notify_one();
return true;
}
/**
* Look at the top of the queue. i.e. the element that would be popped.
* This returns the raw pointer instead of smart pointer.
* Be careful that it can become dangling pointer.
*/
T* top(const std::chrono::milliseconds& rel_time) const {
std::unique_lock<std::mutex> lock(this->mtx_);
if (this->cond_not_empty_.wait_for(lock, rel_time, [this]() {
return !this->internal_empty();
}) == false) {
return nullptr;
}
return this->internal_.front().get();
}
/**
* Return the first element in the queue and remove it from the queue.
* This is blocking.
*/
std::unique_ptr<T> pop() {
std::unique_lock<std::mutex> lock(this->mtx_);
this->cond_not_empty_.wait(lock,
[this]() { return !this->internal_empty(); });
auto value = this->internal_pop();
this->cond_not_full_.notify_one();
return std::move(value);
}
/**
* Return the first element in the queue and remove it from the queue.
* This will fail and return nullptr if blocked for more than rel_time.
*/
std::unique_ptr<T> pop(const std::chrono::milliseconds& rel_time) {
std::unique_lock<std::mutex> lock(this->mtx_);
if (this->cond_not_empty_.wait_for(lock, rel_time, [this]() {
return !this->internal_empty();
}) == false) {
return nullptr;
}
auto value = this->internal_pop();
this->cond_not_full_.notify_one();
return std::move(value);
}
/**
* Return the first element in the queue that satisfies cond, and remove it
* from the queue.
* This is blocking.
*/
std::unique_ptr<T> pop(std::function<bool(const std::unique_ptr<T>&)>& cond) {
std::lock_guard<std::mutex> lock(this->mtx_);
if (this->internal_empty()) return false;
auto it =
std::find_if(this->internal_.begin(), this->internal_.end(), cond);
if (it != this->internal_.end()) {
auto value = std::move(*it);
this->internal_.erase(it);
this->cond_not_full_.notify_one();
return std::move(value);
}
return nullptr;
}
/**
* Return the first element in the queue that satisfies cond, and remove it
* from the queue.
* This will fail and return nullptr if blocked for more than rel_time.
*/
std::unique_ptr<T> pop(std::function<bool(const std::unique_ptr<T>&)>& cond,
const std::chrono::milliseconds& rel_time) {
auto now = std::chrono::steady_clock::now();
std::unique_lock<std::mutex> lock(this->mtx_);
// Wait until not empty
if (!this->cond_not_empty_.wait_for(
lock, rel_time, [this]() { return !this->internal_empty(); })) {
return nullptr;
}
auto it =
std::find_if(this->internal_.begin(), this->internal_.end(), cond);
while (it == this->internal_.end()) {
if (this->cond_not_empty_.wait_until(lock, now + rel_time) ==
std::cv_status::timeout) {
break;
}
it = std::find_if(this->internal_.begin(), this->internal_.end(), cond);
}
it = std::find_if(this->internal_.begin(), this->internal_.end(), cond);
if (it != this->internal_.end()) {
auto value = std::move(*it);
this->internal_.erase(it);
this->cond_not_full_.notify_one();
return std::move(value);
}
return nullptr;
}
protected:
inline virtual std::size_t internal_size() const {
return this->internal_.size();
}
inline virtual bool internal_empty() const { return this->internal_.empty(); }
inline virtual void internal_push(std::unique_ptr<T> new_value) {
this->internal_.push_back(std::move(new_value));
}
inline virtual std::unique_ptr<T> internal_pop() {
auto value = std::move(this->internal_.front());
this->internal_.pop_front();
return std::move(value);
}
mutable std::mutex mtx_;
std::size_t capacity_;
std::deque<std::unique_ptr<T>> internal_;
mutable std::condition_variable cond_not_empty_;
mutable std::condition_variable cond_not_full_;
};
} // namespace ai
} // namespace vitis
#endif
|
