blob: 397c0ae58e6c828e102064ba67ca42076ff09091 [file] [log] [blame]
Corey Tabaka52ea25c2017-09-13 18:02:48 -07001#include <sys/epoll.h>
2#include <sys/eventfd.h>
Alex Vakulenkoe4eec202017-01-27 14:41:04 -08003#include <sys/poll.h>
Alex Vakulenkoe4eec202017-01-27 14:41:04 -08004
5#include <algorithm>
6#include <atomic>
7#include <thread>
8
Fan Xu74df4902018-09-20 16:40:51 -07009#include <log/log.h>
Fan Xu74df4902018-09-20 16:40:51 -070010#include <private/dvr/buffer_channel.h>
Tianyu0c6b7ff2018-10-03 11:30:04 -070011#include <private/dvr/bufferhub_rpc.h>
Fan Xu74df4902018-09-20 16:40:51 -070012#include <private/dvr/consumer_channel.h>
13#include <private/dvr/producer_channel.h>
14#include <sync/sync.h>
15#include <utils/Trace.h>
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080016
17using android::pdx::BorrowedHandle;
Corey Tabakacd52dd92017-04-07 18:03:57 -070018using android::pdx::ErrorStatus;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080019using android::pdx::Message;
20using android::pdx::RemoteChannelHandle;
Corey Tabakacd52dd92017-04-07 18:03:57 -070021using android::pdx::Status;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080022using android::pdx::rpc::BufferWrapper;
23using android::pdx::rpc::DispatchRemoteMethod;
24using android::pdx::rpc::WrapBuffer;
25
26namespace android {
27namespace dvr {
28
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -070029ProducerChannel::ProducerChannel(BufferHubService* service, int buffer_id,
30 int channel_id, IonBuffer buffer,
31 IonBuffer metadata_buffer,
32 size_t user_metadata_size, int* error)
33 : BufferHubChannel(service, buffer_id, channel_id, kProducerType),
34 buffer_(std::move(buffer)),
35 metadata_buffer_(std::move(metadata_buffer)),
36 user_metadata_size_(user_metadata_size),
37 metadata_buf_size_(BufferHubDefs::kMetadataHeaderSize +
38 user_metadata_size) {
39 if (!buffer_.IsValid()) {
40 ALOGE("ProducerChannel::ProducerChannel: Invalid buffer.");
41 *error = -EINVAL;
42 return;
43 }
44 if (!metadata_buffer_.IsValid()) {
45 ALOGE("ProducerChannel::ProducerChannel: Invalid metadata buffer.");
46 *error = -EINVAL;
47 return;
48 }
49
50 *error = InitializeBuffer();
51}
52
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080053ProducerChannel::ProducerChannel(BufferHubService* service, int channel_id,
Corey Tabakacd52dd92017-04-07 18:03:57 -070054 uint32_t width, uint32_t height,
Hendrik Wagenaar108e84f2017-05-07 22:19:17 -070055 uint32_t layer_count, uint32_t format,
Corey Tabaka52ea25c2017-09-13 18:02:48 -070056 uint64_t usage, size_t user_metadata_size,
Hendrik Wagenaar108e84f2017-05-07 22:19:17 -070057 int* error)
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080058 : BufferHubChannel(service, channel_id, channel_id, kProducerType),
59 pending_consumers_(0),
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080060 producer_owns_(true),
Corey Tabaka52ea25c2017-09-13 18:02:48 -070061 user_metadata_size_(user_metadata_size),
62 metadata_buf_size_(BufferHubDefs::kMetadataHeaderSize +
63 user_metadata_size) {
64 if (int ret = buffer_.Alloc(width, height, layer_count, format, usage)) {
Hendrik Wagenaar4d3590f2017-05-06 22:36:04 -070065 ALOGE("ProducerChannel::ProducerChannel: Failed to allocate buffer: %s",
66 strerror(-ret));
67 *error = ret;
68 return;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -080069 }
70
Corey Tabaka52ea25c2017-09-13 18:02:48 -070071 if (int ret = metadata_buffer_.Alloc(metadata_buf_size_, /*height=*/1,
72 /*layer_count=*/1,
73 BufferHubDefs::kMetadataFormat,
74 BufferHubDefs::kMetadataUsage)) {
75 ALOGE("ProducerChannel::ProducerChannel: Failed to allocate metadata: %s",
76 strerror(-ret));
77 *error = ret;
78 return;
79 }
80
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -070081 *error = InitializeBuffer();
82}
83
84int ProducerChannel::InitializeBuffer() {
Corey Tabaka52ea25c2017-09-13 18:02:48 -070085 void* metadata_ptr = nullptr;
86 if (int ret = metadata_buffer_.Lock(BufferHubDefs::kMetadataUsage, /*x=*/0,
87 /*y=*/0, metadata_buf_size_,
88 /*height=*/1, &metadata_ptr)) {
89 ALOGE("ProducerChannel::ProducerChannel: Failed to lock metadata.");
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -070090 return ret;
Corey Tabaka52ea25c2017-09-13 18:02:48 -070091 }
92 metadata_header_ =
93 reinterpret_cast<BufferHubDefs::MetadataHeader*>(metadata_ptr);
94
95 // Using placement new here to reuse shared memory instead of new allocation
96 // and also initialize the value to zero.
97 buffer_state_ =
98 new (&metadata_header_->buffer_state) std::atomic<uint64_t>(0);
Tianyu0c6b7ff2018-10-03 11:30:04 -070099 fence_state_ = new (&metadata_header_->fence_state) std::atomic<uint64_t>(0);
Tianyu67053492018-10-04 14:00:22 -0700100 active_clients_bit_mask_ =
101 new (&metadata_header_->active_clients_bit_mask) std::atomic<uint64_t>(0);
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700102
Tianyu Jiang63dd7c32018-10-30 18:35:06 -0700103 // Producer channel is never created after consumer channel, and one buffer
104 // only have one fixed producer for now. Thus, it is correct to assume
105 // producer state bit is kFirstClientBitMask for now.
106 active_clients_bit_mask_->store(BufferHubDefs::kFirstClientBitMask,
107 std::memory_order_release);
108
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700109 acquire_fence_fd_.Reset(epoll_create1(EPOLL_CLOEXEC));
110 release_fence_fd_.Reset(epoll_create1(EPOLL_CLOEXEC));
111 if (!acquire_fence_fd_ || !release_fence_fd_) {
112 ALOGE("ProducerChannel::ProducerChannel: Failed to create shared fences.");
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -0700113 return -EIO;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700114 }
115
116 dummy_fence_fd_.Reset(eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK));
117 if (!dummy_fence_fd_) {
118 ALOGE("ProducerChannel::ProducerChannel: Failed to create dummy fences.");
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -0700119 return EIO;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700120 }
121
122 epoll_event event;
123 event.events = 0;
124 event.data.u64 = 0ULL;
125 if (epoll_ctl(release_fence_fd_.Get(), EPOLL_CTL_ADD, dummy_fence_fd_.Get(),
126 &event) < 0) {
127 ALOGE(
128 "ProducerChannel::ProducerChannel: Failed to modify the shared "
129 "release fence to include the dummy fence: %s",
130 strerror(errno));
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -0700131 return -EIO;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700132 }
133
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800134 // Success.
Jiwen 'Steve' Cai0728fa92018-04-24 19:03:14 -0700135 return 0;
136}
137
138std::unique_ptr<ProducerChannel> ProducerChannel::Create(
139 BufferHubService* service, int buffer_id, int channel_id, IonBuffer buffer,
140 IonBuffer metadata_buffer, size_t user_metadata_size) {
141 int error = 0;
142 std::unique_ptr<ProducerChannel> producer(new ProducerChannel(
143 service, buffer_id, channel_id, std::move(buffer),
144 std::move(metadata_buffer), user_metadata_size, &error));
145
146 if (error < 0)
147 return nullptr;
148 else
149 return producer;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800150}
151
Corey Tabakacd52dd92017-04-07 18:03:57 -0700152Status<std::shared_ptr<ProducerChannel>> ProducerChannel::Create(
153 BufferHubService* service, int channel_id, uint32_t width, uint32_t height,
Hendrik Wagenaar108e84f2017-05-07 22:19:17 -0700154 uint32_t layer_count, uint32_t format, uint64_t usage,
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700155 size_t user_metadata_size) {
Corey Tabakacd52dd92017-04-07 18:03:57 -0700156 int error;
Jiwen 'Steve' Cai0057fdd2017-05-02 11:21:18 -0700157 std::shared_ptr<ProducerChannel> producer(
Hendrik Wagenaar108e84f2017-05-07 22:19:17 -0700158 new ProducerChannel(service, channel_id, width, height, layer_count,
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700159 format, usage, user_metadata_size, &error));
Corey Tabakacd52dd92017-04-07 18:03:57 -0700160 if (error < 0)
161 return ErrorStatus(-error);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800162 else
Corey Tabakacd52dd92017-04-07 18:03:57 -0700163 return {std::move(producer)};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800164}
165
166ProducerChannel::~ProducerChannel() {
Corey Tabaka3079cb72017-01-19 15:07:26 -0800167 ALOGD_IF(TRACE,
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700168 "ProducerChannel::~ProducerChannel: channel_id=%d buffer_id=%d "
169 "state=%" PRIx64 ".",
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700170 channel_id(), buffer_id(),
171 buffer_state_->load(std::memory_order_acquire));
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700172 for (auto consumer : consumer_channels_) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800173 consumer->OnProducerClosed();
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700174 }
175 Hangup();
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800176}
177
178BufferHubChannel::BufferInfo ProducerChannel::GetBufferInfo() const {
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700179 // Derive the mask of signaled buffers in this producer / consumer set.
Tianyu Jiang63dd7c32018-10-30 18:35:06 -0700180 uint64_t signaled_mask = signaled() ? BufferHubDefs::kFirstClientBitMask : 0;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700181 for (const ConsumerChannel* consumer : consumer_channels_) {
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700182 signaled_mask |= consumer->signaled() ? consumer->client_state_mask() : 0;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700183 }
184
Hendrik Wagenaar4d3590f2017-05-06 22:36:04 -0700185 return BufferInfo(buffer_id(), consumer_channels_.size(), buffer_.width(),
Hendrik Wagenaar108e84f2017-05-07 22:19:17 -0700186 buffer_.height(), buffer_.layer_count(), buffer_.format(),
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700187 buffer_.usage(), pending_consumers_,
188 buffer_state_->load(std::memory_order_acquire),
Jiwen 'Steve' Cai2f260332018-02-15 18:39:47 -0800189 signaled_mask, metadata_header_->queue_index);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800190}
191
192void ProducerChannel::HandleImpulse(Message& message) {
193 ATRACE_NAME("ProducerChannel::HandleImpulse");
194 switch (message.GetOp()) {
195 case BufferHubRPC::ProducerGain::Opcode:
196 OnProducerGain(message);
197 break;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700198 case BufferHubRPC::ProducerPost::Opcode:
199 OnProducerPost(message, {});
200 break;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800201 }
202}
203
204bool ProducerChannel::HandleMessage(Message& message) {
205 ATRACE_NAME("ProducerChannel::HandleMessage");
206 switch (message.GetOp()) {
207 case BufferHubRPC::GetBuffer::Opcode:
208 DispatchRemoteMethod<BufferHubRPC::GetBuffer>(
209 *this, &ProducerChannel::OnGetBuffer, message);
210 return true;
211
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800212 case BufferHubRPC::NewConsumer::Opcode:
213 DispatchRemoteMethod<BufferHubRPC::NewConsumer>(
214 *this, &ProducerChannel::OnNewConsumer, message);
215 return true;
216
217 case BufferHubRPC::ProducerPost::Opcode:
218 DispatchRemoteMethod<BufferHubRPC::ProducerPost>(
219 *this, &ProducerChannel::OnProducerPost, message);
220 return true;
221
222 case BufferHubRPC::ProducerGain::Opcode:
223 DispatchRemoteMethod<BufferHubRPC::ProducerGain>(
224 *this, &ProducerChannel::OnProducerGain, message);
225 return true;
226
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800227 default:
228 return false;
229 }
230}
231
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700232BufferDescription<BorrowedHandle> ProducerChannel::GetBuffer(
Tianyu Jiang7e204b72018-10-26 15:39:18 -0700233 uint64_t client_state_mask) {
Jiwen 'Steve' Cai57ae3ee2018-05-03 17:51:52 -0700234 return {buffer_,
235 metadata_buffer_,
236 buffer_id(),
237 channel_id(),
Tianyu Jiang7e204b72018-10-26 15:39:18 -0700238 client_state_mask,
Jiwen 'Steve' Cai57ae3ee2018-05-03 17:51:52 -0700239 acquire_fence_fd_.Borrow(),
240 release_fence_fd_.Borrow()};
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700241}
242
243Status<BufferDescription<BorrowedHandle>> ProducerChannel::OnGetBuffer(
Corey Tabakad53870c2017-07-06 18:04:27 -0700244 Message& /*message*/) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800245 ATRACE_NAME("ProducerChannel::OnGetBuffer");
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700246 ALOGD_IF(TRACE, "ProducerChannel::OnGetBuffer: buffer=%d, state=%" PRIx64 ".",
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700247 buffer_id(), buffer_state_->load(std::memory_order_acquire));
Tianyu Jiang63dd7c32018-10-30 18:35:06 -0700248 return {GetBuffer(BufferHubDefs::kFirstClientBitMask)};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800249}
250
Corey Tabakacd52dd92017-04-07 18:03:57 -0700251Status<RemoteChannelHandle> ProducerChannel::CreateConsumer(Message& message) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800252 ATRACE_NAME("ProducerChannel::CreateConsumer");
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700253 ALOGD_IF(TRACE,
254 "ProducerChannel::CreateConsumer: buffer_id=%d, producer_owns=%d",
255 buffer_id(), producer_owns_);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800256
257 int channel_id;
258 auto status = message.PushChannel(0, nullptr, &channel_id);
259 if (!status) {
260 ALOGE(
Corey Tabakacd52dd92017-04-07 18:03:57 -0700261 "ProducerChannel::CreateConsumer: Failed to push consumer channel: %s",
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800262 status.GetErrorMessage().c_str());
Corey Tabakacd52dd92017-04-07 18:03:57 -0700263 return ErrorStatus(ENOMEM);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800264 }
265
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700266 // Try find the next consumer state bit which has not been claimed by any
267 // consumer yet.
Tianyu67053492018-10-04 14:00:22 -0700268 // memory_order_acquire is chosen here because all writes in other threads
269 // that release active_clients_bit_mask_ need to be visible here.
270 uint64_t current_active_clients_bit_mask =
271 active_clients_bit_mask_->load(std::memory_order_acquire);
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700272 uint64_t client_state_mask = BufferHubDefs::FindNextAvailableClientStateMask(
Tianyu Jiang63dd7c32018-10-30 18:35:06 -0700273 current_active_clients_bit_mask | orphaned_consumer_bit_mask_);
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700274 if (client_state_mask == 0ULL) {
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700275 ALOGE(
276 "ProducerChannel::CreateConsumer: reached the maximum mumber of "
277 "consumers per producer: 63.");
278 return ErrorStatus(E2BIG);
279 }
280
Tianyu67053492018-10-04 14:00:22 -0700281 uint64_t updated_active_clients_bit_mask =
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700282 current_active_clients_bit_mask | client_state_mask;
Tianyu67053492018-10-04 14:00:22 -0700283 // Set the updated value only if the current value stays the same as what was
284 // read before. If the comparison succeeds, update the value without
285 // reordering anything before or after this read-modify-write in the current
286 // thread, and the modification will be visible in other threads that acquire
287 // active_clients_bit_mask_. If the comparison fails, load the result of
288 // all writes from all threads to updated_active_clients_bit_mask.
289 if (!active_clients_bit_mask_->compare_exchange_weak(
290 current_active_clients_bit_mask, updated_active_clients_bit_mask,
291 std::memory_order_acq_rel, std::memory_order_acquire)) {
Tianyu Jiang5e4c3272018-10-31 10:57:45 -0700292 ALOGE("Current active clients bit mask is changed to %" PRIx64
293 ", which was expected to be %" PRIx64 ".",
Tianyu67053492018-10-04 14:00:22 -0700294 updated_active_clients_bit_mask, current_active_clients_bit_mask);
295 return ErrorStatus(EBUSY);
296 }
297
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700298 auto consumer =
299 std::make_shared<ConsumerChannel>(service(), buffer_id(), channel_id,
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700300 client_state_mask, shared_from_this());
Alex Vakulenkof0a7bd02017-03-31 18:06:19 -0700301 const auto channel_status = service()->SetChannel(channel_id, consumer);
302 if (!channel_status) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800303 ALOGE(
304 "ProducerChannel::CreateConsumer: failed to set new consumer channel: "
305 "%s",
Alex Vakulenkof0a7bd02017-03-31 18:06:19 -0700306 channel_status.GetErrorMessage().c_str());
Tianyu67053492018-10-04 14:00:22 -0700307 // Restore the consumer state bit and make it visible in other threads that
308 // acquire the active_clients_bit_mask_.
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700309 active_clients_bit_mask_->fetch_and(~client_state_mask,
Tianyu67053492018-10-04 14:00:22 -0700310 std::memory_order_release);
Corey Tabakacd52dd92017-04-07 18:03:57 -0700311 return ErrorStatus(ENOMEM);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800312 }
313
Tianyu Jiangca9201a2018-11-06 12:40:33 -0800314 uint64_t current_buffer_state =
315 buffer_state_->load(std::memory_order_acquire);
316 if (!producer_owns_ &&
317 (BufferHubDefs::IsBufferPosted(current_buffer_state) ||
318 BufferHubDefs::IsBufferAcquired(current_buffer_state))) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800319 // Signal the new consumer when adding it to a posted producer.
320 if (consumer->OnProducerPosted())
321 pending_consumers_++;
322 }
323
Corey Tabakacd52dd92017-04-07 18:03:57 -0700324 return {status.take()};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800325}
326
Corey Tabakacd52dd92017-04-07 18:03:57 -0700327Status<RemoteChannelHandle> ProducerChannel::OnNewConsumer(Message& message) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800328 ATRACE_NAME("ProducerChannel::OnNewConsumer");
329 ALOGD_IF(TRACE, "ProducerChannel::OnNewConsumer: buffer_id=%d", buffer_id());
Corey Tabakacd52dd92017-04-07 18:03:57 -0700330 return CreateConsumer(message);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800331}
332
Tianyu0c6b7ff2018-10-03 11:30:04 -0700333Status<void> ProducerChannel::OnProducerPost(Message&,
334 LocalFence acquire_fence) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800335 ATRACE_NAME("ProducerChannel::OnProducerPost");
336 ALOGD_IF(TRACE, "ProducerChannel::OnProducerPost: buffer_id=%d", buffer_id());
337 if (!producer_owns_) {
338 ALOGE("ProducerChannel::OnProducerPost: Not in gained state!");
Corey Tabakacd52dd92017-04-07 18:03:57 -0700339 return ErrorStatus(EBUSY);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800340 }
341
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700342 epoll_event event;
343 event.events = 0;
344 event.data.u64 = 0ULL;
345 int ret = epoll_ctl(release_fence_fd_.Get(), EPOLL_CTL_MOD,
346 dummy_fence_fd_.Get(), &event);
347 ALOGE_IF(ret < 0,
Tianyu0c6b7ff2018-10-03 11:30:04 -0700348 "ProducerChannel::OnProducerPost: Failed to modify the shared "
349 "release fence to include the dummy fence: %s",
350 strerror(errno));
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700351
352 eventfd_t dummy_fence_count = 0ULL;
353 if (eventfd_read(dummy_fence_fd_.Get(), &dummy_fence_count) < 0) {
354 const int error = errno;
355 if (error != EAGAIN) {
356 ALOGE(
357 "ProducerChannel::ProducerChannel: Failed to read dummy fence, "
358 "error: %s",
359 strerror(error));
360 return ErrorStatus(error);
361 }
Corey Tabaka8a4e6a92017-04-20 13:42:02 -0700362 }
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800363
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700364 ALOGW_IF(dummy_fence_count > 0,
365 "ProducerChannel::ProducerChannel: %" PRIu64
366 " dummy fence(s) was signaled during last release/gain cycle "
367 "buffer_id=%d.",
368 dummy_fence_count, buffer_id());
369
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800370 post_fence_ = std::move(acquire_fence);
371 producer_owns_ = false;
372
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700373 // Signal any interested consumers. If there are none, the buffer will stay
374 // in posted state until a consumer comes online. This behavior guarantees
375 // that no frame is silently dropped.
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800376 pending_consumers_ = 0;
377 for (auto consumer : consumer_channels_) {
378 if (consumer->OnProducerPosted())
379 pending_consumers_++;
380 }
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800381 ALOGD_IF(TRACE, "ProducerChannel::OnProducerPost: %d pending consumers",
382 pending_consumers_);
383
Corey Tabakacd52dd92017-04-07 18:03:57 -0700384 return {};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800385}
386
Corey Tabakad53870c2017-07-06 18:04:27 -0700387Status<LocalFence> ProducerChannel::OnProducerGain(Message& /*message*/) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800388 ATRACE_NAME("ProducerChannel::OnGain");
389 ALOGD_IF(TRACE, "ProducerChannel::OnGain: buffer_id=%d", buffer_id());
390 if (producer_owns_) {
391 ALOGE("ProducerChanneL::OnGain: Already in gained state: channel=%d",
392 channel_id());
Corey Tabakacd52dd92017-04-07 18:03:57 -0700393 return ErrorStatus(EALREADY);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800394 }
395
396 // There are still pending consumers, return busy.
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700397 if (pending_consumers_ > 0) {
398 ALOGE(
399 "ProducerChannel::OnGain: Producer (id=%d) is gaining a buffer that "
400 "still has %d pending consumer(s).",
401 buffer_id(), pending_consumers_);
Corey Tabakacd52dd92017-04-07 18:03:57 -0700402 return ErrorStatus(EBUSY);
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700403 }
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800404
405 ClearAvailable();
406 producer_owns_ = true;
Alex Vakulenko052f3ae2017-03-31 09:10:43 -0700407 post_fence_.close();
Corey Tabakacd52dd92017-04-07 18:03:57 -0700408 return {std::move(returned_fence_)};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800409}
410
Fan Xub0eec512018-10-30 11:33:15 -0700411// TODO(b/112338294) Keep here for reference. Remove it after new logic is
412// written.
413/* Status<RemoteChannelHandle> ProducerChannel::OnProducerDetach(
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700414 Message& message) {
415 ATRACE_NAME("ProducerChannel::OnProducerDetach");
416 ALOGD_IF(TRACE, "ProducerChannel::OnProducerDetach: buffer_id=%d",
417 buffer_id());
418
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700419 uint64_t buffer_state = buffer_state_->load(std::memory_order_acquire);
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700420 if (!BufferHubDefs::IsBufferGained(buffer_state)) {
421 // Can only detach a BufferProducer when it's in gained state.
422 ALOGW(
423 "ProducerChannel::OnProducerDetach: The buffer (id=%d, state=0x%" PRIx64
424 ") is not in gained state.",
425 buffer_id(), buffer_state);
426 return {};
427 }
428
429 int channel_id;
430 auto status = message.PushChannel(0, nullptr, &channel_id);
431 if (!status) {
432 ALOGE(
433 "ProducerChannel::OnProducerDetach: Failed to push detached buffer "
434 "channel: %s",
435 status.GetErrorMessage().c_str());
436 return ErrorStatus(ENOMEM);
437 }
438
439 // Make sure we unlock the buffer.
440 if (int ret = metadata_buffer_.Unlock()) {
441 ALOGE("ProducerChannel::OnProducerDetach: Failed to unlock metadata.");
442 return ErrorStatus(-ret);
443 };
444
Jiwen 'Steve' Cai9004b8c2018-10-03 18:52:23 -0700445 std::unique_ptr<BufferChannel> channel =
446 BufferChannel::Create(service(), buffer_id(), channel_id,
447 std::move(buffer_), user_metadata_size_);
Jiwen 'Steve' Caia8049a22018-03-28 15:14:02 -0700448 if (!channel) {
449 ALOGE("ProducerChannel::OnProducerDetach: Invalid buffer.");
450 return ErrorStatus(EINVAL);
451 }
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700452
Jiwen 'Steve' Caia8049a22018-03-28 15:14:02 -0700453 const auto channel_status =
454 service()->SetChannel(channel_id, std::move(channel));
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700455 if (!channel_status) {
456 // Technically, this should never fail, as we just pushed the channel. Note
457 // that LOG_FATAL will be stripped out in non-debug build.
458 LOG_FATAL(
459 "ProducerChannel::OnProducerDetach: Failed to set new detached buffer "
460 "channel: %s.",
461 channel_status.GetErrorMessage().c_str());
462 }
463
464 return status;
Fan Xub0eec512018-10-30 11:33:15 -0700465} */
Jiwen 'Steve' Cai23c1a732018-03-12 12:16:47 -0700466
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700467Status<LocalFence> ProducerChannel::OnConsumerAcquire(Message& /*message*/) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800468 ATRACE_NAME("ProducerChannel::OnConsumerAcquire");
469 ALOGD_IF(TRACE, "ProducerChannel::OnConsumerAcquire: buffer_id=%d",
470 buffer_id());
471 if (producer_owns_) {
472 ALOGE("ProducerChannel::OnConsumerAcquire: Not in posted state!");
Corey Tabakacd52dd92017-04-07 18:03:57 -0700473 return ErrorStatus(EBUSY);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800474 }
475
476 // Return a borrowed fd to avoid unnecessary duplication of the underlying fd.
477 // Serialization just needs to read the handle.
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700478 return {std::move(post_fence_)};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800479}
480
Corey Tabakacd52dd92017-04-07 18:03:57 -0700481Status<void> ProducerChannel::OnConsumerRelease(Message&,
482 LocalFence release_fence) {
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800483 ATRACE_NAME("ProducerChannel::OnConsumerRelease");
484 ALOGD_IF(TRACE, "ProducerChannel::OnConsumerRelease: buffer_id=%d",
485 buffer_id());
486 if (producer_owns_) {
487 ALOGE("ProducerChannel::OnConsumerRelease: Not in acquired state!");
Corey Tabakacd52dd92017-04-07 18:03:57 -0700488 return ErrorStatus(EBUSY);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800489 }
490
491 // Attempt to merge the fences if necessary.
492 if (release_fence) {
493 if (returned_fence_) {
Corey Tabaka3079cb72017-01-19 15:07:26 -0800494 LocalFence merged_fence(sync_merge("bufferhub_merged",
495 returned_fence_.get_fd(),
496 release_fence.get_fd()));
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800497 const int error = errno;
498 if (!merged_fence) {
499 ALOGE("ProducerChannel::OnConsumerRelease: Failed to merge fences: %s",
500 strerror(error));
Corey Tabakacd52dd92017-04-07 18:03:57 -0700501 return ErrorStatus(error);
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800502 }
503 returned_fence_ = std::move(merged_fence);
504 } else {
505 returned_fence_ = std::move(release_fence);
506 }
507 }
508
Tianyu0c6b7ff2018-10-03 11:30:04 -0700509 DecrementPendingConsumers();
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700510 if (pending_consumers_ == 0) {
511 // Clear the producer bit atomically to transit into released state. This
512 // has to done by BufferHub as it requries synchronization among all
513 // consumers.
514 BufferHubDefs::ModifyBufferState(buffer_state_,
Tianyu Jiang63dd7c32018-10-30 18:35:06 -0700515 BufferHubDefs::kFirstClientBitMask, 0ULL);
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700516 ALOGD_IF(TRACE,
517 "ProducerChannel::OnConsumerRelease: releasing last consumer: "
518 "buffer_id=%d state=%" PRIx64 ".",
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700519 buffer_id(), buffer_state_->load(std::memory_order_acquire));
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700520
521 if (orphaned_consumer_bit_mask_) {
522 ALOGW(
523 "ProducerChannel::OnConsumerRelease: orphaned buffer detected "
524 "during the this acquire/release cycle: id=%d orphaned=0x%" PRIx64
525 " queue_index=%" PRIu64 ".",
526 buffer_id(), orphaned_consumer_bit_mask_,
527 metadata_header_->queue_index);
528 orphaned_consumer_bit_mask_ = 0;
529 }
530
531 SignalAvailable();
532 }
533
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700534 ALOGE_IF(
535 pending_consumers_ && BufferHubDefs::IsBufferReleased(
536 buffer_state_->load(std::memory_order_acquire)),
537 "ProducerChannel::OnConsumerRelease: buffer state inconsistent: "
538 "pending_consumers=%d, buffer buffer is in releaed state.",
539 pending_consumers_);
Corey Tabakacd52dd92017-04-07 18:03:57 -0700540 return {};
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800541}
542
Tianyu0c6b7ff2018-10-03 11:30:04 -0700543void ProducerChannel::DecrementPendingConsumers() {
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700544 if (pending_consumers_ == 0) {
Tianyu0c6b7ff2018-10-03 11:30:04 -0700545 ALOGE("ProducerChannel::DecrementPendingConsumers: no pending consumer.");
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700546 return;
547 }
548
549 --pending_consumers_;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800550 ALOGD_IF(TRACE,
Tianyu0c6b7ff2018-10-03 11:30:04 -0700551 "ProducerChannel::DecrementPendingConsumers: buffer_id=%d %d "
552 "consumers left",
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800553 buffer_id(), pending_consumers_);
554}
555
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700556void ProducerChannel::OnConsumerOrphaned(ConsumerChannel* channel) {
557 // Ignore the orphaned consumer.
Tianyu0c6b7ff2018-10-03 11:30:04 -0700558 DecrementPendingConsumers();
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700559
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700560 const uint64_t client_state_mask = channel->client_state_mask();
561 ALOGE_IF(orphaned_consumer_bit_mask_ & client_state_mask,
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700562 "ProducerChannel::OnConsumerOrphaned: Consumer "
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700563 "(client_state_mask=%" PRIx64 ") is already orphaned.",
564 client_state_mask);
565 orphaned_consumer_bit_mask_ |= client_state_mask;
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700566
567 // Atomically clear the fence state bit as an orphaned consumer will never
568 // signal a release fence. Also clear the buffer state as it won't be released
569 // as well.
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700570 fence_state_->fetch_and(~client_state_mask);
571 BufferHubDefs::ModifyBufferState(buffer_state_, client_state_mask, 0ULL);
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700572
573 ALOGW(
574 "ProducerChannel::OnConsumerOrphaned: detected new orphaned consumer "
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700575 "buffer_id=%d client_state_mask=%" PRIx64 " queue_index=%" PRIu64
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700576 " buffer_state=%" PRIx64 " fence_state=%" PRIx64 ".",
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700577 buffer_id(), client_state_mask, metadata_header_->queue_index,
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700578 buffer_state_->load(std::memory_order_acquire),
579 fence_state_->load(std::memory_order_acquire));
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700580}
581
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800582void ProducerChannel::AddConsumer(ConsumerChannel* channel) {
583 consumer_channels_.push_back(channel);
584}
585
586void ProducerChannel::RemoveConsumer(ConsumerChannel* channel) {
587 consumer_channels_.erase(
588 std::find(consumer_channels_.begin(), consumer_channels_.end(), channel));
Tianyu67053492018-10-04 14:00:22 -0700589 // Restore the consumer state bit and make it visible in other threads that
590 // acquire the active_clients_bit_mask_.
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700591 active_clients_bit_mask_->fetch_and(~channel->client_state_mask(),
Tianyu67053492018-10-04 14:00:22 -0700592 std::memory_order_release);
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700593
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700594 const uint64_t buffer_state = buffer_state_->load(std::memory_order_acquire);
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700595 if (BufferHubDefs::IsBufferPosted(buffer_state) ||
596 BufferHubDefs::IsBufferAcquired(buffer_state)) {
597 // The consumer client is being destoryed without releasing. This could
598 // happen in corner cases when the consumer crashes. Here we mark it
599 // orphaned before remove it from producer.
600 OnConsumerOrphaned(channel);
601 }
602
603 if (BufferHubDefs::IsBufferReleased(buffer_state) ||
604 BufferHubDefs::IsBufferGained(buffer_state)) {
605 // The consumer is being close while it is suppose to signal a release
606 // fence. Signal the dummy fence here.
Tianyu Jiange2cdec92018-10-30 17:40:58 -0700607 if (fence_state_->load(std::memory_order_acquire) &
608 channel->client_state_mask()) {
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700609 epoll_event event;
610 event.events = EPOLLIN;
Tianyu Jiang83a991f2018-10-30 16:59:29 -0700611 event.data.u64 = channel->client_state_mask();
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700612 if (epoll_ctl(release_fence_fd_.Get(), EPOLL_CTL_MOD,
613 dummy_fence_fd_.Get(), &event) < 0) {
614 ALOGE(
615 "ProducerChannel::RemoveConsumer: Failed to modify the shared "
616 "release fence to include the dummy fence: %s",
617 strerror(errno));
618 return;
619 }
620 ALOGW(
621 "ProducerChannel::RemoveConsumer: signal dummy release fence "
622 "buffer_id=%d",
623 buffer_id());
624 eventfd_write(dummy_fence_fd_.Get(), 1);
625 }
626 }
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800627}
628
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800629// Returns true if the given parameters match the underlying buffer parameters.
Corey Tabakacd52dd92017-04-07 18:03:57 -0700630bool ProducerChannel::CheckParameters(uint32_t width, uint32_t height,
Hendrik Wagenaar108e84f2017-05-07 22:19:17 -0700631 uint32_t layer_count, uint32_t format,
Corey Tabaka52ea25c2017-09-13 18:02:48 -0700632 uint64_t usage,
633 size_t user_metadata_size) {
634 return user_metadata_size == user_metadata_size_ &&
635 buffer_.width() == width && buffer_.height() == height &&
636 buffer_.layer_count() == layer_count && buffer_.format() == format &&
637 buffer_.usage() == usage;
Alex Vakulenkoe4eec202017-01-27 14:41:04 -0800638}
639
640} // namespace dvr
641} // namespace android