1 #include "display_surface.h"
3 #include <private/android_filesystem_config.h>
4 #include <utils/Trace.h>
6 #include <private/dvr/trusted_uids.h>
8 #include "display_service.h"
9 #include "hardware_composer.h"
13 using android::dvr::display::DisplayProtocol;
14 using android::pdx::BorrowedChannelHandle;
15 using android::pdx::ErrorStatus;
16 using android::pdx::LocalChannelHandle;
17 using android::pdx::LocalHandle;
18 using android::pdx::Message;
19 using android::pdx::RemoteChannelHandle;
20 using android::pdx::Status;
21 using android::pdx::rpc::DispatchRemoteMethod;
22 using android::pdx::rpc::IfAnyOf;
27 DisplaySurface::DisplaySurface(DisplayService* service,
28 SurfaceType surface_type, int surface_id,
29 int process_id, int user_id,
30 const display::SurfaceAttributes& attributes)
32 surface_type_(surface_type),
33 surface_id_(surface_id),
34 process_id_(process_id),
36 attributes_(attributes),
37 update_flags_(display::SurfaceUpdateFlags::NewSurface) {}
39 DisplaySurface::~DisplaySurface() {
41 "DisplaySurface::~DisplaySurface: surface_id=%d process_id=%d",
42 surface_id(), process_id());
45 Status<void> DisplaySurface::HandleMessage(pdx::Message& message) {
46 switch (message.GetOp()) {
47 case DisplayProtocol::SetAttributes::Opcode:
48 DispatchRemoteMethod<DisplayProtocol::SetAttributes>(
49 *this, &DisplaySurface::OnSetAttributes, message);
52 case DisplayProtocol::GetSurfaceInfo::Opcode:
53 DispatchRemoteMethod<DisplayProtocol::GetSurfaceInfo>(
54 *this, &DisplaySurface::OnGetSurfaceInfo, message);
57 case DisplayProtocol::CreateQueue::Opcode:
58 DispatchRemoteMethod<DisplayProtocol::CreateQueue>(
59 *this, &DisplaySurface::OnCreateQueue, message);
66 Status<void> DisplaySurface::OnSetAttributes(
67 pdx::Message& /*message*/, const display::SurfaceAttributes& attributes) {
68 display::SurfaceUpdateFlags update_flags;
70 for (const auto& attribute : attributes) {
71 const auto& key = attribute.first;
72 const auto* variant = &attribute.second;
73 bool invalid_value = false;
74 bool visibility_changed = false;
76 // Catch attributes that have significance to the display service.
78 case display::SurfaceAttribute::ZOrder:
79 invalid_value = !IfAnyOf<int32_t, int64_t, float>::Call(
80 variant, [&](const auto& value) {
81 if (z_order_ != value) {
82 visibility_changed = true;
87 case display::SurfaceAttribute::Visible:
88 invalid_value = !IfAnyOf<int32_t, int64_t, bool>::Call(
89 variant, [&](const auto& value) {
90 if (visible_ != value) {
91 visibility_changed = true;
100 "DisplaySurface::OnClientSetAttributes: Failed to set display "
101 "surface attribute '%d' because of incompatible type: %d",
102 key, variant->index());
104 // Only update the attribute map with valid values.
105 attributes_[attribute.first] = attribute.second;
107 // All attribute changes generate a notification, even if the value
108 // doesn't change. Visibility attributes set a flag only if the value
110 update_flags.Set(display::SurfaceUpdateFlags::AttributesChanged);
111 if (visibility_changed)
112 update_flags.Set(display::SurfaceUpdateFlags::VisibilityChanged);
116 SurfaceUpdated(update_flags);
120 void DisplaySurface::SurfaceUpdated(display::SurfaceUpdateFlags update_flags) {
122 "DisplaySurface::SurfaceUpdated: surface_id=%d update_flags=0x%x",
123 surface_id(), update_flags.value());
125 update_flags_.Set(update_flags);
126 service()->SurfaceUpdated(surface_type(), update_flags_);
129 void DisplaySurface::ClearUpdate() {
130 ALOGD_IF(TRACE > 1, "DisplaySurface::ClearUpdate: surface_id=%d",
132 update_flags_ = display::SurfaceUpdateFlags::None;
135 Status<display::SurfaceInfo> DisplaySurface::OnGetSurfaceInfo(
136 Message& /*message*/) {
139 "DisplaySurface::OnGetSurfaceInfo: surface_id=%d visible=%d z_order=%d",
140 surface_id(), visible(), z_order());
141 return {{surface_id(), visible(), z_order()}};
144 Status<void> DisplaySurface::RegisterQueue(
145 const std::shared_ptr<ConsumerQueue>& consumer_queue) {
146 ALOGD_IF(TRACE, "DisplaySurface::RegisterQueue: surface_id=%d queue_id=%d",
147 surface_id(), consumer_queue->id());
148 // Capture references for the lambda to work around apparent clang bug.
149 // TODO(eieio): Figure out if there is a clang bug or C++11 ambiguity when
150 // capturing self and consumer_queue by copy in the following case:
151 // auto self = Self();
152 // [self, consumer_queue](int events) {
153 // self->OnQueueEvent(consuemr_queue, events); }
156 std::shared_ptr<DisplaySurface> surface;
157 std::shared_ptr<ConsumerQueue> queue;
159 State state{Self(), consumer_queue};
161 return service()->AddEventHandler(
162 consumer_queue->queue_fd(), EPOLLIN | EPOLLHUP | EPOLLET,
163 [state](int events) {
164 state.surface->OnQueueEvent(state.queue, events);
168 Status<void> DisplaySurface::UnregisterQueue(
169 const std::shared_ptr<ConsumerQueue>& consumer_queue) {
170 ALOGD_IF(TRACE, "DisplaySurface::UnregisterQueue: surface_id=%d queue_id=%d",
171 surface_id(), consumer_queue->id());
172 return service()->RemoveEventHandler(consumer_queue->queue_fd());
175 void DisplaySurface::OnQueueEvent(
176 const std::shared_ptr<ConsumerQueue>& /*consumer_queue*/, int /*events*/) {
178 "DisplaySurface::OnQueueEvent: ERROR base virtual method should not be "
182 std::shared_ptr<ConsumerQueue> ApplicationDisplaySurface::GetQueue(
185 "ApplicationDisplaySurface::GetQueue: surface_id=%d queue_id=%d",
186 surface_id(), queue_id);
188 auto search = consumer_queues_.find(queue_id);
189 if (search != consumer_queues_.end())
190 return search->second;
195 std::vector<int32_t> ApplicationDisplaySurface::GetQueueIds() const {
196 std::vector<int32_t> queue_ids;
197 for (const auto& entry : consumer_queues_)
198 queue_ids.push_back(entry.first);
202 Status<LocalChannelHandle> ApplicationDisplaySurface::OnCreateQueue(
203 Message& /*message*/, const ProducerQueueConfig& config) {
204 ATRACE_NAME("ApplicationDisplaySurface::OnCreateQueue");
206 "ApplicationDisplaySurface::OnCreateQueue: surface_id=%d, "
207 "meta_size_bytes=%zu",
208 surface_id(), config.meta_size_bytes);
210 std::lock_guard<std::mutex> autolock(lock_);
211 auto producer = ProducerQueue::Create(config, UsagePolicy{});
214 "ApplicationDisplaySurface::OnCreateQueue: Failed to create producer "
216 return ErrorStatus(ENOMEM);
219 std::shared_ptr<ConsumerQueue> consumer =
220 producer->CreateSilentConsumerQueue();
221 auto status = RegisterQueue(consumer);
224 "ApplicationDisplaySurface::OnCreateQueue: Failed to register consumer "
226 status.GetErrorMessage().c_str());
227 return status.error_status();
230 consumer_queues_[consumer->id()] = std::move(consumer);
232 SurfaceUpdated(display::SurfaceUpdateFlags::BuffersChanged);
233 return std::move(producer->GetChannelHandle());
236 void ApplicationDisplaySurface::OnQueueEvent(
237 const std::shared_ptr<ConsumerQueue>& consumer_queue, int events) {
239 "ApplicationDisplaySurface::OnQueueEvent: queue_id=%d events=%x",
240 consumer_queue->id(), events);
242 // Always give the queue a chance to handle its internal bookkeeping.
243 consumer_queue->HandleQueueEvents();
245 // Check for hangup and remove a queue that is no longer needed.
246 std::lock_guard<std::mutex> autolock(lock_);
247 if (consumer_queue->hung_up()) {
248 ALOGD_IF(TRACE, "ApplicationDisplaySurface::OnQueueEvent: Removing queue.");
249 UnregisterQueue(consumer_queue);
250 auto search = consumer_queues_.find(consumer_queue->id());
251 if (search != consumer_queues_.end()) {
252 consumer_queues_.erase(search);
255 "ApplicationDisplaySurface::OnQueueEvent: Failed to find queue_id=%d",
256 consumer_queue->id());
258 SurfaceUpdated(display::SurfaceUpdateFlags::BuffersChanged);
262 std::vector<int32_t> DirectDisplaySurface::GetQueueIds() const {
263 std::vector<int32_t> queue_ids;
265 queue_ids.push_back(direct_queue_->id());
269 Status<LocalChannelHandle> DirectDisplaySurface::OnCreateQueue(
270 Message& /*message*/, const ProducerQueueConfig& config) {
271 ATRACE_NAME("DirectDisplaySurface::OnCreateQueue");
274 "DirectDisplaySurface::OnCreateQueue: surface_id=%d meta_size_bytes=%zu",
275 surface_id(), config.meta_size_bytes);
277 std::lock_guard<std::mutex> autolock(lock_);
278 if (!direct_queue_) {
279 // Inject the hw composer usage flag to enable the display to read the
281 auto producer = ProducerQueue::Create(
282 config, UsagePolicy{GraphicBuffer::USAGE_HW_COMPOSER, 0, 0, 0});
285 "DirectDisplaySurface::OnCreateQueue: Failed to create producer "
287 return ErrorStatus(ENOMEM);
290 direct_queue_ = producer->CreateConsumerQueue();
291 auto status = RegisterQueue(direct_queue_);
294 "DirectDisplaySurface::OnCreateQueue: Failed to register consumer "
296 status.GetErrorMessage().c_str());
297 return status.error_status();
300 return std::move(producer->GetChannelHandle());
302 return ErrorStatus(EALREADY);
306 void DirectDisplaySurface::OnQueueEvent(
307 const std::shared_ptr<ConsumerQueue>& consumer_queue, int events) {
308 ALOGD_IF(TRACE, "DirectDisplaySurface::OnQueueEvent: queue_id=%d events=%x",
309 consumer_queue->id(), events);
311 // Always give the queue a chance to handle its internal bookkeeping.
312 consumer_queue->HandleQueueEvents();
314 // Check for hangup and remove a queue that is no longer needed.
315 std::lock_guard<std::mutex> autolock(lock_);
316 if (consumer_queue->hung_up()) {
317 ALOGD_IF(TRACE, "DirectDisplaySurface::OnQueueEvent: Removing queue.");
318 UnregisterQueue(consumer_queue);
319 direct_queue_ = nullptr;
323 void DirectDisplaySurface::DequeueBuffersLocked() {
324 if (direct_queue_ == nullptr) {
326 "DirectDisplaySurface::DequeueBuffersLocked: Consumer queue is not "
332 LocalHandle acquire_fence;
334 auto buffer_status = direct_queue_->Dequeue(0, &slot, &acquire_fence);
335 if (!buffer_status) {
337 TRACE > 1 && buffer_status.error() == ETIMEDOUT,
338 "DirectDisplaySurface::DequeueBuffersLocked: All buffers dequeued.");
339 ALOGE_IF(buffer_status.error() != ETIMEDOUT,
340 "DirectDisplaySurface::DequeueBuffersLocked: Failed to dequeue "
342 buffer_status.GetErrorMessage().c_str());
345 auto buffer_consumer = buffer_status.take();
348 ATRACE_NAME("DropFrameOnInvisibleSurface");
350 "DirectDisplaySurface::DequeueBuffersLocked: Discarding "
351 "buffer_id=%d on invisible surface.",
352 buffer_consumer->id());
353 buffer_consumer->Discard();
357 if (acquired_buffers_.IsFull()) {
359 "DirectDisplaySurface::DequeueBuffersLocked: Posted buffers full, "
361 acquired_buffers_.PopBack();
364 acquired_buffers_.Append(
365 AcquiredBuffer(buffer_consumer, std::move(acquire_fence)));
369 AcquiredBuffer DirectDisplaySurface::AcquireCurrentBuffer() {
370 std::lock_guard<std::mutex> autolock(lock_);
371 DequeueBuffersLocked();
373 if (acquired_buffers_.IsEmpty()) {
375 "DirectDisplaySurface::AcquireCurrentBuffer: attempt to acquire buffer "
376 "when none are posted.");
377 return AcquiredBuffer();
379 AcquiredBuffer buffer = std::move(acquired_buffers_.Front());
380 acquired_buffers_.PopFront();
381 ALOGD_IF(TRACE, "DirectDisplaySurface::AcquireCurrentBuffer: buffer_id=%d",
382 buffer.buffer()->id());
386 AcquiredBuffer DirectDisplaySurface::AcquireNewestAvailableBuffer(
387 AcquiredBuffer* skipped_buffer) {
388 std::lock_guard<std::mutex> autolock(lock_);
389 DequeueBuffersLocked();
391 AcquiredBuffer buffer;
393 // Basic latency stopgap for when the application misses a frame:
394 // If the application recovers on the 2nd or 3rd (etc) frame after
395 // missing, this code will skip frames to catch up by checking if
396 // the next frame is also available.
397 while (!acquired_buffers_.IsEmpty() &&
398 acquired_buffers_.Front().IsAvailable()) {
399 // Capture the skipped buffer into the result parameter.
400 // Note that this API only supports skipping one buffer per vsync.
401 if (frames > 0 && skipped_buffer)
402 *skipped_buffer = std::move(buffer);
404 buffer = std::move(acquired_buffers_.Front());
405 acquired_buffers_.PopFront();
410 "DirectDisplaySurface::AcquireNewestAvailableBuffer: buffer_id=%d",
411 buffer.buffer()->id());
415 bool DirectDisplaySurface::IsBufferAvailable() {
416 std::lock_guard<std::mutex> autolock(lock_);
417 DequeueBuffersLocked();
419 return !acquired_buffers_.IsEmpty() &&
420 acquired_buffers_.Front().IsAvailable();
423 bool DirectDisplaySurface::IsBufferPosted() {
424 std::lock_guard<std::mutex> autolock(lock_);
425 DequeueBuffersLocked();
427 return !acquired_buffers_.IsEmpty();
430 Status<std::shared_ptr<DisplaySurface>> DisplaySurface::Create(
431 DisplayService* service, int surface_id, int process_id, int user_id,
432 const display::SurfaceAttributes& attributes) {
434 auto search = attributes.find(display::SurfaceAttribute::Direct);
435 if (search != attributes.end()) {
436 if (!IfAnyOf<int32_t, int64_t, bool, float>::Get(&search->second,
439 "DisplaySurface::Create: Invalid type for SurfaceAttribute::Direct!");
440 return ErrorStatus(EINVAL);
445 "DisplaySurface::Create: surface_id=%d process_id=%d user_id=%d "
447 surface_id, process_id, user_id, direct);
450 const bool trusted = user_id == AID_ROOT || IsTrustedUid(user_id);
452 return {std::shared_ptr<DisplaySurface>{new DirectDisplaySurface(
453 service, surface_id, process_id, user_id, attributes)}};
456 "DisplaySurface::Create: Direct surfaces may only be created by "
457 "trusted UIDs: user_id=%d",
459 return ErrorStatus(EPERM);
462 return {std::shared_ptr<DisplaySurface>{new ApplicationDisplaySurface(
463 service, surface_id, process_id, user_id, attributes)}};
468 } // namespace android